Site Tools


Differences

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

Link to this comparison view

wiki:syntax [2018/05/03 06:36]
127.0.0.1 external edit
wiki:syntax [2018/12/18 13:31] (current)
francoisgaulier
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 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|]] page. The simpler markup is easily accessible via [[doku>​toolbar|quickbuttons]],​ too.
  
 ===== Basic Text Formatting ===== ===== Basic Text Formatting =====
  
-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. 
 +<​code>​ 
 +DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts. 
 +Of course you can **__//''​combine''//​__** all these. 
 +</​code>​
  
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''​monospaced''​ texts. +You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>​ , too. 
-  Of course you can **__//''​combine''//​__** all these. +<​code>​ 
- +You can use <​sub>​subscript</​sub> ​ and <​sup>​superscript</​sup>​ , too. 
-You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too. +</​code>​
- +
-  You can use <​sub>​subscript</​sub>​ and <​sup>​superscript</​sup>,​ too.+
  
 You can mark something as <​del>​deleted</​del>​ as well. You can mark something as <​del>​deleted</​del>​ as well.
- +<​code>​ 
-  You can mark something as <​del>​deleted</​del>​ as well.+You can mark something as <​del>​deleted</​del> ​ as well. 
 +</​code>​
  
 **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line. **Paragraphs** are created from blank lines. If you want to **force a newline** without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
  
-This is some text with some linebreaks\\ Note that the +This is some text with some \linebreaks 
-two backslashes are only recognized at the end of a line\\ +Note that the two backslashes are only recognized at the end of a \line 
-or followed ​by\\ a whitespace \\this happens without it.+or followed \by 
 +a whitespace \\this happens without it.
  
-  ​This is some text with some linebreaks\\ Note that the +<​code>​ 
-  two backslashes are only recognized at the end of a line\\ +This is some text with some \linebreaks 
-  or followed by\\ a whitespace \\this happens without it.+Note that the 
 +two backslashes are only recognized at the end of a line   
 +or followed ​\by 
 +a whitespace \\this happens without it. 
 +</​code>​
  
 You should use forced newlines only if really needed. You should use forced newlines only if really needed.
Line 36: Line 44:
 ==== External ==== ==== External ====
  
