wiki:syntax

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
wiki:syntax [2025/11/08 16:17] – simonwiki:syntax [2025/11/08 17:55] (current) – simon
Line 1: Line 1:
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
-[[doku>DokuWiki]] supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too.+[[doku>DokuWiki]] supports a simple markup language of its own, and also a variant of Markdown, both of which try to make the datafiles to be as readable as possible, but often in different ways. This page contains most of the possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing "Edit this page". If you want to try something, just use the [[playground:playground|playground]] page. The simpler markup is easily accessible via [[doku>toolbar|quickbuttons]], too. 
 + 
 +When you try editing this wiki, you will discover quite quickly that we have decided to use the Markdown plugin. 
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
Line 12: Line 14:
  
 `You can use <sub>subscript</sub> and <sup>superscript</sup>, too.` `You can use <sub>subscript</sub> and <sup>superscript</sup>, too.`
 +
 +You can't use the Markdown way of `H~2~O` or `x^2^`. 
 +
 +But Markdown *italic* is possible, with one asterisk instead of two slash characters.
 +
 +`But Markdown *italic* is possible, with one asterisk instead of two slash characters.`
  
 You can mark something as <del>deleted</del> as well. You can mark something as <del>deleted</del> as well.
Line 17: Line 25:
 `You can mark something as <del>deleted</del> as well.` `You can mark something as <del>deleted</del> as well.`
  
-**Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, in native Dokuwiki you can use two backslashes followed by a whitespace or the end of line; but in Markdown you end the line\+**Paragraphs** are created from blank lines. 
 +If you want to **force a newline** without a paragraph, 
 +in native Dokuwiki you can use two backslashes followed by a whitespace or the end of line; 
 +but in Markdown you end the line
 with a single backslash and no trailing space. with a single backslash and no trailing space.
 +
 +```
 +**Paragraphs** are created from blank lines.
 +If you want to **force a newline** without a paragraph,
 +in native Dokuwiki you can use two backslashes followed by a whitespace or the end of line;
 +but in Markdown you end the line
 +with a single backslash and no trailing space.
 +```
  
 This is some text with some linebreaks\ This is some text with some linebreaks\
Line 37: Line 56:
 ==== External ==== ==== External ====
  
-External links are recognized automagically: http://www.google.com or simply www.google.com+External links are recognized automagically: https://www.google.com or simply www.google.com
  
-You can set the link text as well: [This Link points to google](https://www.google.com). Email addresses like this one: <andi@splitbrain.org> are recognized, too.+You can set the link text as well: [This Link points to google](https://www.google.com).
  
 `You can set the link text as well: [This Link points to google](https://www.google.com) in Markdown format.` `You can set the link text as well: [This Link points to google](https://www.google.com) in Markdown format.`
 +
 +Email addresses like this one: <andi@splitbrain.org> are recognized, too.
  
 `Email addresses like this one: <andi@splitbrain.org> are recognized, too.` `Email addresses like this one: <andi@splitbrain.org> are recognized, too.`
  
-Native DokuWiki format `[[URL|linktext]]` doesn't work for full links if you are in Markdown format.+Native DokuWiki format `[[URL|linktext]]` doesn't work for full http links if you are in Markdown format.
  
  
Line 90: Line 111:
  
 * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone"). * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone").
-* For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''conf/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): +* For Mozilla and Firefox it can be enabled through different workaround mentioned in the [Mozilla Knowledge Base](https://kb.mozillazine.org/Links_to_local_pages_do_not_work). However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''conf/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): 
  
 <code - conf/lang/en/lang.php> <code - conf/lang/en/lang.php>
Line 107: Line 128:
  
 [[http://php.net|{{wiki:dokuwiki-128.png?500}}]] [[http://php.net|{{wiki:dokuwiki-128.png?500}}]]
 +
 +`[[http://php.net|{{wiki:dokuwiki-128.png?500}}]]`
  
 Please note: The image formatting is the only formatting syntax accepted in link names. Please note: The image formatting is the only formatting syntax accepted in link names.
Line 179: Line 202:
  
 By using left or right whitespaces you can choose the alignment. By using left or right whitespaces you can choose the alignment.
 +
 +---- 
  
 {{ wiki:dokuwiki-128.png?200}} {{ wiki:dokuwiki-128.png?200}}
 Right:`{{ wiki:dokuwiki-128.png?200}}` Right:`{{ wiki:dokuwiki-128.png?200}}`
  
-&nbsp;\+----
  
 {{wiki:dokuwiki-128.png?200 }} {{wiki:dokuwiki-128.png?200 }}
 Left:`{{wiki:dokuwiki-128.png?200 }}` Left:`{{wiki:dokuwiki-128.png?200 }}`
  
-&nbsp;\+----
  
 Center:`{{ wiki:dokuwiki-128.png?200 }}` Center:`{{ wiki:dokuwiki-128.png?200 }}`
 {{ wiki:dokuwiki-128.png?200 }} {{ wiki:dokuwiki-128.png?200 }}
 +
 +----
  
 Of course, you can add a title (displayed as a tooltip by most browsers), too. Of course, you can add a title (displayed as a tooltip by most browsers), too.
Line 422: Line 449:
 The same is true for %%//__this__ text// with a smiley ;-)%%. The same is true for %%//__this__ text// with a smiley ;-)%%.
  
-  <nowiki> +``` 
-  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. +<nowiki> 
-  </nowiki> +This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 
-  The same is true for %%//__this__ text// with a smiley ;-)%%.+</nowiki> 
 +The same is true for %%//__this__ text// with a smiley ;-)%%. 
 +```
  
 ===== Code Blocks ===== ===== Code Blocks =====
Line 431: Line 460:
 You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''%%<code>%%'' or ''%%<file>%%''. You can include code blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags ''%%<code>%%'' or ''%%<file>%%''.
  
-  This is text is indented by two spaces.+  This is text is indented by two spaces, but only works in native DokuWiki.
  
 <code> <code>
Line 443: Line 472:
 Those blocks were created by this source: Those blocks were created by this source:
  
-    This is text is indented by two spaces.+``` 
 +  This is text is indented by two spaces, but only works in native DokuWiki.
  
-  <code> +<code> 
-  This is preformatted code all spaces are preserved: like              <-this +This is preformatted code all spaces are preserved: like              <-this 
-  </code>+</code>
  
-  <file> +<file> 
-  This is pretty much the same, but you could use it to show that you quoted a file. +This is pretty much the same, but you could use it to show that you quoted a file. 
-  </file>+</file> 
 +```
  
 ==== Syntax Highlighting ==== ==== Syntax Highlighting ====
  • wiki/syntax.1762618629.txt.gz
  • Last modified: 2025/11/08 16:17
  • by simon