wiki:syntax

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Les deux révisions précédentes Révision précédente
Prochaine révision
Révision précédente
wiki:syntax [12/11/2013 16:26]
heuzef
wiki:syntax [29/07/2020 11:35] (Version actuelle)
Ligne 1: Ligne 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|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. +
  
 ===== 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. +  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. 
-<code> +  Of course you can **__//''combine''//__** all these.
-DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. +
-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.+  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
  
 +You can mark something as <del>deleted</del> as well.
  
-<code> +  You can mark something as <del>deleted</del> as well.
-You can use <sub>subscript</sub> and <sup>superscript</sup> , too. +
-</code> +
- +
- +
-You can mark something as <del>deleted</del>as well. +
- +
- +
-<code> +
-You can mark something as deleted 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
 +two backslashes are only recognized at the end of a line\\
 +or followed by\\ a whitespace \\this happens without it.
  
-This is some text with some linebreaks\\  +  This is some text with some linebreaks\\ Note that the 
-Note that the two backslashes are only recognized at the end of a line\\  +  two backslashes are only recognized at the end of a line\\ 
-or followed by\\  +  or followed by\\ a whitespace \\this happens without it.
-a whitespace %this happens without it. +
- +
- +
-<code> +
-This is some text with some linebreaks\\  +
-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.
- 
  
 ===== Links ===== ===== Links =====
- 
  
 DokuWiki supports multiple ways of creating links. DokuWiki supports multiple 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: <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 
- +  automagically: 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 
-<code> +  addresses like this one: <andi@splitbrain.org> are recognized, too.
-DokuWiki supports multiple ways of creating links. External links are recognized +
-automagically: 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 +
-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|pagename]] or use an additional [[:wiki: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> +
-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|namespaces]] by using a colon in the pagename. 
- 
- 
-<code> 
 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.
  
