Differences

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

Link to this comparison view

Next revision
Previous revision
wiki:syntax [2009/02/14 04:13]
127.0.0.1 external edit
wiki:syntax [2015/03/19 12:29] (current)
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 ​the //Edit this page// button at the top or bottom of the 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|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.
Line 50: Line 50:
   a [[pagename]] or use an additional [[pagename|link text]].   a [[pagename]] or use an additional [[pagename|link text]].
  
-[[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.
Line 74: Line 74:
   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 ====
Line 85: Line 84:
  
   * 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 the config option ​[[http://www.mozilla.org/quality/​networking/​docs/​netprefs.html#​file|security.checkloaduri]] but this is not recommended+  * 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'':​ 
-  ​* See [[dokubug>​151]] for more info.+ 
 +  ​LANG.nosmblinks = '';​
  
 ==== Image Links ==== ==== Image Links ====
Line 122: Line 122:
 ---- ----
  
-===== Images and other files =====+===== Media Files =====
  
-You can include external and internal [[doku>​images]] 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}}
Line 157: Line 157:
  
   {{ wiki:​dokuwiki-128.png |This is the caption}}   {{ wiki:​dokuwiki-128.png |This is the caption}}
- 
-If you specify a 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]] above. For linking an image to another page see [[#Image Links]] above.
 +
 +==== Supported Media Formats ====
 +
 +DokuWiki can embed the following media formats directly.
 +
 +| 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.
 +
 +==== 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.
 +
 +For example consider this embedded mp4 video:
 +
 +  {{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.
 +
 +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 =====
Line 188: Line 209:
 </​code>​ </​code>​
  
-===== Smileys ​=====+Also take a look at the [[doku>​faq:​lists|FAQ on list items]]. 
 + 
 +===== Text Conversions ​===== 
 + 
 +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. 
 + 
 +==== Text to Image Conversions ​====
  
-DokuWiki converts commonly used [[wp>​emoticon]]s to their graphical equivalents. ​More smileys ​can be placed in the ''​smiley''​ directory ​and configured in the ''​conf/​smileys.conf''​ file. 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-) %%  8-)  %%
Line 196: Line 225:
   * :-( %%  :-(  %%   * :-( %%  :-(  %%
   * :-) %%  :-)  %%   * :-) %%  :-)  %%
- 
   * =)  %%  =)   %%   * =)  %%  =)   %%
   * :-/ %%  :-/  %%   * :-/ %%  :-/  %%
Line 214: Line 242:
   * DELETEME %% DELETEME %%   * DELETEME %% DELETEME %%
  
-===== Typography =====+==== Text to HTML Conversions ​====
  
