DokuWiki is characterized by simple formatting. This will keep the files containing the content, easy to read. \ \

Describes the syntax to edit pages .

Look at the source of this page by selecting „edit this page“ press the button up or down. \ \ To try something, you can use the playground use. \ \ Simple formatting can be loan modification reached directly by QuickButtons in the „menu bar“ on the editor. \ \

===== ===== For translation

This page is a translation of the Syntax of DokuWiki (2005-07-13). \ \ It is not the same word translation. Some descriptions are down a little more detail. Technical terms are only used where a paraphrase more confusion than good. \ \ The same applies to terms that arise from the English, for some there is no direct translation. Or they are already so well known that a translation is nonsensical. \ \ The translator is not even sure if he should link building prefer to use the term „link“ or „reference“. \ \ In some places there is a - there is something that has been referred to the translator has not been well established.   * Suggestions, comments or references to errors are welcome.   * Your Sebastian Koch ⇒ mr_snede * at * dot ~ ~ web de

====== ====== 1 texts ===== ===== 1.1 formatting

DokuWiki supports bold , / / ​​italic / /, underlined andmonospacedtexts. Of course, everything be combined. \ \

  DokuWiki supports bold , / / ​​italic / /, underlined andmonospacedtexts.   Of course, everything be combined. You can use <sub> subscript </ sub> and <sup> superscript </ sup>, too.   You can use <sub> subscript </ sub> and <sup> superscript </ sup>, too. Text can be deleted as <del> deleted </ del> ¹⁾ Are marked.   Text can be deleted mark something as deleted </ del>. ===== ===== Paragraphs 1.2 Paragraphs are created from blank lines. \ \ <nowiki> A new line (carriage return) you can use two „backslash“ (backslash: \ \) followed generated </ nowiki> from a space \ \. This is some text with some linebreaks. \ \ Note that the two backslashes only be detected if they are at end of line \ \ or if \ \ a whitespace \ \ followed by how it looks without it.   This is some text with some linebreaks. \ \ Note that the two backslashes   only be detected if they are at end of line \ \   or if \ \ a whitespace \ \ followed by how it looks without it. Line breaks through two „backslash“ (backslash: \ \) should be used only when absolutely needed. ===== ===== 1.3 About fonts Structured with five different levels, separated by headings, the content of a page. \ \ The headings with a maximum of six „=“ framed, depending on size. H1 is the headline at the highest level. The easiest to use to generate the headlines, the toolbar and click on the buttonH1, H2H3or. It is sinnvoll whenever a Level 1 heading at the beginning of an article is available. If a page appear in more than three headlines, a table of contents is automatically created which lists all the headings. \ \ Contents of this should not be created, the command:be included <nowiki> NOTOC ~ ~ ~ ~ </ nowiki>with the page.   ====== ====== Heading level 1   ===== ===== Level 2 Headline   ==== Headline Level 3 ====   === Headline Level 4 ===   == Headline Level 5 == → Within headlines, no further formatting is done! ===== 1.4 unformatted Sections ===== To text to indicate how it was written, whether it contains DokuWiki formatting or other formatting, you can each Line with two spaces to begin (as it was used in this page) or use one of the identifiers „code“ or „file“: <code> With „code“: In this text, no extra spaces are removed, how here ← between </ Code> <file> With „file“: Actually, the same as above, just looks a little different. \ \ Perhaps in order to identify quotes or similar. </ File> To turn off any conversion by DokuWiki enclose the relevant area with „nowiki“ identifiers or shorter, with double percent signs <nowiki>''</ nowiki>''. <nowiki> This text contains links to: ** ** http://www.splitbrain.org and formatting, but they are not implemented and appear as normal text. </ Nowiki> Simply look at the source of this page (the button "edit" button) to see how these blocks are used. 1.5 ===== ===== Syntax Highlighting [[DokuWiki]] knows syntax highlighting for source code to increase its readability. For [[http://qbnz.com/highlighter/|GeSHi]] "** Ge neric ** ** ** S ** hi ** yntax ghlighter" is used. Thus, any programming language supported by GeSHi knows. \ \ It uses the same identifier as in the previous section, except that it now includes the name of the language: \ \ <nowiki>''<code Java> source </ code> </ nowiki>'' <code Java> / **  * The HelloWorldApp class implements application of that  * Simply displays "Hello World!" to the standard output.  * / class HelloWorldApp {     public static void main (String [] args) {         System.out.println ("Hello World!") / / Display the string     } } </ Code> It supports the following languages: \ \ / ActionScript / ActionScript FrenchPostcards, ada, apache, applescript, asm, asp, bash, caddcl, cadlisp, ** c **, c_mac, cpp, csharp, css, delphi * ** *, diff, d, div, dos, eiffel, FreeBasic, gml, html4strict, ini, inno, java ** **, javascript, lisp, lua, matlab, MPASM, nsis, objc, ocaml, ocaml-brief, oobas, Oracle8, pascal, perl, php-brief, php ** **, python, qbasic, scheme, sdlbasic, smarty, ** ** sql, ruby, vb, vbnet, vhdl, VisualFoxPro, ** xml ** / / 1.6 ===== quote / comment ===== To mark a text as a quote or comment, the "greater than" - uses character as follows:   I think we should do it.      'No, we should not.      >> Yes!      > Really?      >> Yes!      >>> Then let's do it!      >>> Comments or quotes can go over multiple lines, like this completely nonsensical text shows. To mark a text as a quote or comment, the "greater than" - characters used as follows I think we should do it 'No, we should not. >> Yes! > Really? >> Yes! >>> Then let's do it >>> Comments or quotes can go over multiple lines, like this completely nonsensical text shows. To quote as a text or comment mark, the "greater than" - characters used as follows ====== ====== 2 Links DokuWiki 5 different types of links are used: ===== ===== 2.1 External External links (links to other websites or files) are recognized automagically: http://www.google.com or simply www.google.com \ \ Referrals may also be hidden behind its own terms: [[http://www.google.com|This google]] \ \ E-mail addresses are enclosed in angle brackets: <andi@splitbrain.org>   External links are recognized automagically: http://www.google.com or simply www.google.com \ \   Referrals may also be hidden behind its own terms: [[http://www.google.com|This google]] \ \   E-mail addresses are enclosed in angle brackets: <andi@splitbrain.org> ===== ===== 2.2 Internal Internal links, ie links to pages are created by using, set in double brackets: \ \ [[Doku> wiki: pagename]] \ \ A link can also be hidden behind a term or description: \ \ [[Doku> wiki: pagename | Description for a link.]]   Internal links are placed in double square brackets:   [[Doku> wiki: pagename]]      A link can also be hidden behind a term or description:   [[Doku> wiki: pagename | Description for a link.]] File names for new pages in the wiki are automatically converted to lowercase! \ \ Umlauts are not equally as special characters are allowed! ([[Doku> namespaces | reference characters allowed in file names - english]]) A colon namespaces in the wiki are resolved: [[wiki: namespaces]]   A colon namespaces in the wiki are resolved: [[wiki: namespaces]] To name areas where further information: [[doku> wiki: namespaces]]. Notes:   * Links to [[wiki: syntax | existing pages]] are displayed differently than links to [[wiki: nonexistent]] pages.   * DokuWiki does not use default [[wp> CamelCase]] for links. Can [[doku> config]] but that will change: \ \ In the settings file. ** \ \ ** NOTE: If the word: DokuWiki is displayed as a link, then this option is turned on. ===== ===== 2.3 Interwiki DokuWiki supports links to other wikis, so-called [[doku> wiki: interwiki]] links. \ \ A link to Wikipedia's page about Wikis: [[wp> Wiki]]   DokuWiki supports links to other wikis, so-called [[doku> wiki: interwiki]] links. \ \   A link to Wikipedia's page about Wikis: [[wp> Wiki]] ===== ===== 2.4 Windows Shares Dokuwiki also links to Windows Shares like [[\ \ server \ share | shared folder.]] \ \ This only makes sense in a homogenous user group: [[wp> Intranet]].   Dokuwiki also links to Windows Shares like [[\ \ server \ share | this]]. Note:   * For security reasons direct browsing of works by the shares by default only works with Internet Explorer (... and only in the "local zone")!   * For Mozilla and Firefox it can through the [[# file http://www.mozilla.org/quality/networking/docs/netprefs.html | security.checkloaduri]] can be turned on, which is not recommended!   * Opera ingnoriert as a safety feature since [[http://www.opera.com/windows/changelogs/754/|Version 7:54]] all links to / / file: / / web pages.   * For more information see: [[bug> 151]] ===== ===== 2.5 pictures as links Images can be used for a link to another internal or external file. To the syntax for links is simply combined with the display of images (see below):    [[Http://www.php.net | {{wiki: dokuwiki-128.png}}]] [[Http://www.php.net | {{wiki: dokuwiki-128.png}}]] Please note: The image formatting is the only formatting syntax accepted in link names! ====== ====== 3 images and other files 3.1 Image ===== ===== install a dialog box The uploading of images must be turned on in the configuration file. In addition, the website operator by the function [[wiki: acl | ACL]] limit FIXME ===== ===== 3.2 Size of images With braces, both external and internal [[doku> images | Images]] are included. Optionally, whose size can be specified: Original size: {{wiki: dokuwiki-128.png}} Resize to given width: {{wiki: dokuwiki-128.png} 50?} Width and height: {{wiki: dokuwiki-128.png 200x50}?} Size for external image: {{}} http://de3.php.net/images/php.gif?200x50   Original size: {{wiki: dokuwiki-128.png}}   Resize to given width: {{wiki: dokuwiki-128.png} 50?}   Width and height: {{wiki: dokuwiki-128.png 200x50}?}   Size for external image: {{}} http://de3.php.net/images/php.gif?200x50 3.3 ===== ===== alignment of images With spaces to the right and / or left inside the brackets, an image can be aligned horizontally (left, center, right). {{Wiki: dokuwiki-128.png}} {{Wiki: dokuwiki-128.png}} {{Wiki: dokuwiki-128.png}}   {{Wiki: dokuwiki-128.png}}   {{Wiki:dokuwiki-128.png}}   {{Wiki: dokuwiki-128.png}} ===== ===== 3.4 Tooltips Title also appears in most browsers as a tooltip can be specified. {{Wiki: dokuwiki-128.png | This is the caption}}   {{Wiki: dokuwiki-128.png | This is the caption}} ===== ===== 3.5 File Download When a file is specified, no pictures (''gif, jpeg, png''), so it appears as a link instead to download. {{Wiki: dokuwiki-128.txt | Example}} ====== ====== 4 lists Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces. These spaces will follow a "*" for unordered or a "-" for numbered lists.   * This record is an unordered list   * The second item     * Different levels of a list by adding another 2 spaces   * Another item   - This is a list but   - A second entry     - Different levels of a list by adding another 2 spaces   - Another item <code>   * This record is an unordered list   * The second item     * Different levels of a list by adding another 2 spaces   * Another item   - This is a list but   - A second entry     - Different levels of a list by adding another 2 spaces   - Another item </ Code> ====== ====== 5 tables DokuWiki tables are created easily: ^ ^ ^ Heading to the example of a headline ^ | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | Row 2 Col 1 | double column width (note the double pipe) | | | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | Table rows have to start with "|" for normal rows or a "^" for headers.   ^ ^ ^ Heading For example, for ^ headline   | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |   | Row 2 Col 1 | double column width (note the double pipe) | |   | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 | To connect cells are generated, if, as shown above, at the end of such a column as many "|." Or "^" without spaces between consecutive sets, such as gaps to be bridged \ \ In short, all rows of a table have the same amount of cell separators "|" or "^" have. Highlighted fields in vertical orientation are also possible. | ^ Heading 1 ^ 2 ^ ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | ^ Heading 4 | Row 2 Col 2 | | ^ Heading 5 | Row 3 Col 2 | Row 3 Col 3 | As we see, it's the cell separator ("|" or "^") before a cell which decides about the formatting:   | ^ Heading 1 ^ 2 ^   ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 |   ^ Heading 4 | Row 2 Col 2 | |   ^ Heading 5 | Row 3 Col 2 | Row 3 Col 3 | Note: Vertical spans multiple lines are not supported.   * The contents of a cell can be oriented horizontally. Add two spaces added: \ \     * 2 spaces left of the text: right justified     * 2 spaces right of the text: left     * 2 spaces rinks and right centered text ^ ^ ^ ^ Table with alignment | Right | center | left | | Left | right | center | | Xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | Here's the format:   ^ ^ ^ ^ Table with alignment   | Right | center | left |   | Left | right | center |   | Xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | ====== ====== 6 Other formats ===== Footnotes ===== 6.1 Footnotes ((This is a footnote)) are represented by a double parenthesis ((a second footnote)). The text between the brackets will be posted at the bottom of the page. The order and thus the numbering does DokuWiki.   Footnotes ((This is a footnote)) are tracked by a double parenthesis shown ((a second footnote)) 6.2 ===== ===== horizontal line With four consecutive minus signs (alone in a row) can be generated horrizontal line: ---- <nowiki> ----</ nowiki> ===== ===== Smileys 6.3 DokuWiki converts commonly-used [[wp> emoticon]] s to small Smily-graphics. \ \ Additional graphics can Ordener Smiley "smily" folder and then registered in the file''conf / smileys.conf be''. \ \ Here is a list of default is included in DokuWiki Smileys: 8-) ^ ^ ^ 8-O :-) :-( ^ ^ =) ^: - / ^ - \ ^: -? ^: ^-D:-P ^: O ^: X ^ ^ :-| ;-) ^:: ^:: ^ ^ LOL FIXME ^ ^ DELETEME | 8-) | | | | |: - / | : - \ |: -? |: D |: P |: O | | :-| | ;-) |:: |?:: | | | DELETEME | and ^ _ ^ ^ _ ^%% ²⁾ ===== 6.4 ===== Typography DokuWiki can convert simple text characters to their typographically correct entities. \ \ Here is a list of all the characters like this are recognized: → ← ↔ ⇒ ⇐ ⇔» «- — 640×480 © ™ ® „He thought 'It's a man's world'…“ <code> → ← ↔ ⇒ ⇐ ⇔» «- — 640×480 © ™ ® „He thought 'It's a man's world'…“ </ Code> Please note: These conversions can be turned off in the configuration file 6.5 HTML and PHP ===== ===== In a side both HTML and PHP can be used directly: <html> This is some <font color=„red“ size=„+1“> HTML </ font> </ Html> <code> <html> This is some <font color=„red“ size=„+1“> HTML </ font> </ Html> </ Code> PHP or here: <php> echo 'A logo generated by PHP:'; echo '<img src = „'. $ _SERVER ['PHP_SELF']. '? ='. php_logo_guid (). '“ alt = „PHP Logo!“ /> '; </ Php> <code> <php> echo 'A logo generated by PHP:'; echo '<img src = „'. $ _SERVER ['PHP_SELF']. '? ='. php_logo_guid (). '“ alt = „PHP Logo!“ /> '; </ Php> </ Code> Caution : The integration of HTML and PHP embedding is disabled in the configuration file in a page. This done, the source of these sections will be displayed as text and not executed. Caution **: The integration of HTML and PHP is usually on one side of the Internet a serious security risk! This function is intended only for the intranet! ====== ====== 7 Syntax Plugins DokuWiki's syntax can be Plugins are extended. How the installed plugins are used is described on their appropriate description pages. The following plugins are available in this particular DokuWiki installation: ~ ~ INFO: syntax plugins ~ ~