-For details about namespaces see [[doku>namespaces|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|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|CamelCase]] to automatically create links by default, but this behavior can be enabled in the [[doku>config|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|Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki|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> +
-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|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/userscript.js'': +  * 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
- +<?php 
- +/** 
-<code> + * Customization of the english language file 
-LANG.nosmblinks = '';+ * Copy only the strings that needs to be modified 
 + */ 
 +$lang['js']['nosmblinks'= '';
 </code> </code>
- 
  
 ==== 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 [[#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://www.php.net|{{wiki:dokuwiki-128.png}}]] +
-</code> +
- +
- +
-[[http://www.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.
- 
  
 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 whole [[#images_and_other_files|image]] and [[#links|link]] syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
- 
  
 ===== Footnotes ===== ===== Footnotes =====
  
- 
-You can add footnotes ((1)) by using double parentheses. 
- 
- 
-<code> 
 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.
  
 ===== 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:
- 
  
 ---- ----
  
 +===== Media Files =====
  
-===== Images and Other 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.
  
 +Real size:                        {{wiki:dokuwiki-128.png}}
  
-You can include external and internal [[doku>images|images]] with curly brackets. Optionally you can specify the size of them.+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}}
  
-Real size: {{:wiki:dokuwiki-128.png}}+Resized external image          {{https://secure.php.net/images/php.gif?200x50}}
  
 +  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:           {{https://secure.php.net/images/php.gif?200x50}}
  
-Resize to given width: {{:wiki:dokuwiki-128.png?50}} 
  
 +By using left or right whitespaces you can choose the alignment.
  
-Resize to given width and height((2))) : {{:wiki:dokuwiki-128.png?200x50}}+{{ wiki:dokuwiki-128.png}}
  
 +{{wiki:dokuwiki-128.png }}
  
-Resized external image: {{http://de3.php.net/images/php.gif?direct&200x50}}+{{ wiki:dokuwiki-128.png }}
  
 +  {{ wiki:dokuwiki-128.png}}
 +  {{wiki:dokuwiki-128.png }}
 +  {{ wiki:dokuwiki-128.png }}
  
-<code> +Of course, you can add a title (displayed as a tooltip by most browsers), too.
-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://de3.php.net/images/php.gif?200x50}} +
-</code>+
  
 +{{ wiki:dokuwiki-128.png |This is the caption}}
  
-By using left or right whitespaces you can choose the alignment.+  {{ wiki:dokuwiki-128.png |This is the caption}}
  
 +For linking an image to another page see [[#Image Links]] above.
  
-{{  :wiki:dokuwiki-128.png}}+==== Supported Media Formats ====
  
 +DokuWiki can embed the following media formats directly.
  
-{{:wiki:dokuwiki-128.png  }}+| Image | ''gif'', ''jpg'', ''png''  
 +| Video | ''webm'', ''ogv'', ''mp4''
 +| Audio | ''ogg'', ''mp3'', ''wav'' 
 +| Flash | ''swf''                    |
  
 +If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
  
-{{  :wiki:dokuwiki-128.png  }}+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}} This is just a link to the image.
-{{ wiki:dokuwiki-128.png}} +
-{{wiki:dokuwiki-128.png }} +
-{{ wiki:dokuwiki-128.png }} +
-</code>+
  
 +==== Fallback Formats ====
  
-Of course, you can add a title (displayed as a tooltip by most browsers), too.+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.
  
 +For example consider this embedded mp4 video:
  
-{{  :wiki:dokuwiki-128.png  }}+  {{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.
  
-<code> +Additionally DokuWiki supports "poster" image which will be shown before the video has startedThat 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.
-{{ wiki:dokuwiki-128.png |This is the caption}} +
-</code> +
- +
- +
-If you specify filename (external or internal) that is not an image (''gif, jpeg, png''), then it will be displayed as a link instead. +
- +
- +
-For linking an image to another page see [[#image_links|Image Links]] above. +
  
 ===== 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
- 
  
 <code> <code>
Ligne 299: Ligne 219:
   - That's it   - That's it
 </code> </code>
- 
  
 Also take a look at the [[doku>faq:lists|FAQ on list items]]. Also take a look at the [[doku>faq:lists|FAQ on list items]].
- 
  
 ===== Text Conversions ===== ===== Text Conversions =====
- 
  
 DokuWiki can convert certain pre-defined characters or strings into images or 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 done for smileys. And the text to HTML conversion is used for typography 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 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|emoticon]]s to their graphical equivalents. Those [[doku>Smileys|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-) <nowiki> 8-) </nowiki> +  * :-) %%  :-)  %% 
-  * 8-O <nowiki> 8-O </nowiki> +  * =)  %%  =)   %% 
-  * :-( <nowiki> :-( </nowiki> +  * :-/ %%  :-/  %% 
-  * :-) <nowiki> :-) </nowiki> +  * :-\ %%  :-\  %% 
-  * =) <nowiki> =) </nowiki> +  * :-? %%  :-?  %% 
-  * :-/ <nowiki> :-/ </nowiki> +  * :-D %%  :-D  %% 
-  * :-\" class= <nowiki> :-\ </nowiki> +  * :-P %%  :-P  %% 
-  * :-? <nowiki> :-? </nowiki> +  * :-O %%  :-O  %% 
-  * :-D <nowiki> :-D </nowiki> +  * :-X %%  :-X  %% 
-  * :-P <nowiki> :-P </nowiki> +  * :-| %%  :-|  %% 
-  * :-O <nowiki> :-O </nowiki> +  * ;-) %%  ;-)  %% 
-  * :-X <nowiki> :-X </nowiki> +  * ^_^ %%  ^_^  %% 
-  * :-| <nowiki> :-| </nowiki> +  * :?: %%  :?:  %% 
-  * ;-) <nowiki> ;-) </nowiki> +  * :!: %%  :!:  %% 
-  * ^_^ <nowiki> ^_^ </nowiki> +  * LOL %%  LOL  %% 
-  * :?: <nowiki> :?: </nowiki> +  * FIXME %%  FIXME %% 
-  * :!: <nowiki> :!: </nowiki> +  * DELETEME %% DELETEME %%
-  * LOL <nowiki> LOL </nowiki> +
-  * FIXME <nowiki> FIXME </nowiki> +
-  * 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) 
- +"He thought 'It's a man's world'..."
- +
-→ <- <→  <= < >> << – — 640×480 ©  ® "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>
- 
  
 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 =====
- 
  
 Some times you want to mark some text to show it's a reply or comment. You can use the following syntax: Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
- 
  
 <code> <code>
 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
 +
 > Really? > Really?
 +
 >> Yes! >> Yes!
 +
 >>> Then lets do it! >>> Then lets do it!
 </code> </code>
- 
  
 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
  
- +Really?
-Really? +
  
 >> Yes! >> Yes!
- 
  
 >>> Then lets do it! >>> Then lets do it!
- 
  
 ===== Tables ===== ===== Tables =====
- 
  
 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!
- 
  
 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's the cell separator before a cell which decides about the formatting:
  
-You can have rowspans (vertically connected cells) by adding '':::''  into the cells below the one to which they should connect.+  |              ^ 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        |
  
 +You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.
  
-^Heading 1 ^Heading 2 ^Heading 3 | 
-|Row 1 Col 1 |this cell spans vertically |Row 1 Col 3 | 
-|Row 2 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. 
- 
- 
-<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.
 +
 +  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
 +  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
 +  | Row 2 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.
  
- 
-^Table with alignment ^^^ 
-|right |center |left | 
-|left |right |center | 
-|xxxxxxxxxxxx |xxxxxxxxxxxx |xxxxxxxxxxxx | 
- 
- 
-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:
  
-Note: Vertical alignment is not supported.+  ^           Table with alignment           ^^^ 
 +  |         right|    center    |left          | 
 +  |left          |         right|    center    | 
 +  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
 +Note: Vertical alignment is not supported.
  
 ===== 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><nowiki></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 </nowiki>//__this__ text// with a smiley ;-)<nowiki>. +The same is true for %%//__this__ text// with a smiley ;-)%%.
-</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 ''</nowiki> +
- +
- +
-<code> +
-<nowiki>'' or ''</nowiki><file><nowiki>''.+
  
   This is text is indented by two spaces.   This is text is indented by two spaces.
Ligne 549: Ligne 417:
 </code> </code>
  
 +The following language strings are currently recognized: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic//
  
-The following language strings are currently recognized: //4cs6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic//  +There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlightingsuch as highlighting lines or adding line numbers.
  
 ==== 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 ''</nowiki>''<nowiki>'' or ''</nowiki><file><nowiki>'' 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> <file php myexample.php> <?php echo __GESHI_QUOT__hello world!__GESHI_QUOT__; ?> </file> </code> <file php myexample.php> <?php echo __GESHI_QUOT__hello world!__GESHI_QUOT__; ?> </file> 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 ===== You can embed raw HTML or PHP code into your documents by using the ''</nowiki><html><nowiki>'' or ''</nowiki><php>%%''  tags. (Use uppercase tags if you need to enclose block level elements.) '' +<code> 
 +<file php myexample.php> 
 +<?php echo "hello world!"; ?> 
 +</file> 
 +</code>
  
 +<file php myexample.php>
 +<?php echo "hello world!"; ?>
 +</file>
  
-''HTML example: '' +If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
  
  
-''<code> <html> This is some <span style=__GESHI_QUOT__color:red;font-size:150%;__GESHI_QUOT__>inline HTML</span> </html> <HTML> <p style=__GESHI_QUOT__border:2px dashed red;__GESHI_QUOT__>And this is some block HTML</p> </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>+===== 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.)
  
-PHP example:+HTML example:
  
 +<code>
 +<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>
 +</code>
 +
 +<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:
  
 <code> <code>
 <php> <php>
-echo 'A logo generated by PHP:'; +echo 'The PHP version: '; 
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'+echo phpversion(); 
-echo '(generated inline HTML)';+echo ' (generated inline HTML)';
 </php> </php>
 <PHP> <PHP>
 echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>';
-echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';+echo '<td>'.phpversion().'</td>';
 echo '</tr></table>'; echo '</tr></table>';
 </PHP> </PHP>
 </code> </code>
  
- +<php> 
-<php> echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(inline HTML)'; </php> <PHP> echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></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 ^
 +| 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). |
  
-[[:wiki:dokuwiki|DokuWiki]] can integrate data from external XML feedsFor 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:+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 contentThe parameter tells [[wiki: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''.
  
-^Parameter ^Description | +**Example:**
-|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 | +
-|//n// [dhm] |refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |+
  
 +  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  
-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. 
- 
- 
-**Example:**  
- 
- 
-<code> 
 {{rss>http://slashdot.org/index.rss 5 author date 1h }} {{rss>http://slashdot.org/index.rss 5 author date 1h }}
-</code> 
- 
- 
-{{rss>http://slashdot.org/index.rss 5 author date 1h }} ===== Control Macros ===== Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble: ^ Macro ^ Description |<nowiki> ~~NOTOC~~ </nowiki> | If this macro is found on the page, no table of contents will be created |<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 ===== 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: //  
- 
  
-//~~INFO:syntaxplugins~~ //  
  
 +===== Control Macros =====
  
-//<sup>[[1)]]</sup> This is footnote// +Some syntax influences how DokuWiki renders page without creating any output it self. The following control macros are availble:
  
 +^ Macro           ^ Description |
 +| %%~~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 |
  
-//<sup>[[2)]]</sup> 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// +===== 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:
  
-\\+~~INFO:syntaxplugins~~
  
  • wiki/syntax.1384269987.txt.gz
  • Dernière modification: 12/11/2013 16:26
  • de heuzef