faq-database.de

User Tools

Site Tools

Trace:
en:wiki:syntax

Differences

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

Link to this comparison view

Next revision		Previous revision
en:wiki:syntax [2024/02/08 08:02] – created - external edit 127.0.0.1en:wiki:syntax [2026/08/03 19:10] (current) – Automatic push translation domele
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 designed to make the data files as readable as possible. This page lists all the syntax you can use when editing pages. Simply view the source of this page by clicking ‘Edit this page’. If you want to try something out, just use the [[playground:playground|playground page at]]. The simpler markup is also easily accessible via [[doku>toolbar|quick buttons]] as well.
  
 ===== 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'' text. Of course, you can **__//''combine''//__** all of these.
  
-  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. +  DokuWiki supports **bold**, //italics//, __underlined__ and ''monospaced'' text. 
-  Of course you can **__//''combine''//__** all these.+  Of course you can **__//''combine''//__** all of these.
  
-You can use <sub>subscript</sub> and <sup>superscript</sup>, too.+Note that the formatting markers must directly enclose the text, so ''%%** bold **%%'' with spaces inside the markers will not be formatted. 
 + 
 +You can use <sub>subscript</sub> and <sup>superscript</sup>as well.
  
   You can use <sub>subscript</sub> and <sup>superscript</sup>, too.   You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
Line 18: Line 20:
   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, 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 creating a new paragraph, you can use two backslashes followed by a space or the end of the line.
  
-This is some text with some linebreaks\\ Note that the +This is some text with some line breaks\\ Note that the 
-two backslashes are only recognized at the end of a line\\ +two backslashes are only recognised at the end of a line\\ 
-or followed by\\ a whitespace \\this happens without it.+or when followed by\\ a space \\this happens without it.
  
-  This is some text with some linebreaks\\ Note that the +  This is some text with some line breaks\\ Note that the 
-  two backslashes are only recognized at the end of a line\\+  two backslashes are only recognised at the end of a line\\
   or followed by\\ a whitespace \\this happens without it.   or followed by\\ a whitespace \\this happens without it.
  
-You should use forced newlines only if really needed.+You should only use forced line breaks if absolutely necessary.
  
 ===== Links ===== ===== Links =====
  
-DokuWiki supports multiple ways of creating links.+DokuWiki supports several ways of creating links.
  
 ==== 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: <[email protected]> are recognized, too.+External links are recognised automatically: http://www.google.com or simply www.google.com – You can also set the link text: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <[email protected]> are recognised, too.
  
