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 [2026/07/26 14:09] – Simon Grantwiki:syntax [2026/08/17 22:24] (current) – external edit 127.0.0.1
Line 1: Line 1:
 +See [[doc:start|more documentation]] 
 +
 ====== Formatting Syntax ====== ====== Formatting Syntax ======
  
Line 7: Line 9:
 DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these. DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
  
-     DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.  +    DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.  
     Of course you can **__//''combine''//__** all these.     Of course you can **__//''combine''//__** all these.
  
-Note that the formatting markers have to directly enclose the text, so ''%%** bold **%%'' with spaces inside the markers will not be formatted.+Note that the formatting markers have to directly enclose the text, with no space, so ''%%** bold **%%'' with spaces inside the markers will not be formatted.
  
-You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+You can use <sub>subscript</sub> and <sup>superscript</sup>, too. This is DokuWiki (and MediaWiki).
  
-    You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+    You can use <sub>subscript</sub> and <sup>superscript</sup>, too. This is DokuWiki (and MediaWiki).
  
 You can mark something as <del>deleted</del> as well. You can mark something as <del>deleted</del> as well.
Line 230: Line 232:
   * The second item   * The second item
     * You may have different levels     * You may have different levels
 +      * and deeper levels: indent by 2 spaces each time
   * Another item   * Another item
- 
-  - The same list but ordered 
-  - Another item 
-    - Just use indention for deeper levels 
-  - That's it 
  
 <code> <code>
Line 241: Line 239:
   * The second item   * The second item
     * You may have different levels     * You may have different levels
 +      * and deeper levels
   * Another item   * Another item
 +</code>
  
-  - The same list but ordered +Also take a look at the DokuWiki [[doku>faq:lists|FAQ on list items]]. 
-  - Another item + 
-    - Just use indention for deeper levels +However, because of the conflict between DokuWiki and Markdown syntax, to do an ordered list you need Markdown: 
-  - That's it+ 
 +1. First in an ordered list 
 +2. Second, as expected 
 +9. Third, output as "3" even though numbered "9" in the code 
 + 
 +<code> 
 +1. First in an ordered list 
 +2. Second, as expected 
 +9. Third, output as "3" even though numbered "9" in the code
 </code> </code>
  
-Also take a look at the [[doku>faq:lists|FAQ on list items]]. 
  
 ===== Text Conversions ===== ===== Text Conversions =====
Line 340: Line 347:
 Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers. Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
  
-  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +    ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ 
-  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +    | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | 
-  | Row 2 Col 1    | some colspan (note the double pipe) || +    | Row 2 Col 1    | some colspan (note the double pipe) || 
-  | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |+    | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
  
 To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators! To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
Line 356: Line 363:
 As you can see, it's the cell separator before a cell which decides about the formatting: As you can see, it's the cell separator before a cell which decides about the formatting:
  
-  |              ^ Heading 1            ^ Heading 2          ^ +    |              ^ Heading 1            ^ Heading 2          ^ 
-  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | +    ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        | 
-  ^ Heading 4    | no colspan this time |                    | +    ^ Heading 4    | no colspan this time |                    | 
-  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |+    ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
 You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect. You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.
Line 370: Line 377:
 Apart from the rowspan syntax those cells should not contain anything else. Apart from the rowspan syntax those cells should not contain anything else.
  
-  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ +    ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^ 
-  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | +    | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        | 
-  | Row 2 Col 1    | :::                        | Row 2 Col 3        | +    | Row 2 Col 1    | :::                        | Row 2 Col 3        | 
-  | Row 3 Col 1    | :::                        | Row 2 Col 3        |+    | Row 3 Col 1    | :::                        | Row 2 Col 3        |
  
 You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text. You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
Line 384: Line 391:
 This is how it looks in the source: This is how it looks in the source:
  
-  ^           Table with alignment           ^^^ +    ^           Table with alignment           ^^^ 
-  |         right|    center    |left          | +    |         right|    center    |left          | 
-  |left          |         right|    center    | +    |left          |         right|    center    | 
-  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |+    | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
 Note: Vertical alignment is not supported. Note: Vertical alignment is not supported.
Line 400: Line 407:
 The same is true for %%//__this__ text// with a smiley ;-)%%. The same is true for %%//__this__ text// with a smiley ;-)%%.
  
-  <nowiki> +    <nowiki> 
-  This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. +    This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. 
-  </nowiki> +    </nowiki> 
-  The same is true for %%//__this__ text// with a smiley ;-)%%.+    The same is true for %%//__this__ text// with a smiley ;-)%%.
  
 ===== Code Blocks ===== ===== Code Blocks =====
  
-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 four 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 four spaces.
  
 <code> <code>
Line 421: Line 428:
 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 four spaces.
  
-  <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 ====
Line 485: Line 492:
 **Example:** **Example:**
  
-  {{rss>http://slashdot.org/index.rss 5 author date 1h }}+     {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  
 {{rss>http://slashdot.org/index.rss 5 author date 1h }} {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  • wiki/syntax.1785074946.txt.gz
  • Last modified: 2026/07/26 14:09
  • by Simon Grant