-[[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.+Typography: ​[[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
  
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
Line 226: Line 254:
 </​code>​ </​code>​
  
-Please noteThese conversions ​can be turned off through a [[doku>​config:​typography|config option]] and a [[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 filemultiplication entity (640x480), '​single'​ and "​double quotes"​. They can be turned off through a [[doku>​config:​typography|config option]].
  
 ===== Quoting ===== ===== Quoting =====
Line 258: Line 288:
 ===== Tables ===== ===== Tables =====
  
-DokuWiki supports a simple syntax to create tables. ​+DokuWiki supports a simple syntax to create 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 Col 2     | Row Col 3        |+| Row 3 Col 1    | Row Col 2     | Row Col 3        |
  
 Table rows have to start and end with a ''​|''​ for normal rows or a ''​^''​ for headers. Table rows have to start and end with a ''​|''​ for normal rows or a ''​^''​ for headers.
Line 270: Line 300:
   | 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 Col 2     | Row Col 3        |+  | Row 3 Col 1    | Row Col 2     | Row 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 288: Line 318:
   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |   ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
  
-NoteVertical ​spans (rowspan) are not possible.+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. 
 + 
 +  ^ 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.
Line 304: Line 346:
   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |   | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
  
-===== Non-parsed ​Blocks =====+Note: Vertical alignment is not supported. 
 + 
 +===== 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>''​. 
 + 
 +<​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 ;-)%%. 
 + 
 +  <​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 ===== 
 + 
 +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 non-parsed 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>​ <​code>​
Line 313: Line 373:
  
 <​file>​ <​file>​
-This is pretty much the same, but you could use it to show that you quoted a file.  +This is pretty much the same, but you could use it to show that you quoted a file.
 </​file>​ </​file>​
  
-To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with ''​nowiki''​ tags or even simpler, with double percent signs ''<​nowiki>​%%</​nowiki>''​.+Those blocks were created by this source:
  
-<​nowiki>​ +    ​This is text is indented by two spaces.
-This is some text which contains addresses like this: http://​www.splitbrain.org and **formatting**,​ but nothing ​is done with it. +
-</​nowiki>​+
  
-See the source of this page to see how to use these blocks.+  <​code>​ 
 +  This is preformatted code all spaces are preserved: like              <-this 
 +  </​code>​
  
-===== Syntax Highlighting =====+  <​file>​ 
 +  This is pretty much the same, but you could use it to show that you quoted a file. 
 +  </​file>​
  
-[[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 ​is the same like in the code block in the previous section, but this time the name of the used language is inserted ​inside the tag. Eg. ''<​nowiki><​code java></​nowiki>''​.+==== 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>''​.
  
 <code java> <code java>
-/** +/**
  * The HelloWorldApp class implements an application that  * The HelloWorldApp class implements an application that
  * simply displays "Hello World!"​ to the standard output.  * simply displays "Hello World!"​ to the standard output.
Line 340: Line 404:
 </​code>​ </​code>​
  
-The following language strings are currently recognized: //abap, actionscript-french,​ actionscript,​ actionscript3,​ ada, apache, applescript,​ asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cobol, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, html, idl, ini, inno, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, lotusformulas,​ lotusscript,​ lua, m68k, matlab, mirc, mpasm, mxml, mysql, nsis, objc, ocaml-brief,​ ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, pic16, plsql, povray, powershell, progress, python, qbasic, rails, reg, robots, ruby, sas, scala, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, visualfoxpro,​ winbatch, xml, xorg_conf, xpp, z80//+The following language strings are currently recognized: //4cs, 6502acme, 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//
  
 +==== Downloadable Code Blocks ====
  
-===== RSS/ATOM Feed Aggregation ===== +When you use the ''​%%<​code>​%%''​ or ''​%%<​file>​%%''​ syntax as aboveyou 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:
-[[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 ^ +<​code>​ 
-| any number | will be used as maximum number items to show, defaults to 8 | +<file php myexample.php>​ 
-| reverse ​   | display the last items in the feed first | +<?php echo "hello world!";​ ?> 
-| author ​    | show item authors names | +</file
-| date       | show item dates | +</code>
-| 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). |+
  
-The refresh period defaults to 4 hoursAny 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.+<file php myexample.php> 
 +<?php echo "hello world!";​ ?> 
 +</file>
  
-**Example:**+If you don't want any highlighting but want a downloadable file, specify a dash (''​-''​) as the language code''​%%<​code - myfile.foo>​%%''​.
  
-  {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }} 
  
-{{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}+===== 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.)
  
-===== Embedding ​HTML and PHP =====+HTML example:
  
-You can embed raw HTML or PHP code into your documents by using the ''​html''​ or ''​php''​ tags like this: 
 <​code>​ <​code>​
 <​html>​ <​html>​
Line 381: Line 444:
 <p style="​border:​2px dashed red;">​And this is some block HTML</​p>​ <p style="​border:​2px dashed red;">​And this is some block HTML</​p>​
 </​HTML>​ </​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>​
Line 396: Line 461:
  
 <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 '​(inline HTML)';​+echo ' (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>​
  
 **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 =====
 +[[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 |
 +| //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.
 +
 +**Example:​**
 +
 +  {{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}
 +
 +{{rss>​http://​slashdot.org/​index.rss 5 author date 1h }}
 +
  
 ===== Control Macros ===== ===== Control Macros =====