mirror of
https://github.com/osmarks/mycorrhiza.git
synced 2024-12-12 05:20:26 +00:00
Help: Use =headings
This commit is contained in:
Timur Ismagilov
parent
4d36535780
commit
0579cbeb1c
@ -1,29 +1,29 @@
|
||||
# Help: Attachment
|
||||
= Help: Attachment
|
||||
In hyphae, an **attachment** is some content represented by something that is not [[/help/en/mycomarkup | Mycomarkup]]. Usually, an image, a video, or an audio.
|
||||
|
||||
## Supported attachment types
|
||||
== Supported attachment types
|
||||
You can upload any file, but only those listed below will be displayed on the website. You can download unsupported attachments, though.
|
||||
|
||||
* **Images:** jpg, gif, png, webp, svg, ico
|
||||
* **Video:** ogg, webm, mp4
|
||||
* **Audio:** ogg, webm, mp3
|
||||
|
||||
## How to add an attachment?
|
||||
== How to add an attachment?
|
||||
For non-existent hyphae, upload a file in the //Upload a media// section.
|
||||
|
||||
For any hyphae, upload a file in the //Manage attachment// tab.
|
||||
|
||||
## Attachment management
|
||||
== Attachment management
|
||||
Every hypha has the //Manage attachment// section. Click it to see what is out there.
|
||||
|
||||
You can upload a new file, you can //delete// the attachment (it is called //unattaching//) and see some file stats (size and type).
|
||||
|
||||
## On naming hyphae with attachments
|
||||
== On naming hyphae with attachments
|
||||
The hypha name should not just copy the file name in most cases. If you are uploading a photo of a rose, do not call it `rose.jpg`, no. Call it `photo of rose` or `rose photo` or whatever. You rarely need to think of file extensions when using Mycorrhiza Wiki.
|
||||
|
||||
This is not a rule, of course, just a convention.
|
||||
|
||||
## What to put in the text part?
|
||||
== What to put in the text part?
|
||||
If a hypha has an attachment, here is what the text part might be about:
|
||||
* A textual description or representation of the picture.
|
||||
* A transcript of the song.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
# Help: Feeds
|
||||
= Help: Feeds
|
||||
Mycorrhiza Wiki has RSS, Atom, and JSON feeds to track the latest changes on the wiki.
|
||||
These feeds are linked on the [[/recent-changes | recent changes page]].
|
||||
|
||||
## Options
|
||||
== Options
|
||||
These feeds have options to combine related changes into groups:
|
||||
* {
|
||||
**period** Can be set to lengths of time like `5m`, `24h`, etc.
|
||||
@ -19,7 +19,7 @@ These feeds have options to combine related changes into groups:
|
||||
|
||||
If none of these options are set, changes will never be grouped.
|
||||
|
||||
## Examples
|
||||
== Examples
|
||||
URLs for feeds using these options look like this:
|
||||
* {
|
||||
`/recent-changes-rss?period=1h`
|
||||
|
||||
@ -1,33 +1,33 @@
|
||||
# Help: Hypha
|
||||
= Help: Hypha
|
||||
A **hypha** (//plural:// hyphae) is the main content unit used in Mycorrhiza Wiki.
|
||||
|
||||
## The structure of hypha
|
||||
== The structure of hypha
|
||||
A hypha consists of two parts:
|
||||
* **Attachment.** Some form of media. There is only one attachment. See [[/help/en/attachment | Attachment]] for more information about attachments.
|
||||
* **Text part.** Either a description of the attachment or a stand-alone text unit such as an article, a diary or a poem. It is written in a special markup, called [[/help/en/mycomarkup | Mycomarkup]].
|
||||
|
||||
Both parts are optional. You can have a picture without description, an article without an attachment, etc. You can have them both. You must have at least one part, though.
|
||||
|
||||
## How to create a hypha?
|
||||
== How to create a hypha?
|
||||
Some links on wiki are red. It means that they link a hypha that does not exist yet. If you follow this link, you will see a special page where you can upload an attachment or open the text editor. This is how you create hyphae.
|
||||
|
||||
You can create such red links and follow them to create hyphae.
|
||||
|
||||
Alternatively, you can edit your address in browser to jump to such pages directly.
|
||||
|
||||
## Hypha names
|
||||
== Hypha names
|
||||
Hypha names are case-insensitive. It means that names //amanita muscaria// and //Amanita Muscaria// are the same. Also, space and underscore are also the same (//amanita muscaria// = //amanita_muscaria//). Canonical names are all lowercase and underscored.
|
||||
|
||||
There are some characters that cannot be part of a hypha name: `?!:#@><*|"'&%{}\\` Others can be used.
|
||||
|
||||
## Genealogy
|
||||
== Genealogy
|
||||
A **subhypha** is a hypha that has a name starting with a name of a different hypha, followed by a slash and by the rest of the name. For example, hypha //Fruit/Apple// is a subhypha of hypha //Fruit//. There can be as many subhyphae as you want. Subhyphae can have subhyphae themselves.
|
||||
|
||||
Thus, a **superhypha** is a reverse of subhypha: //Fruit// is the superhypha of //Fruit/Apple//. There can be only one superhypha.
|
||||
|
||||
**Sibling hyphae** are hyphae that are subhyphae of the same hypha. For example, //Fruit/Apple// and //Fruit/Pear// are sibling hyphae.
|
||||
|
||||
## Word
|
||||
== Word
|
||||
Read the word //hypha// as /ˈhaɪfə/. The plural form is //hyphae//. Read it as /ˈhaɪfi/.
|
||||
|
||||
The word is taken from mycology, the study of fungi. In a fungus, hyphae are thin white threads from which the mycelium is made. See [[https://en.wikipedia.org/wiki/Hypha | this Wikipedia article]] for more information about real hyphae.
|
||||
|
||||
@ -1,9 +1,9 @@
|
||||
# Lock
|
||||
= Lock
|
||||
//This article is intended for wiki administrators.//
|
||||
|
||||
Sometimes, you may want to let only authorized users to view your wiki. This is when **lock** comes in handy.
|
||||
|
||||
## Enabling
|
||||
== Enabling
|
||||
In `config.ini`, set `Locked` to `true` to enable. `UseAuth` must also be `true`.
|
||||
```ini
|
||||
...
|
||||
@ -15,7 +15,7 @@ Locked = true
|
||||
|
||||
Restart your wiki.
|
||||
|
||||
## Usage
|
||||
== Usage
|
||||
When unauthorized people visit your wiki, they will see something like this:
|
||||
img {
|
||||
https://mycorrhiza.wiki/binary/release/1.3/lock_screenshot
|
||||
@ -23,5 +23,5 @@ https://mycorrhiza.wiki/binary/release/1.3/lock_screenshot
|
||||
|
||||
If they log in, they will be able to navigate the wiki. They are not able to register, though. [[/help/en/telegram | Telegram]] authorization is supported.
|
||||
|
||||
## See also
|
||||
== See also
|
||||
=> /help/en/whitelist Whitelist
|
||||
@ -1,11 +1,11 @@
|
||||
# Mycomarkup
|
||||
= Mycomarkup
|
||||
**Mycomarkup** is Mycorrhiza Wiki's own markup language.
|
||||
|
||||
It is the only supported markup, there is no support for Markdown, Creole, etc.
|
||||
|
||||
A Mycomarkup document (which is most often a hypha's text part) consists of //blocks//. There are different blocks for different purposes.
|
||||
|
||||
## Table of contents
|
||||
== Table of contents
|
||||
=> /help/en/mycomarkup#Paragraph Paragraph
|
||||
=> /help/en/mycomarkup#Inline_link Inline link
|
||||
=> /help/en/mycomarkup#Rocket_link Rocket link
|
||||
@ -18,7 +18,7 @@ A Mycomarkup document (which is most often a hypha's text part) consists of //bl
|
||||
=> /help/en/mycomarkup#Table Table
|
||||
=> /help/en/mycomarkup#Transclusion Transclusion
|
||||
|
||||
## Paragraph
|
||||
== Paragraph
|
||||
**Paragraphs** are the most ubiquitous blocks. You will use them a lot.
|
||||
|
||||
To create a paragraph, just write text. Paragraphs are separated by empty lines.
|
||||
@ -64,8 +64,8 @@ Just a paragraph with a couple of [[https://example.org | links]] leading [[nowh
|
||||
```}
|
||||
* Just a paragraph with a couple of [[https://example.org | links]] leading [[nowhere]].
|
||||
|
||||
## Link
|
||||
### Inline link
|
||||
== Link
|
||||
=== Inline link
|
||||
**Inline links** are part of a paragraph.
|
||||
|
||||
External links can be placed verbatim if they have protocol specified. These links are called autolinks. It may not work as expected sometimes. Supported protocols for autolinks are https, http, gemini, gopher, ftp.
|
||||
@ -88,7 +88,7 @@ Links to [[hypha | a Hypha]] and [[https://example.org | some website]].
|
||||
|
||||
Since hypha names are case-insensitive, these links are basically the same: `[[hypha]]`, `[[Hypha]]`, `[[HYPHA]]`.
|
||||
|
||||
### Rocket link
|
||||
=== Rocket link
|
||||
**Rocket links** are special links. They take up a whole line. They are not consistent with usual inline links. They were taken from [[https://gemini.circumlunar.space/docs/gemtext.gmi | gemtext]].
|
||||
|
||||
The display text is written after the first space, not `|`. If you want to link a hypha with spaces in it, replace the spaces with _.
|
||||
@ -106,7 +106,7 @@ The display text is written after the first space, not `|`. If you want to link
|
||||
=> https://example.org Display text
|
||||
}
|
||||
|
||||
### Relative link addressing
|
||||
=== Relative link addressing
|
||||
You don't have to write the full hypha name in every link, you can use **relative** links.
|
||||
|
||||
Consider you are editing a hypha called //fruit/apple//.
|
||||
@ -115,12 +115,12 @@ To link //fruit/pear// (a sibling hypha) you can write `[\[../pear]]`. To link /
|
||||
|
||||
There is also a way to link the wiki's non-hypha pages. For example, to link the Recent changes page, you can write `[\[/recent-changes]]`. You should use that rather than write the site's full URL because it may change in the future.
|
||||
|
||||
### Link colors
|
||||
=== Link colors
|
||||
Links come in several colors. Blue links are links to //existing// resources, while red links are links to //non-existent// resources. All external links are considered existing, therefore they are blue. Internal hypha links are always checked for existence.
|
||||
|
||||
Note that visited blue links are colored purple but are still called blue links. Moreover, blue links are yellow in the default dark theme.
|
||||
|
||||
## Heading
|
||||
== Heading
|
||||
There are four levels of **headings**. They consist of some equal signs followed by a space and the heading itself. You can format the heading like a paragraph. Feel free to start with `= level 1`, because it actually translates into HTML's `<h2>`, there will be no collisions with the hypha's title.
|
||||
|
||||
```
|
||||
@ -134,7 +134,7 @@ There is an invisible link that shows the § sign near every heading right after
|
||||
|
||||
**NB.** There is the legacy syntax for headings: `# ` to `###### `, similar to Markdown. You should not use them.
|
||||
|
||||
## Codeblock
|
||||
== Codeblock
|
||||
Use **codeblocks** to show code or any other preformatted text. Codeblocks start with triple backticks on column 1 and end similarly. You can write any text after the backticks, it is ignored. Put the preformatted text between them.
|
||||
|
||||
Like that, but without leading spaces:
|
||||
@ -150,7 +150,7 @@ this is preformatted
|
||||
see
|
||||
```
|
||||
|
||||
## Horizontal line
|
||||
== Horizontal line
|
||||
Write four hyphens to insert a **horizontal line**.
|
||||
|
||||
* {```
|
||||
@ -158,7 +158,7 @@ Write four hyphens to insert a **horizontal line**.
|
||||
```}
|
||||
* ----
|
||||
|
||||
## Image gallery
|
||||
== Image gallery
|
||||
Use **image galleries** to embed images to the page. Images can be either hyphae or external files. In the example below you can replace the URL with a hypha's name. If that hypha is an image, the image will be shown.
|
||||
|
||||
You can write a description for the image and specify its size.
|
||||
@ -197,7 +197,7 @@ img { https://mycorrhiza.wiki/static/favicon.ico }
|
||||
```}
|
||||
* {img { https://mycorrhiza.wiki/static/favicon.ico }}
|
||||
|
||||
## List
|
||||
== List
|
||||
**Lists** are used for sequential or tree data. They are quite popular.
|
||||
|
||||
Mark each list entry with an asterisk and a space:
|
||||
@ -242,36 +242,36 @@ All of Mycomarkup is supported in list entries. If you want to have multi-line e
|
||||
|
||||
* {```
|
||||
* {
|
||||
## Heading
|
||||
== Heading
|
||||
Text
|
||||
}
|
||||
* Not multiline
|
||||
```}
|
||||
* {
|
||||
* {
|
||||
## Heading
|
||||
== Heading
|
||||
Text
|
||||
}
|
||||
* Not multiline
|
||||
}
|
||||
|
||||
## Quote
|
||||
== Quote
|
||||
Prepend lines with `>` to quote them.
|
||||
|
||||
* {```
|
||||
> ## A heading
|
||||
> == A heading
|
||||
>
|
||||
> A paragraph
|
||||
> > A nested quote
|
||||
```}
|
||||
* {
|
||||
> ## A heading
|
||||
> == A heading
|
||||
>
|
||||
> A paragraph
|
||||
> > A nested quote
|
||||
}
|
||||
|
||||
## Table
|
||||
== Table
|
||||
**Tables** are delimited by `table {...}`. Both delimeters have to be on their own lines. You can write table's caption on the first line.
|
||||
|
||||
```
|
||||
@ -357,7 +357,7 @@ a | b
|
||||
c | d
|
||||
}
|
||||
|
||||
## Transclusion
|
||||
== Transclusion
|
||||
**Transclusion** is the mechanism of including contents of other hyphae into one hypha.
|
||||
|
||||
To include a hypha named `yoghurt`, write a line like that:
|
||||
@ -375,7 +375,7 @@ Transclusion lines start with a reverse-rocket symbol (`<=`) followed by zero or
|
||||
<= target hypha | selector
|
||||
```
|
||||
|
||||
### Selector
|
||||
=== Selector
|
||||
The //selector// specifies what part of the //target// to transclude. The parser checks for these words:
|
||||
|
||||
* **full.** Transclude the whole document.
|
||||
@ -393,5 +393,5 @@ This is an actual transclusion of a hypha below. It will fail if your wiki does
|
||||
|
||||
Recursive transclusion is also supported but it is limited to three iterations.
|
||||
|
||||
## See also
|
||||
== See also
|
||||
=> https://mycorrhiza.wiki/hypha/essay/why_mycomarkup Why it was created
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
# Previous/next
|
||||
= Previous/next
|
||||
Under every hypha there is a **previous/next** section with quick links to previous and next hyphae alphabetically.
|
||||
|
||||
This design encourages you to name your hyphae in such a way that clicking through these links would make sense. For example, if you are storing pages of a book, you should name them //p01//, //p02//, //p03//, etc.
|
||||
|
||||
It is impossible to change what hyphae are linked in this section. If you want to provide a different means of sequential navigation, just place some links by yourself.
|
||||
|
||||
## Hotkeys
|
||||
== Hotkeys
|
||||
Press `n` to go to the **n**ext page, press `p` to go to the **p**revious page.
|
||||
|
||||
## For administrators: how to remove these links
|
||||
== For administrators: how to remove these links
|
||||
For some wikis, these links make little or no sense. In this case, it is better to hide them.
|
||||
|
||||
In file `your-wiki/static/custom.css` write this:
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Recent changes
|
||||
= Recent changes
|
||||
**Recent changes** is a special page that lists all latest changes on the wiki. There is a link to it by default in the [[/help/en/top_bar | top bar]]. You can also jump to it quickly by pressing the `g r` hotkey.
|
||||
|
||||
Engaged wiki editors usually visit this page quite often.
|
||||
@ -16,5 +16,5 @@ Each edit has these properties:
|
||||
* **Affected hyphae.** Most actions affect one hypha (such as actual editing), but some affect more (recursive editing, for example).
|
||||
* **Message.** This message tells you what the edit is about. The message format is quite regular and parseable.
|
||||
|
||||
## See also
|
||||
== See also
|
||||
=> /help/en/feeds Feeds
|
||||
@ -1,4 +1,4 @@
|
||||
# Sibling hyphae section
|
||||
= Sibling hyphae section
|
||||
On the right (or below on smaller devices) of hypha pages there is a special section that lists **sibling hyphae**.
|
||||
|
||||
> **Sibling hyphae** are hyphae that are subhyphae of the same hypha. For example, //Fruit/Apple// and //Fruit/Pear// are sibling hyphae to each other.
|
||||
|
||||
@ -1,21 +1,21 @@
|
||||
# Telegram authorization
|
||||
= Telegram authorization
|
||||
//This article is intended for wiki administrators.//
|
||||
|
||||
If you want, you can let users log in to your wiki using **Telegram**.
|
||||
|
||||
Telegram is a proprietary messaging application used by half a billion people. Learn more at [[https://telegram.org]].
|
||||
|
||||
## Setting up Telegram integration
|
||||
== Setting up Telegram integration
|
||||
In order to enable Telegram authorization, you need to create a Telegram bot and link it with your wiki.
|
||||
|
||||
### Creating a bot
|
||||
=== Creating a bot
|
||||
Open the chat with [[https://t.me/botfather | @BotFather]], the bot for creating other bots. Create a new bot there. You will need the bot username and token later. You can set the bot's userpic. It would be great if it matches your wiki's logo.
|
||||
|
||||
After creating the bot, send the `/setdomain` command and then send your wiki's domain.
|
||||
|
||||
You do not need to actually //host// the bot. It is enough for it just to be created in BotFather. You can also reuse a previously existing bot.
|
||||
|
||||
### Configuring
|
||||
=== Configuring
|
||||
In `config.ini`, in `[Telegram]` section, fill in the bot's username (without @) and token:
|
||||
|
||||
```
|
||||
@ -28,10 +28,10 @@ Reload the wiki.
|
||||
|
||||
If both fields are both set, the engine will enable Telegram authorization.
|
||||
|
||||
## Using
|
||||
== Using
|
||||
On login and register pages there is a blue button. If a user clicks it, they are prompted to give the authorization permission to your bot. The user's @username will be used as wiki username. Telegram users are part of the //editor// user group by default. Telegram users can use the wiki just like everyone else.
|
||||
|
||||
## Limitations
|
||||
== Limitations
|
||||
* You should host your wiki using a public IP or domain name. Private-hosted (i.e. localhost or LAN) wikis are not supported, obviously.
|
||||
* Telegram does not support HTTP wikis, you //must// use HTTPS.
|
||||
** One way of setting up HTTPS is using [[https://certbot.eff.org | certbot]] and a reverse proxy such as [[https://nginx.org | nginx]].
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Top bar
|
||||
= Top bar
|
||||
The **top bar** is present on every single page of the wiki. It is the primary navigation means.
|
||||
|
||||
On big screens, the top bar is spread onto two lines.
|
||||
@ -20,14 +20,14 @@ On big screens, the top bar is spread onto two lines.
|
||||
|
||||
On small screens, the authorization section and the most-used-links section are hidden behind a menu. Click the button to see them. If your browser does not support JavaScript, they are always shown.
|
||||
|
||||
## Using the top bar
|
||||
== Using the top bar
|
||||
Wiki administrators are meant to configure the top bar links. Here is what you should put there:
|
||||
* Popular articles
|
||||
* Lists of something
|
||||
* Recent changes
|
||||
* Whatever you want, but not too much, of course. The space is limited
|
||||
|
||||
## Configuring the links
|
||||
== Configuring the links
|
||||
//This section is for administrators only.//
|
||||
|
||||
To change the default link, you first have to choose a hypha where you will store the configuration. A good choice would be to store as a subhypha of an administrator's profile hypha. In `config.ini`, in the `[Hyphae]` section set the hypha:
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Whitelist
|
||||
= Whitelist
|
||||
//This article is intended for wiki administrators.//
|
||||
|
||||
If you want to limit what people can authorize to your wiki, you may want to use the **whitelist**.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user