-  DokuWiki supports multiple ways of creating links. External links are recognized +  DokuWiki supports multiple ways of creating links. External links are recognised 
-  automagically: http://www.google.com or simply www.google.com - You can set +  automatically: http://www.google.com or simply www.google.com – You can set 
-  link text as well: [[http://www.google.com|This Link points to google]]. Email +  the link text as well: [[http://www.google.com|This The link points to google]]. Email 
-  addresses like this one: <[email protected]> are recognized, too.+  addresses like this one: <[email protected]> are recognised as well.
  
 ==== 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 using square brackets. You can either simply provide a [[de:wiki:pagename]] or use an additional [[de:wiki:pagename|link text]].
  
-  Internal links are created by using square brackets. You can either just give +  Internal links are created using square brackets. You can either simply provide 
-  a [[pagename]] or use an additional [[pagename|link text]].+  a [[de:wiki:pagename]] or use an additional [[de:wiki:pagename|link text]].
  
-[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.+[[doku>pagename|Wiki page names]] are automatically converted to lower case; special characters are not permitted.
  
-You can use [[some:namespaces]] by using a colon in the pagename.+You can use [[some:namespaces]] by including a colon in the page name.
  
-  You can use [[some:namespaces]] by using a colon in the pagename.+  You can use [[some:namespaces]] by including a colon in the page name.
  
-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]].+It is also possible to link to a specific section. Simply add the section name after a hash symbol, as is standard in HTML. This links to [[de:wiki:syntax#internal|this section]].
  
-  This links to [[syntax#internal|this Section]].+  This links to [[de:wiki:syntax#internal|this section]].
  
 Notes: Notes:
  
-  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones. +  * Links to [[de:wiki:syntax|existing pages]] are displayed in a different style from [[de: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 behaviour can be enabled in the [[doku>config]] file. Tip: If ‘DokuWiki’ is a link, then it is 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 as well. So do not rely too heavily on section linking.
  
 ==== 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. +  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]].+  For example, this is a link to Wikipedia’s page about wikis: [[wp>Wiki]] .
  
-==== 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 such as [[\\server\share|this]] are recognised as well. Please note that these are only useful in a homogeneous user group such as a corporate [[wp>Intranet]] .
  
-  Windows Shares like [[\\server\share|this]] are recognized, too.+  Windows shares such as [[\\server\share|this]] are recognised as well.
  
 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 by 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, this can be enabled via various workarounds mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, a JavaScript warning will still appear when attempting to open a Windows share. To remove this warning (for all users), add the following line to ''conf/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localisation]]): <code - conf/lang/en/lang.php>
 <?php <?php
 /** /**
Line 95: Line 97:
 ==== Image Links ==== ==== Image Links ====
  
-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 [[de:wiki:syntax#images_and_other_files|images]] (see below) as follows:
  
   [[http://php.net|{{wiki:dokuwiki-128.png}}]]   [[http://php.net|{{wiki:dokuwiki-128.png}}]]
Line 101: Line 103:
 [[http://php.net|{{wiki:dokuwiki-128.png}}]] [[http://php.net|{{wiki:dokuwiki-128.png}}]]
  
-Please note: The image formatting is the only formatting syntax accepted in link names.+Please note: Image formatting is the only formatting syntax accepted in link names.
  
-The whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).+The entire [[de:wiki:syntax#images_and_other_files|image]] and [[de:wiki:syntax#links|link]] syntax is supported (including image resizing, internal and external images and URLs, and interwiki links).
  
 ===== Footnotes ===== ===== Footnotes =====
Line 113: Line 115:
 ===== 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 headings to structure your content. If you have more than three headings, a table of contents is generated automatically — this can be disabled by including the string ''<nowiki>~~NOTOC~~</nowiki>'' in the document.
  
-==== Headline Level 3 ==== +==== Heading Level 3 ==== 
-=== Headline Level 4 === +=== Heading Level 4 === 
-== Headline Level 5 ==+== Heading Level 5 ==
  
-  ==== Headline Level 3 ==== + ==== Heading Level 3 ==== 
-  === Headline Level 4 === + === Heading Level 4 === 
-  == Headline Level 5 ==+ == Heading Level 5 ==
  
-By using four or more dashes, you can make a horizontal line:+By using four or more dashes, you can create a horizontal line:
  
 ---- ----
Line 129: Line 131:
 ===== Media Files ===== ===== Media Files =====
  
-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]] using curly brackets. You can optionally specify their size.
  
-Real size:                        {{wiki:dokuwiki-128.png}}+Actual size:                       {{wiki:dokuwiki-128.png }} 
  
-Resize to given width:            {{wiki:dokuwiki-128.png?50}}+Resize to a specified 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 specified width and height (if the aspect ratio of the specified width and height does not match that of the image, it will be cropped to the new ratio before resizing): {{wiki:dokuwiki-128.png?200x50}} 
  
 Resized external image:           {{https://www.php.net/images/php.gif?200x50}} Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
-  Real size:                        {{wiki:dokuwiki-128.png}} +  Actual size:                       {{wiki:dokuwiki-128.png }}  
-  Resize to given width:            {{wiki:dokuwiki-128.png?50}} +  Resize to specified width:           {{wiki:dokuwiki-128.png?50 }}  
-  Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}}+  Resize to specified width and height: {{wiki:dokuwiki-128.png?200x50}} 
   Resized external image:           {{https://www.php.net/images/php.gif?200x50}}   Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
  
  
-By using left or right whitespaces you can choose the alignment.+You can choose the alignment by using left or right whitespace.
  
-{{ wiki:dokuwiki-128.png}}+{{ wiki:dokuwiki-128.png}} 
  
-{{wiki:dokuwiki-128.png }}+{{wiki:dokuwiki-128.png }} 
  
-{{ wiki:dokuwiki-128.png }}+{{ wiki:dokuwiki-128.png }} 
  
-  {{ wiki:dokuwiki-128.png}} + {{ wiki:dokuwiki-128.png }}  
-  {{wiki:dokuwiki-128.png }} + {{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.+You can also set the alignment explicitly using a ''?left'', ''?right'' or ''?center'' parameter. This takes precedence over the whitespace alignment mentioned above and can be combined with a size. 
 +{{wiki:dokuwiki-128.png?100&right}} {{wiki:dokuwiki-128.png?100&right }}  
 +Of course, you can add a title (displayed as a tooltip by most browsers) as well.
  
 {{ wiki:dokuwiki-128.png |This is the caption}} {{ wiki:dokuwiki-128.png |This is the caption}}
Line 163: Line 167:
   {{ wiki:dokuwiki-128.png |This is the caption}}   {{ wiki:dokuwiki-128.png |This is the caption}}
  
-For linking an image to another page see [[#Image Links]] above.+To link an image to another page, see [[de:wiki:syntax#Image Links]] above.
  
 ==== Supported Media Formats ==== ==== Supported Media Formats ====
Line 170: Line 174:
  
 | 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, 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}}+ {{wiki:dokuwiki-128.png?linkonly }} 
  
 {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image. {{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image.
Line 184: Line 188:
 ==== Fallback Formats ==== ==== Fallback Formats ====
  
-Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.+Unfortunately, not all browsers support all video and audio formats. To minimise this issue, you can upload your file in different formats to ensure maximum browser compatibility.
  
-For example consider this embedded mp4 video:+For example, consider this embedded MP4 video:
  
-  {{video.mp4|A funny video}}+  {{de:wiki:video.mp4|A funny video}}
  
-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'' alongside the referenced ''video.mp4'', DokuWiki will automatically add them as alternatives so that one of the three files is recognised 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 displayed before the video starts. This image must 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 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.+
  
   * This is a list   * This is a list
   * The second item   * The second item
-    * You may have different levels+    * You can 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 indentation for deeper levels 
-  - That's it+  - That’s it
  
 <code> <code>
Line 220: Line 222:
 </code> </code>
  
-Also take a look at the [[doku>faq:lists|FAQ on list items]].+Also have a look at the [[doku>faq:lists|FAQ on list items]]. 
 +===== -to-text conversions =====
  
-===== Text Conversions =====+DokuWiki can convert certain pre-defined characters or strings into images, other text or HTML.
  
-DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.+The text-to-image conversion is mainly used for smileys. The text-to-HTML conversion is used for typographical replacements, but can be configured to use other HTML as well.
  
-The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.+==== Text-to-Image Conversions ====
  
-==== Text to Image Conversions ====+DokuWiki converts commonly used [[wp>emoticon]] s into their graphical equivalents. These [[doku>Smileys]] and other images can be configured and extended. Here is an overview of the 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-O %% 8-O  %% 
-  * 8-) %%  8-)  %% +  * :-( %% :-(  %% 
-  * 8-O %%  8-O  %% +  * :-) %% :-)  %% 
-  * :-( %%  :-(  %% +  * =)  %% = )   %% 
-  * :-) %%  :-)  %% +  * :-/ %% :-/  %% 
-  * =)  %%  =)   %% +  * :-\ %% :-\  %% 
-  * :-/ %%  :-/  %% +  * :-? %% :-?  %% 
-  * :-\ %%  :-\  %% +  * :-D %% :-D  %% 
-  * :-? %%  :-?  %% +  * :-P %% :-P  %% 
-  * :-D %%  :-D  %% +  * :-O %% :-O  %% 
-  * :-P %%  :-P  %% +  * :-X %% :-X  %%
-  * :-O %%  :-O  %% +
-  * :-X %%  :-X  %%+
   * :-| %%  :-|  %%   * :-| %%  :-|  %%
-  * ;-) %%  ;-)  %%+  * ;-) %% ;-)  %%
   * ^_^ %%  ^_^  %%   * ^_^ %%  ^_^  %%
-  * m(  %%  m(   %% +  * m( %% m(   %% 
-  * :?: %%  :?:  %% +  * :?: %% :?:  %% 
-  * :!: %%  :!:  %% +  * :!: %% :!:  %% 
-  * LOL %%  LOL  %% +  * LOL %% LOL  %% 
-  * FIXME %%  FIXME %%+  * FIXME %% FIXME %%
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
 ==== 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: [[de:wiki:dokuwiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognised characters.
  
--> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)+-> <- <->=> <= <=> >> << -- --- 640x480 (c) (tm) (r)
 "He thought 'It's a man's world'..." "He thought 'It's a man's world'..."
  
Line 266: Line 267:
 </code> </code>
  
-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 simply 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 that do not originate from that pattern file: the multiplication entity (640x480), ‘single’ and “double quotes”. These can be disabled via a [[doku>config:typography|config option]].
 ===== Quoting ===== ===== Quoting =====
  
-Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:+Sometimes you want to mark text to show that it is a reply or comment. You can use the following syntax:
  
 <code> <code>
Line 290: Line 290:
 I think we should do it I think we should do it
  
-> No we shouldn't+> No, we shouldn’t
  
 >> Well, I say we should >> Well, I say we should
Line 298: Line 298:
 >> Yes! >> Yes!
  
->>> Then lets do it!+>>> Then let’s do it!
  
 ===== Tables ===== ===== Tables =====
  
-DokuWiki supports a simple syntax to create tables.+DokuWiki supports a simple syntax for creating tables.
  
 ^ 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        |+
  
-Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.+Table rows must begin 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, simply leave the next cell completely empty, as shown above. Make sure you always use the same number of cell separators!
  
-Vertical tableheaders are possible, too.+Vertical table headers are also possible.
  
 |              ^ 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, Column 3        |
  
-As you can see, it's the cell separator before a cell which decides about the formatting:+As you can see, it is the cell separator preceding a cell that determines 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, Column 3        |
- +
-You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.+
  
 +You can create rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should be connected.
 ^ 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        |
Line 339: Line 337:
 | Row 3 Col 1    | :::                        | Row 2 Col 3        | | Row 3 Col 1    | :::                        | Row 2 Col 3        |
  
-Apart from the rowspan syntax those cells should not contain anything else.+Apart from the rowspan syntax, these cells should not contain anything else.
  
   ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^   ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
Line 346: Line 344:
   | 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 also align the table contents. Simply add at least two spaces at the opposite end of your text: add two spaces on the left to align to the right, two spaces on the right to align to the left, and at least two spaces at both ends for centred text.
  
 ^           Table with alignment           ^^^ ^           Table with alignment           ^^^
-|         right|    center    |left          | +|         right|    centre    |left          | 
-|left          |         right|    center    |+|left          |         right|    centre    |
 | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
Line 356: Line 354:
  
   ^           Table with alignment           ^^^   ^           Table with alignment           ^^^
-  |         right|    center    |left          | +  |         right|    centre    |left          | 
-  |left          |         right|    center    |+  |left          |         right|    centre    |
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
Line 364: Line 362:
 ===== 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 as it is typed (without any formatting), enclose the area either with ''%%<nowiki>%%'' tags or, even more simply, with double per cent signs ''<nowiki>%%</nowiki>''.
  
 <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 applies to %%//__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 applies to %%//__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 in your documents either by indenting them by at least two spaces (as used in 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.
Line 390: Line 387:
 </file> </file>
  
-Those blocks were created by this source:+These blocks were created from this source:
  
-    This is text is indented by two spaces.+    This text is indented by two spaces.
  
   <code>   <code>
Line 404: Line 401:
 ==== 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]] can highlight source code, making 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 436: Line 433:
 </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 do not want any highlighting but would like a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
  
 ===== 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:+[[de:wiki:dokuwiki]] can integrate data from external XML feeds. To parse the XML feeds, [[http://simplepie.org/|SimplePie]] is used. All formats supported by SimplePie can also be used in DokuWiki. You can customise the rendering using several additional space-separated parameters:
  
 ^ Parameter  ^ Description ^ ^ Parameter  ^ Description ^
-| any number | will be used as maximum number items to show, defaults to 8 | +| any number | will be used as the maximum number of items to display; defaults to 8 | 
-| reverse    | display the last items in the feed first | +| reverse    | display the most recent items in the feed first | 
-| author     | show item authors names |+| author     | show item authors’ names |
 | date       | show item dates | | date       | show item dates |
 | description| show the item description. All HTML tags will be stripped | | description| show the item description. All HTML tags will be stripped |
Line 450: Line 447:
 | //n//[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). | | //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 page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells [[wiki:DokuWiki]] to re-render the page if it is more than //refresh period// since the page was last rendered.+The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. [[wiki:dokuwiki]] will generally attempt to serve a cached version of a page; obviously, this is inappropriate when the page contains dynamic external content. The parameter instructs [[wiki:dokuwiki]] to re-render the page if it is more than //refresh period// has elapsed 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''.+By default, the feed will be sorted by date, with the newest items first. You can sort it with the oldest items first using the ''reverse'' parameter, or display the feed as it is with ''nosort''.
  
 **Example:** **Example:**
Line 463: Line 460:
 ===== Control Macros ===== ===== Control Macros =====
  
-Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:+Some syntax affects how DokuWiki renders a page without generating any output itself. The following control macros are available:
  
 ^ Macro           ^ Description | ^ Macro           ^ Description |
 | %%~~NOTOC~~%%   | If this macro is found on the page, no table of contents will be created | | %%~~NOTOC~~%%   | 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 |+| %%~~NOCACHE~~%% | DokuWiki caches all output by default. Sometimes this may not be desired (e.g. when the %%<php>%% syntax above is used); adding this macro will force DokuWiki to re-render a page on every call |
  
 ===== Syntax Plugins ===== ===== Syntax Plugins =====
  
-DokuWiki's syntax can be extended by [[doku>plugins|Plugins]]. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation:+DokuWiki’s syntax can be extended by [[doku>plugins|plugins]]. How the installed plugins are used is described on their respective description pages. The following syntax plugins are available in this particular DokuWiki installation:
  
 ~~INFO:syntaxplugins~~ ~~INFO:syntaxplugins~~
  
en/wiki/syntax.1707379326.txt.gz · Last modified: by 127.0.0.1