Both sides previous revisionPrevious revisionNext revision | Previous revision |
start [2023/08/09 10:14] – [Cautions about differences from MediaWiki markup syntax] wikiadmin | start [2023/08/15 19:25] (current) – [Key points about DokuWiki markup, and differences from MediaWiki markup] wikiadmin |
---|
| |
====DokuWiki help==== | ====DokuWiki help==== |
* [[wiki:syntax|DokuWiki Syntax guide]] | * [[wiki:syntax|DokuWiki Formatting Syntax guide (short)]] |
| * [[https://www.dokuwiki.org/manual|DokuWiki Manual (detailed)]] |
* link to [[playground:playground|a playground page you can safely test in]] | * link to [[playground:playground|a playground page you can safely test in]] |
====Cautions about differences from MediaWiki markup syntax==== | * [[wiki:dokuwiki|DokuWiki Resources and Installation Guide]] |
| |
At first glance, DokuWiki markup looks a lot like MediaWiki markup, but while it has the same markup flavor, it is actually significantly different in many details. | ====Key points about DokuWiki Formatting markup, and differences from MediaWiki markup==== |
| |
- Headlines (headings) are still defined by equal signs (like %%"=====Heading====="%%), but they may ONLY contain text. Especially, links are NOT allowed in Headlines, while MediaWiki does allow links there. More info is here: https://www.dokuwiki.org/faq:headerlinks | At first glance, DokuWiki markup looks a lot like MediaWiki markup, but while it has the same markup flavor, it is actually significantly different in a number of ways. |
| |
| - Headlines (headings) are defined by equal signs (like %%"=====Heading====="%%), but they may ONLY contain text. Especially, links are NOT allowed in Headlines, while MediaWiki does allow links there. (Info on why is here: https://www.dokuwiki.org/faq:headerlinks) |
- More '='s makes BIGGER headline text, not smaller. I use 4, 5, and 6 '='s for small, medium, and large (top of page) headings, what would be 3, 2, and 1 '='s in MediaWiki. | - More '='s makes BIGGER headline text, not smaller. I use 4, 5, and 6 '='s for small, medium, and large (top of page) headings, what would be 3, 2, and 1 '='s in MediaWiki. |
- The characters to start a list item are '*' for unordered, and '-' for ordered (NOT '#'). They MUST be indented by 2 spaces, they do NOT work at the left margin. For each further list indent, add 2 more spaces, NOT another '*' or '-'. | - The characters to start a list item are '*' for unordered, and '-' for ordered (NOT '#'). They MUST be indented by 2 spaces, they do NOT work at the left margin. For each further list indent, add 2 more spaces, NOT another '*' or '-'. |
- To force a new line, use '\\' at the end of a line, or '%%\\ %%' in the middle of a line. An empty line is a paragraph separator, which causes a new line followed by an empty line. | - To display copied-in text exactly as it is, for example from an email, use %%<text>%%your text%%</text>%%. Uppercase %%<TEXT>%% does the same, and adds a box around it. |
| - To force a new line, use '\\' at the end of a line, or '%%\\ %%' in the middle of a line. An empty line acts as a paragraph separator, which causes a new line followed by an empty line. |
- To prevent characters from being interpreted as markup, bracket them with pairs of percent signs (%) | - To prevent characters from being interpreted as markup, bracket them with pairs of percent signs (%) |
- Very unlike MediaWiki, there is no Page Title stored outside of the page markup, partly because there is no database to store it in. FSGW has DokuWiki configured to use the first Headline on each page as the page title. | - Unlike MediaWiki, there is no Page Title stored outside of the page markup, because there is no database to store it in. FSGW has DokuWiki configured to try to use the first Headline on each page as the page title. |
- To display un-formatted text with newlines exactly as it is, use %%<text>%%text%%</text>%%. This is what %%<poem>%%text%%</poem>%% did in FSGW's MediaWiki. | - External (outside the wiki) links will open in a new tab. This is a configuration choice we made in DokuWiki. |
| - A basic MediaWiki to DokuWiki markup converter is: https://www.vertopal.com/en/convert/wiki-mediawiki-to-dokuwiki |