-External links are recognized automagically:​ http://​www.google.com or simply www.google.com - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​andi@splitbrain.org>​ are recognized, too.+External links are recognized automagically: ​[[http://​www.google.com|http://​www.google.com]] ​or simply ​[[http://​www.google.com|www.google.com]] 
 + - You can set the link text as well: [[http://​www.google.com|This Link points to google]]. Email addresses like this one: <​andi@splitbrain.org>​ are recognized, too.
  
-  ​DokuWiki supports multiple ways of creating links. External links are recognized +<​code>​ 
-  automagically:​ http://​www.google.com or simply www.google.com - You can set +DokuWiki supports multiple ways of creating links. External links are recognized 
-  link text as well: [[http://​www.google.com|This Link points to google]]. Email +automagically:​ http://​www.google.com or simply www.google.com - You can set 
-  addresses like this one: <​andi@splitbrain.org>​ are recognized, too.+link text as well: [[http://​www.google.com|This Link points to google]]. Email 
 +addresses like this one: <​andi@splitbrain.org>​ are recognized, too. 
 +</​code>​
  
 ==== Internal ==== ==== Internal ====
  
-Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].+Internal links are created by using square brackets. You can either just give a [[:wiki:pagename|]] or use an additional [[:wiki:pagename|link text]].
  
-  ​Internal links are created by using square brackets. You can either just give +<​code>​ 
-  a [[pagename]] or use an additional [[pagename|link text]].+Internal links are created by using square brackets. You can either just give 
 +a [[pagename|]] or use an additional [[pagename|link text]]. 
 +</​code>​
  
 [[doku>​pagename|Wiki pagenames]] are converted to lowercase automatically,​ special characters are not allowed. [[doku>​pagename|Wiki pagenames]] are converted to lowercase automatically,​ special characters are not allowed.
  
-You can use [[some:​namespaces]] by using a colon in the pagename.+You can use [[:some:​namespaces|]] by using a colon in the pagename.
  
-  ​You can use [[some:​namespaces]] by using a colon in the pagename.+<​code>​ 
 +You can use [[some:​namespaces|]] by using a colon in the pagename. 
 +</​code>​
  
 For details about namespaces see [[doku>​namespaces]]. For details about namespaces see [[doku>​namespaces]].
  
-Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[syntax#​internal|this Section]].+Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to [[:wiki:syntax#​internal|this Section]].
  
-  ​This links to [[syntax#​internal|this Section]].+<​code>​ 
 +This links to [[syntax#​internal|this Section]]. 
 +</​code>​
  
 Notes: Notes:
  
-  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. +  * Links to [[:wiki:syntax|existing pages]] are shown in a different style from [[:wiki:nonexisting|]] ones. 
-  * DokuWiki does not use [[wp>​CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>​config]] file. Hint: If DokuWiki is a link, then it's enabled.+  * DokuWiki does not use [[wp>​CamelCase|]] to automatically create links by default, but this behavior can be enabled in the [[doku>​config]] file. Hint: If DokuWiki is a link, then it's enabled.
   * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.   * When a section'​s heading is changed, its bookmark changes, too. So don't rely on section linking too much.
  
 ==== Interwiki ==== ==== Interwiki ====
  
-DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].+DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki|]].
  
-  ​DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. +<​code>​ 
-  For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki]].+DokuWiki supports [[doku>​Interwiki]] links. These are quick links to other Wikis. 
 +For example this is a link to Wikipedia'​s page about Wikis: [[wp>​Wiki|]]. 
 +</​code>​
  
 ==== Windows Shares ==== ==== Windows Shares ====
  
-Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>​Intranet]].+Windows shares like [[\\server\share|this]] are recognized, too. Please note that these only make sense in a homogeneous user group like a corporate [[wp>​Intranet|]].
  
-  ​Windows Shares like [[\\server\share|this]] are recognized, too.+<​code>​ 
 +Windows Shares like [[\\server\share|this]] are recognized, too. 
 +</​code>​
  
 Notes: Notes:
  
   * 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]]): ​<code - conf/​lang/​en/​lang.php>​+  * 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]]):​ 
 + 
 +conf/​lang/​en/​lang.php 
 + 
 +<code>
 <?php <?php
 /** /**
Line 97: Line 122:
 You can also use an image to link to another internal or external page by combining the syntax for links and [[#​images_and_other_files|images]] (see below) like this: You can also use an image to link to another internal or external page by combining the syntax for links and [[#​images_and_other_files|images]] (see below) like this:
  
-  [[http://​php.net|{{wiki:​dokuwiki-128.png}}]] +<​code>​
 [[http://​php.net|{{wiki:​dokuwiki-128.png}}]] [[http://​php.net|{{wiki:​dokuwiki-128.png}}]]
 +</​code>​
 +
 +[[http://​php.net|{{:​wiki:​dokuwiki-128.png?​nolink&​}}]]
  
 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 107: Line 134:
 ===== Footnotes ===== ===== Footnotes =====
  
-You can add footnotes ((This is a footnote)) by using double parentheses.+You can add footnotes ((This is a footnote)) ​ by using double parentheses.
  
-  ​You can add footnotes ((This is a footnote)) by using double parentheses.+<​code>​ 
 +You can add footnotes ((This is a footnote)) by using double parentheses. 
 +</​code>​
  
 ===== Sectioning ===== ===== Sectioning =====
  
-You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically ​-- this can be disabled by including the string ''<​nowiki>​~~NOTOC~~</​nowiki>''​ in the document.+You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically ​– this can be disabled by including the string ''<​nowiki>​~~NOTOC~~ </​nowiki>'' ​ in the document.
  
 ==== Headline Level 3 ==== ==== Headline Level 3 ====
 +
 === Headline Level 4 === === Headline Level 4 ===
 +
 == Headline Level 5 == == Headline Level 5 ==
  
-  ​==== Headline Level 3 ==== +<​code>​ 
-  === Headline Level 4 === +==== Headline Level 3 ==== 
-  == Headline Level 5 ==+=== Headline Level 4 === 
 +== Headline Level 5 == 
 +</​code>​
  
 By using four or more dashes, you can make a horizontal line: By using four or more dashes, you can make a horizontal line:
Line 131: Line 164:
 You can include external and internal [[doku>​images|images,​ videos and audio files]] with curly brackets. Optionally you can specify the size of them. You can include external and internal [[doku>​images|images,​ videos and audio files]] with curly brackets. Optionally you can specify the size of them.
  
-Real size:                        {{wiki:​dokuwiki-128.png}}+Real size: {{:wiki:​dokuwiki-128.png}}
  
-Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}+Resize to given width: {{:wiki:​dokuwiki-128.png?​50}}
  
-Resize to given width and height((when the aspect ratio of the given width and height doesn'​t match that of the image, it will be cropped to the new ratio before resizing)): {{wiki:​dokuwiki-128.png?​200x50}}+Resize to given width and height((when the aspect ratio of the given width and height doesn'​t match that of the image, it will be cropped to the new ratio before resizing)) : {{:wiki:​dokuwiki-128.png?​200x50}}
  
 +Resized external image: {{http://​php.net/​images/​php.gif?​direct&​200x50}}
 +
 +<​code>​
 +Real size:                        {{wiki:​dokuwiki-128.png}}
 +Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}}
 +Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}}
 Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}} Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}}
 +</​code>​
  
-  Real size:                        {{wiki:​dokuwiki-128.png}} +By using left or right whitespaces you can choose the alignment.
-  Resize to given width: ​           {{wiki:​dokuwiki-128.png?​50}} +
-  Resize to given width and height: {{wiki:​dokuwiki-128.png?​200x50}} +
-  Resized external image: ​          ​{{http://​php.net/​images/​php.gif?​200x50}}+
  
 +{{  :​wiki:​dokuwiki-128.png}}
  
-By using left or right whitespaces you can choose the alignment.+{{:​wiki:​dokuwiki-128.png  }}
  
 +{{  :​wiki:​dokuwiki-128.png ​ }}
 +
 +<​code>​
 {{ wiki:​dokuwiki-128.png}} {{ wiki:​dokuwiki-128.png}}
- 
 {{wiki:​dokuwiki-128.png }} {{wiki:​dokuwiki-128.png }}
- 
 {{ wiki:​dokuwiki-128.png }} {{ wiki:​dokuwiki-128.png }}
- +</​code>​
-  {{ wiki:​dokuwiki-128.png}} +
-  {{wiki:​dokuwiki-128.png }} +
-  {{ wiki:​dokuwiki-128.png }}+
  
 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.
  
 +{{  :​wiki:​dokuwiki-128.png ​ |This is the caption}}
 +
 +<​code>​
 {{ wiki:​dokuwiki-128.png |This is the caption}} {{ wiki:​dokuwiki-128.png |This is the caption}}
 +</​code>​
  
-  {{ wiki:​dokuwiki-128.png |This is the caption}} +For linking an image to another page see [[#image_links|Image Links]] above.
- +
-For linking an image to another page see [[#Image Links]] above.+
  
 ==== Supported Media Formats ==== ==== Supported Media Formats ====
Line 169: Line 207:
 DokuWiki can embed the following media formats directly. DokuWiki can embed the following media formats directly.
  
-| Image | ''​gif'',​ ''​jpg'',​ ''​png'' ​ +|Image|''​gif'',​ ''​jpg'',​ ''​png'' ​  ​
-| Video | ''​webm'',​ ''​ogv'',​ ''​mp4''​ | +|Video|''​webm'',​ ''​ogv'',​ ''​mp4''​ | 
-| Audio | ''​ogg'',​ ''​mp3'',​ ''​wav'' ​ +|Audio|''​ogg'',​ ''​mp3'',​ ''​wav'' ​  ​
-| Flash | ''​swf'' ​                   |+|Flash|''​swf'' ​  ​|
  
 If you specify a filename that is not a supported media format, then it will be displayed as a link instead. If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
  
-By adding ''?​linkonly''​ you provide a link to the media without displaying it inline+By adding ''?​linkonly'' ​ you provide a link to the media without displaying it inline
  
-  ​{{wiki:​dokuwiki-128.png?​linkonly}}+<​code>​ 
 +{{wiki:​dokuwiki-128.png?​linkonly}} 
 +</​code>​
  
-{{wiki:​dokuwiki-128.png?​linkonly}} This is just a link to the image.+{{:wiki:​dokuwiki-128.png?​linkonly|dokuwiki-128.png}} This is just a link to the image.
  
 ==== Fallback Formats ==== ==== Fallback Formats ====
Line 188: Line 228:
 For example consider this embedded mp4 video: For example consider this embedded mp4 video:
  
-  ​{{video.mp4|A funny video}}+<​code>​ 
 +{{video.mp4|A funny video}} 
 +</​code>​
  
-When you upload a ''​video.webm''​ and ''​video.ogv''​ next to the referenced ''​video.mp4'',​ DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.+When you upload a ''​video.webm'' ​ and ''​video.ogv'' ​ next to the referenced ''​video.mp4'',​ DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
  
-Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg''​ file would work.+Additionally DokuWiki supports a "​poster"​ image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a ''​video.jpg'' ​ file would work.
  
 ===== Lists ===== ===== Lists =====
  
-Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''​*''​ for unordered lists or a ''​-''​ for ordered ones.+Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a ''​*'' ​ for unordered lists or a ''​-'' ​ for ordered ones.
  
   * This is a list   * This is a list
   * The second item   * The second item
-    ​* You may have different levels+      ​* You may have different levels
   * Another item   * Another item
  
   - The same list but ordered   - The same list but ordered
   - Another item   - Another item
-    ​- Just use indention for deeper levels+      ​- Just use indention for deeper levels
   - That's it   - That's it
  
Line 230: Line 272:
 ==== Text to Image Conversions ==== ==== Text to Image Conversions ====
  
-DokuWiki converts commonly used [[wp>​emoticon]]s to their graphical equivalents. Those [[doku>​Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:+DokuWiki converts commonly used [[wp>​emoticon|]]s to their graphical equivalents. Those [[doku>​Smileys]] and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
  
-  * 8-) %%  ​8-)  %% +  * 8-) <​nowiki> ​8-) </​nowiki>​ 
-  * 8-O %%  ​8-O  %% +  * 8-O <​nowiki> ​8-O </​nowiki>​ 
-  * :-( %%  ​:-(  %% +  * :-( <​nowiki> ​:-( </​nowiki>​ 
-  * :-) %%  ​:-)  %% +  * :-) <​nowiki> ​:-) </​nowiki>​ 
-  * =)  ​%%  ​=)   %% +  * =) <​nowiki> ​=) </​nowiki>​ 
-  * :-/ %%  ​:-/  %% +  * :-/ <​nowiki> ​:-/ </​nowiki>​ 
-  * :-\ %%  ​:-\  %% +  * :-" class= <​nowiki> ​:- </​nowiki>​ 
-  * :-? %%  ​:-?  %% +  * :-? <​nowiki> ​:-? </​nowiki>​ 
-  * :-D %%  ​:-D  %% +  * :-D <​nowiki> ​:-D </​nowiki>​ 
-  * :-P %%  ​:-P  %% +  * :-P <​nowiki> ​:-P </​nowiki>​ 
-  * :-O %%  ​:-O  %% +  * :-O <​nowiki> ​:-O </​nowiki>​ 
-  * :-X %%  ​:-X  %% +  * :-X <​nowiki> ​:-X </​nowiki>​ 
-  * :-| %%  ​:-|  %% +  * :-| <​nowiki> ​:-| </​nowiki>​ 
-  * ;-) %%  ​;-)  %% +  *;-) <​nowiki>​;-) </​nowiki>​ 
-  * ^_^ %%  ​^_^  %% +  * ^_^ <​nowiki> ​^_^ </​nowiki>​ 
-  * :?: %%  ​:?:  %% +  * :?: <​nowiki> ​:?: </​nowiki>​ 
-  * :!: %%  ​:!:  %% +  * :!: <​nowiki> ​:!: </​nowiki>​ 
-  * LOL %%  ​LOL  %% +  * LOL <​nowiki> ​LOL </​nowiki>​ 
-  * FIXME %%  ​FIXME %% +  * FIXME <​nowiki> ​FIXME </​nowiki>​ 
-  * DELETEME ​%% DELETEME ​%%+  * DELETEME ​<​nowiki> ​DELETEME ​</​nowiki>​
  
 ==== Text to HTML Conversions ==== ==== Text to HTML Conversions ====
  
-Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.+Typography: [[:​wiki:​dokuwiki|DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
--> <- <-> => <= <=> >> << ​-- --- 640x480 (c) (tm) (r) +→ <- <→ ⇒ <= <>> <<– — 640×480 © ™ ® "He thought '​It'​s a man's world'"
-"He thought '​It'​s a man's world'..."+
  
 <​code>​ <​code>​
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)+-> <- <-> => <= <​=>>>​ <<-- --- 640x480 (c) (tm) (r)
 "He thought '​It'​s a man's world'​..."​ "He thought '​It'​s a man's world'​..."​
 </​code>​ </​code>​
Line 267: Line 308:
 The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>​entities|pattern file]]. The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>​entities|pattern file]].
  
-There are three exceptions which do not come from that pattern file: multiplication entity (640x480), '​single'​ and "​double quotes"​. They can be turned off through a [[doku>​config:​typography|config option]].+There are three exceptions which do not come from that pattern file: multiplication entity (640×480), '​single'​ and "​double quotes"​. They can be turned off through a [[doku>​config:​typography|config option]].
  
 ===== Quoting ===== ===== Quoting =====
Line 275: Line 316:
 <​code>​ <​code>​
 I think we should do it I think we should do it
- 
 > No we shouldn'​t > No we shouldn'​t
  
Line 303: Line 343:
 DokuWiki supports a simple syntax to create tables. DokuWiki supports a simple syntax to create tables.
  
 +^Heading 1  ^Heading 2  ^Heading 3  |
 +|Row 1 Col 1  |Row 1 Col 2  |Row 1 Col 3  |
 +|Row 2 Col 1  |some colspan (note the double pipe)||
 +|Row 3 Col 1  |Row 3 Col 2  |Row 3 Col 3  |
 +
 +Table rows have to start and end with a ''''​| for normal rows or a ''''​^ for headers.
 +
 +<​code>​
 ^ 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        |
- +</​code>​
-Table rows have to start and end with a ''​|''​ for normal rows or a ''​^''​ for headers. +
- +
-  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^ +
-  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        | +
-  | Row 2 Col 1    | some colspan (note the double pipe) || +
-  | 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 319: Line 361:
 Vertical tableheaders are possible, too. Vertical tableheaders are possible, too.
  
-             ^ Heading 1            ^ Heading 2          ^+  ^Heading 1  ^Heading 2  | 
 +^Heading 3  |Row 1 Col 2  |Row 1 Col 3  | 
 +^Heading 4  |no colspan this time|   | 
 +^Heading 5  |Row 2 Col 2  |Row 2 Col 3  | 
 + 
 +As you can see, it's the cell separator before a cell which decides about the formatting:​ 
 + 
 +<​code>​ 
 +|   ^ 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        |
 +</​code>​
  
-As you can see, it'the cell separator before a cell which decides about the formatting:+You can have rowspans (vertically connected cells) by adding ​''<​nowiki>:::</​nowiki>'' ​ into the cells below the one to which they should connect.
  
-  |              ​^ Heading 1            ^ Heading 2          ^ +^Heading 1  ^Heading 2  ^Heading 3  | 
-  ^ Heading 3    | Row 1 Col 2          ​| Row 1 Col 3        +|Row 1 Col 1  |this cell spans vertically|Row 1 Col 3  
-  ​^ Heading 4    ​no colspan this time                    +|Row 2 Col 1  ​| ​::: |Row 2 Col 3  ​
-  ^ Heading 5    ​| Row Col 2          ​| Row 2 Col 3        |+|Row Col 1  | ::: |Row 2 Col 3  |
  
-You can have rowspans (vertically connected cells) by adding ''​%%:::​%%''​ into the cells below the one to which they should ​connect.+Apart from the rowspan syntax those cells should ​not contain anything else.
  
 +<​code>​
 ^ 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        |
 +</​code>​
  
-Apart from the rowspan syntax those cells should not contain anything else.+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.
  
-  ​Heading 1      ^ Heading 2                  ​Heading 3          ​+ Table with alignment  ​^^| 
-  | Row 1 Col 1    ​this cell spans vertically | Row 1 Col 3        ​+ right ​center  ​|left  ​
-  | Row 2 Col 1    ​:::                        | Row 2 Col 3        ​+|left  ​| ​ right ​center  ​
-  Row 3 Col 1    ​:::                        ​Row 2 Col 3        ​|+|xxxxxxxxxxxx|xxxxxxxxxxxx|xxxxxxxxxxxx|
  
-You can align the table contents, too. Just add at least two whitespaces at the opposite end of your textAdd 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.+This is how it looks in the source:
  
 +<​code>​
 ^           Table with alignment ​          ^^^ ^           Table with alignment ​          ^^^
 |         ​right| ​   center ​   |left          | |         ​right| ​   center ​   |left          |
 |left          |         ​right| ​   center ​   | |left          |         ​right| ​   center ​   |
 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
- +</​code>​
-This is how it looks in the source: +
- +
-  ^           Table with alignment ​          ^^^ +
-  |         ​right| ​   center ​   |left          | +
-  |left          |         ​right| ​   center ​   | +
-  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |+
  
 Note: Vertical alignment is not supported. Note: Vertical alignment is not supported.
Line 363: Line 411:
 ===== No Formatting ===== ===== No Formatting =====
  
-If you need to display text exactly like it is typed (without any formatting),​ enclose the area either with ''​%%<​nowiki>​%%''​ tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​.+If you need to display text exactly like it is typed (without any formatting),​ enclose the area either with ''<​nowiki>'' ​ tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​.
  
 +<​nowiki>​ This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing is done with it. </​nowiki>​ The same is true for <​nowiki>//​__this__ text// with a smiley;-) </​nowiki>​.
 +
 +<​code>​
 <​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 <​nowiki>​//__this__ text// with a smiley;​-)<​/nowiki>​. 
- +</code>
-  ​<​nowiki>​ +
-  This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing is done with it+
-  </nowiki> +
-  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 two spaces (like used for the previous examples) or by using the tags ''<​code>'' ​ or ''<​file>''​.
  
-  ​This is text is indented by two spaces.+<​code>​ 
 +This is text is indented by two spaces. 
 +</​code>​
  
 <​code>​ <​code>​
Line 391: Line 440:
 Those blocks were created by this source: Those blocks were created by this source:
  
-    ​This is text is indented by two spaces.+<​code>​ 
 +  ​This is text is indented by two spaces. 
 +</​code>​
  
-  ​<​code>​ +<​code>​ 
-  This is preformatted code all spaces are preserved: like              <-this +''​ 
-  </​code>​+This is preformatted code all spaces are preserved: like              <-this
  
-  ​<file+''​ 
-  This is pretty much the same, but you could use it to show that you quoted a file. +</code
-  </file>+ 
 +<​code>​ 
 + 
 +This is pretty much the same, but you could use it to show that you quoted a file. 
 +</code>
  
 ==== Syntax Highlighting ==== ==== Syntax Highlighting ====
  
-[[wiki:​DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://​qbnz.com/​highlighter/​|GeSHi]] Generic Syntax Highlighter ​-- so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<​nowiki><​code java></​nowiki>''​ or ''<​nowiki><​file java></​nowiki>''​.+[[:wiki:dokuwiki|DokuWiki]] can highlight sourcecode, which makes it easier to read. It uses the [[http://​qbnz.com/​highlighter/​|GeSHi]] Generic Syntax Highlighter ​– so any language supported by GeSHi is supported. The syntax uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. ''<​nowiki><​code java></​nowiki>'' ​ or ''<​nowiki><​file java></​nowiki>''​.
  
 <code java> <code java>
Line 423: Line 478:
 ==== Downloadable Code Blocks ==== ==== Downloadable Code Blocks ====
  
-When you use the ''​%%<​code>​%%''​ or ''​%%<​file>​%%''​ syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:+When you use the ''<​code>'' ​ or ''<​file>'' ​ syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
  
 <​code>​ <​code>​
Line 435: Line 490:
 </​file>​ </​file>​
  
-If you don't want any highlighting but want a downloadable file, specify a dash (''​-''​) as the language code: ''​%%<code - myfile.foo>​%%''​. +If you don't want any highlighting but want a downloadable file, specify a dash (''​-''​) as the language code: ''​<​nowiki>​<code - myfile.foo>​</​nowiki>​''​.
  
 ===== Embedding HTML and PHP ===== ===== Embedding HTML and PHP =====
  
-You can embed raw HTML or PHP code into your documents by using the ''​%%<​html>​%%''​ or ''​%%<php>%%''​ tags. (Use uppercase tags if you need to enclose block level elements.)+You can embed raw HTML or PHP code into your documents by using the ''​<​nowiki>​<​html>​</​nowiki>​'' ​ or ''​<​nowiki>​<php></​nowiki>​'' ​ tags. (Use uppercase tags if you need to enclose block level elements.)
  
 HTML example: HTML example:
Line 453: Line 507:
 </​code>​ </​code>​
  
-<​html>​ +<​html>​ This is some <span style="​color:​red;​font-size:​150%;">​inline HTML</​span>​ </​html>​ <​HTML>​ <p style="​border:​2px dashed red;">​And this is some block HTML</​p>​ </​HTML>​
-This is some <span style="​color:​red;​font-size:​150%;">​inline HTML</​span>​ +
-</​html>​ +
-<​HTML>​ +
-<p style="​border:​2px dashed red;">​And this is some block HTML</​p>​ +
-</​HTML>​+
  
 PHP example: PHP example:
Line 475: Line 524:
 </​code>​ </​code>​
  
-<php> +<php> echo 'The PHP version: '; echo phpversion();​ echo ' (inline HTML)';​ </​php>​ <PHP> echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ echo '<​td>'​.phpversion().'</​td>';​ echo '</​tr></​table>';​ </​PHP>​
-echo 'The PHP version: '; +
-echo phpversion();​ +
-echo ' (inline HTML)';​ +
-</​php>​ +
-<PHP> +
-echo '<​table class="​inline"><​tr><​td>​The same, but inside a block level element:</​td>';​ +
-echo '<​td>'​.phpversion().'</​td>';​ +
-echo '</​tr></​table>';​ +
-</​PHP>​+
  
 **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed. **Please Note**: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
  
 ===== RSS/ATOM Feed Aggregation ===== ===== RSS/ATOM Feed Aggregation =====
-[[DokuWiki]] can integrate data from external XML feeds. For parsing the XML feeds, [[http://​simplepie.org/​|SimplePie]] is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters: 
  
-^ Parameter ​ ^ Description ^ +[[:wiki:​dokuwiki|DokuWiki]] can integrate data from external XML feeds. For parsing ​the XML feeds, [[http://simplepie.org/|SimplePie]] is usedAll formats understood by SimplePie can be used in DokuWiki as wellYou can influence the rendering by multiple additional space separated parameters:
-| any number | will be used as maximum number items to show, defaults to 8 | +
-| reverse ​   | display the last items in the feed first | +
-| author ​    | show item authors names | +
-| date       | show item dates | +
-| description| show the item description. If [[doku>​config:htmlok|HTML]] is disabled all tags will be stripped | +
-| nosort ​    | do not sort the items in the feed | +
-//n//[dhm| refresh period, where d=days, h=hours, m=minutes(e.g. 12h = 12 hours). |+
  
-The refresh period defaults to 4 hours. Any value below 10 minutes ​will be treated ​as 10 minutes. [[wiki:​DokuWiki]] will generally try to supply a cached version of a pageobviously this is inappropriate when the page contains dynamic external contentThe parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.+^Parameter ​ ^Description| 
 +|any number|will be used as maximum number items to showdefaults to 8| 
 +|reverse ​ |display the last items in the feed first| 
 +|author ​ |show item authors names| 
 +|date  |show item dates| 
 +|description|show ​the item descriptionIf [[doku>​config:htmlok|HTML]] is disabled all tags will be stripped| 
 +|nosort ​ |do not sort the items in the feed| 
 +|//n// [dhm]|refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours).|
  
-By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''​reverse''​ parameter, or display the feed as is with ''​nosort''​.+The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[:​wiki:​dokuwiki|DokuWiki]] will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[:​wiki:​dokuwiki|DokuWiki]] to re-render the page if it is more than //refresh period// ​ since the page was last rendered. 
 + 
 +By default the feed will be sorted by date, newest items first. You can sort it by oldest first using the ''​reverse'' ​ parameter, or display the feed as is with ''​nosort''​.
  
 **Example:​** **Example:​**
  
-  ​{{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}+<​code>​ 
 +{{rss>​http://​slashdot.org/​index.rss 5 author date 1h }} 
 +</​code>​
  
 {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }} {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}
- 
  
 ===== Control Macros ===== ===== Control Macros =====
Line 515: Line 557:
 Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
  
-^ Macro           ​^ Description | +^Macro ​ ^Description| 
-%%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created | +|<​nowiki>​~~NOTOC~~ ​</​nowiki>  ​|If this macro is found on the page, no table of contents will be created| 
-%%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the %%<php>%% syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |+|<​nowiki>​~~NOCACHE~~ ​</​nowiki>​|DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <​nowiki>​<php></​nowiki> ​syntax above is used), adding this macro will force DokuWiki to rerender a page on every call|
  
 ===== Syntax Plugins ===== ===== Syntax Plugins =====
Line 524: Line 566:
  
 ~~INFO:​syntaxplugins~~ ~~INFO:​syntaxplugins~~
 +
 +
 +