Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- wiki:syntax [2013/07/11 12:13] – [X] matthias.zagermann
+++ wiki:syntax [2024/02/28 15:32] (aktuell) – Externe Bearbeitung 127.0.0.1
@@ Zeile 1: / Zeile 1: @@
-====== Syntax ======
+====== Formatting Syntax ======
-[[DokuWiki]] zeichnet sich u. a. durch einfache Textformartierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar.
+[[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.
-In den nachfolgenden Abschnitten sind die möglichen Formatierungsarten aufgelistet, die innerhalb des Editors verwendet werden können. Einige der hier vorgestellten Formatierungen sind auch direkt über die [[doku>de:toolbar|Quickbuttons]] erreichbar.
-Ein erstes Beispiel, wie der Aufbau einer Seite aussehen kann, findest du, wenn du dir diese Seite im Quelltext-Modus anzeigen lässt. Klicke dazu auf den Button "Zeige Quelltext".
-\\ \\
-Zum  Ausprobieren oder Üben kann die [[playground:playground|Spielewiese]] verwendet werden.
+===== Basic Text Formatting =====
-====== 1 Texte ======
+DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
-===== 1.1 Formatierungen =====
-DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''dicktengleichen'' ([[wp>Dickte]]) Text. Natürlich kann auch alles **__//''kombiniert''//__** werden. \\
+  DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts.
+  Of course you can **__//''combine''//__** all these.
-  DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''dicktengleichen'' Text.
+You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-  Natürlich kann auch alles **__//''kombiniert''//__** werden.
-Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.
+  You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
-  Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.
+You can mark something as <del>deleted</del> as well.
-Text kann als <del>gelöscht</del>((wer das Tag "eingefügt" (%%<ins>%%) benötigt. kann dies über Plugins realisieren. Siehe ganz unten!)) markiert werden.
+  You can mark something as <del>deleted</del> as well.
-  Text kann als <del>gelöscht</del> markiert werden.
+**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.
-===== 1.2 Absätze =====
+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.
-Ein Absatz wird durch eine leere Zeile erzeugt. \\
+  This is some text with some linebreaks\\ Note that the
-<nowiki>Eine neue Zeile (Zeilenumbruch) kann durch zwei "Backslashes" (umgekehrte Schrägstriche: \\) </nowiki>gefolgt von einem Leerzeichen erzeugt werden.\\
+  two backslashes are only recognized at the end of a line\\
+  or followed by\\ a whitespace \\this happens without it.
-Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten Schrägstriche
+You should use forced newlines only if really needed.
-werden nur erkannt, wenn sie am Zeilenende stehen\\
-oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus.
-  Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten Schrägstriche
+===== Links =====
-  werden nur erkannt, wenn sie am Zeilenende stehen\\
-  oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus.
-Zeilenumbrüche durch zwei "Backslashes" (umgekehrte Schrägstriche: \\) sollten nur verwendet werden, wenn sie unbedingt notwendig sind.
+DokuWiki supports multiple ways of creating links.
-===== 1.3 Überschriften =====
+==== External ====
-Mit fünf unterschiedlichen Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.\\
-Die Überschriften werden mit maximal sechs "=" eingerahmt, je nach Größe.  H1 ist die Überschrift auf höchster Ebene. Am einfachsten ist es zur Erzeugung der Überschriften, die Symbolleiste zu verwenden. Das Einfügen der Überschriften erfolgt über die Buttons, die ein "H" anzeigen.
-Es ist __sinnvoll__, wenn immer eine Level 1 Überschrift am Anfang eines Artikels steht.
+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.
-Wenn in einer Seite mehr als drei Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet.\\
+  DokuWiki supports multiple ways of creating links. External links are recognized
-Soll dieses Inhaltsverzeichnis nicht erstellt werden, muss der Befehl: ''<nowiki>~~NOTOC~~</nowiki>'' mit in die Seite aufgenommen werden.
+  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.
-  ====== Überschrift Ebene 1 ======
+==== Internal ====
-  ===== Überschrift Ebene 2 =====
-  ==== Überschrift Ebene 3 ====
-  === Überschrift Ebene 4 ===
-  == Überschrift Ebene 5 ==
-Innerhalb von Überschriften können standardmäßig keine weiteren Formatierungen vorgenommen werden! (s. [[faq:headerlinks|FAQ - Headerlinks]])
+Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|link text]].
-===== 1.4 unformatierte Abschnitte =====
-Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede
+  Internal links are created by using square brackets. You can either just give
-Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner "code" bzw. "file" benutzen:
+  a [[pagename]] or use an additional [[pagename|link text]].
-<code>
+[[doku>pagename|Wiki pagenames]] are converted to lowercase automatically, special characters are not allowed.
-Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier              <-- zwischen
-</code>
+You can use [[some:namespaces]] by using a colon in the pagename.
-  <file plain Beispiel.txt>
+  You can use [[some:namespaces]] by using a colon in the pagename.
-  Mit dem Bezeichner "file" kann ein bestimmter Abschnitt als einzelner Bestandteil
-  auf einer Seite zum Download angeboten werden.
-  </file>
-Innerhalb von "file" ist auch das im Abschnitt weiter unten beschriebenen [[de:syntax#syntax_highlighting|Syntax-Highlighting]] aktivierbar.
+For details about namespaces see [[doku>namespaces]].
-<file perl HelloWorld.pl>
+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]].
-#!/usr/bin/perl
-print "Hello World!\n";
-</file>
-  <file perl HelloWorld.pl>
+  This links to [[syntax#internal|this Section]].
-  #!/usr/bin/perl
-  print "Hello World!\n";
-  </file>
-\\
+Notes:
-Um jegliche Umwandlung durch DokuWiki abzustellen, umschließe den entsprechenden Bereich mit "nowiki" Bezeichnern oder kürzer mit doppelten Prozentzeichen ''<nowiki>%%</nowiki>''.
-<nowiki>
+  * Links to [[syntax|existing pages]] are shown in a different style from [[nonexisting]] ones.
-Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text.
+  * 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.
-</nowiki>
+  * When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.
-%%Dieser Text ist nun mit %%''<nowiki>%%</nowiki>''%% markiert und hat die gleiche Wirkung wie "nowiki".
+==== Interwiki ====
-"Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text."%%
+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]].
-Einfach den Quelltext dieser Seite anschauen (den Knopf "Edit" drücken) um zu sehen, wie diese Blöcke angewendet werden.
+  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]].
-===== 1.5 Syntax-Hervorhebung =====
+==== Windows Shares ====
-[[DokuWiki]] kennt Syntax-Highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird [[http://qbnz.com/highlighter/|GeSHi]] "**Ge**neric **S**yntax **Hi**ghlighter" benutzt. Somit wird jede Programmiersprache unterstützt, die GeSHi kennt.\\
+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]].
-Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält:\\
-''<nowiki><code java> Quelltext </code></nowiki>''
-<code java>
+  Windows Shares like [[\\server\share|this]] are recognized, too.
-/**
- * The HelloWorldApp class implements an application that
+Notes:
- * simply displays "Hello World!" to the standard output.
+  * For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the "local zone").
+  * For Mozilla and Firefox it can be enabled through different workaround mentioned in the [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Mozilla Knowledge Base]]. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in ''conf/lang/en/lang.php'' (more details at [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]): <code - conf/lang/en/lang.php>
+<?php
+/**
+ * Customization of the english language file
+ * Copy only the strings that needs to be modified
  */
-class HelloWorldApp {
+$lang['js']['nosmblinks'] = '';
-    public static void main(String[] args) {
-        System.out.println("Hello World!"); //Display the string.
-    }
-}
 </code>
-Es werden folgende Sprachen unterstützt: \\ //actionscript, actionscript-french, 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**//
+==== Image Links ====
-===== 1.6 Zitat / Kommentar =====
+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:
-Um einen Text als Zitat oder Kommentar zu kennzeichnen, wird das "größer als" - Zeichen folgendermaßen verwendet:
-  Ich denke wir sollten es tun.
+  [[http://php.net|{{wiki:dokuwiki-128.png}}]]
-  > Nein, sollten wir nicht.
-  >> Doch!
-  > Wirklich?
-  >> Ja!
-  >>> Dann lass es uns tun!
-  >>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichnen, wird das "größer als"-Zeichen folgendermaßen verwendet
-Ich denke wir sollten es tun
+[[http://php.net|{{wiki:dokuwiki-128.png}}]]
-> Nein, sollten wir nicht.
+Please note: The image formatting is the only formatting syntax accepted in link names.
->> Doch!
+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).
-> Wirklich?
+===== Footnotes =====
->> Ja!
+You can add footnotes ((This is a footnote)) by using double parentheses.
->>> Dann lass es uns tun
+  You can add footnotes ((This is a footnote)) by using double parentheses.
->>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichnen, wird das "größer als"-Zeichen folgendermaßen verwendet
+===== Sectioning =====
-===== 1.7 Escapezeichen =====
-Will man verhindern, dass DokuWiki irgendwelche Formatierungen am bzw. Umwandlungen am Text vornimmt so kann man die Prozentzeichen benutzen
-<code>%%[[wiki:testseite|Testseite]]%%</code>
-Die Ausgabe würde dann folgendermaßen aussehen %%[[wiki:testseite|Testseite]]%%
-====== 2 Links ======
+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.
-Mit DokuWiki können fünf unterschiedliche Arten von Links benutzt werden:
+==== Headline Level 3 ====
+=== Headline Level 4 ===
+== Headline Level 5 ==
-===== 2.1 Extern =====
+  ==== Headline Level 3 ====
+  === Headline Level 4 ===
+  == Headline Level 5 ==
-Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com\\
+By using four or more dashes, you can make a horizontal line:
-Verweise können auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|hier ist google]] \\
-E-Mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>
-  Externe Links werden automatisch erkannt: http://www.google.com oder einfach www.google.com\\
+----
-  Verweise können auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|hier ist google]] \\
-  E-Mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>
-===== 2.2 Intern =====
+===== Media Files =====
-Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt ("Alt Gr+8" bzw. Alt Gr+9 unter Windows bzw. Wahltaste+5 und Wahltaste+6 bei Apple-Betriebssystemen) auf:\\
+You can include external and internal [[doku>images|images, videos and audio files]] with curly brackets. Optionally you can specify the size of them.
-[[doku>pagename]]\\
-Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:\\
+Real size:                        {{wiki:dokuwiki-128.png}}
-[[doku>pagename|Beschreibung für einen Link]].
-  Interne Links werden in doppelten eckigen Klammern gesetzt:
+Resize to given width:            {{wiki:dokuwiki-128.png?50}}
-  [[pagename]]
-  Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:
-  [[pagename|Beschreibung für einen Link]].
-Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt!\\
+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}}
-Umlaute sind genauso wie Sonderzeichen nicht erlaubt!
-Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: [[de:namespaces]]
+Resized external image:           {{https://www.php.net/images/php.gif?200x50}}
-  Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[de:namespaces]]
+  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://www.php.net/images/php.gif?200x50}}
-Weitere Informationen zu Namensbereichen: [[doku>de:namespaces]].
-Die Verlinkung zu einem speziellen Abschnitt innerhalb des Dokuments (Anker) ist auch möglich. Der Abschnittsnamen wird getrennt durch ein Doppelkreuz (#) an den Seitennamen gehängt.
+By using left or right whitespaces you can choose the alignment.
-Dieses Beispiel verlinkt zu [[de:wiki:syntax#intern|diesem Abschnitt]].
+{{ wiki:dokuwiki-128.png}}
-  Dieses Beispiel verlinkt zu [[de:wiki:syntax#intern|diesem Abschnitt]].
+{{wiki:dokuwiki-128.png }}
+{{ wiki:dokuwiki-128.png }}
-Anmerkungen:
-  * Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten.
-  * DokuWiki verwendet standardmäßig keine [[wpde>CamelCase]] für Links. \\ In der Einstellungsdatei: [[doku>config]] kann das aber geändert werden. \\ **Hinweis**: wenn das Wort "DokuWiki" als Link angezeigt wird, dann ist diese Option eingeschaltet.
-  * Ändert sich eine Überschrift im Zieldokument, führt der Anker ins Leere ohne das der Link dabei als Fehlerhaft angezeigt wird.
-  * Anker werden klein geschrieben, es werden Leerzeichen mit Unterstrichen und Umlaute mit Ihren Umschreibungen (ä = ae) verwendet.
-===== 2.3 Interwiki =====
-DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de:interwiki]] Links. \\
-Ein Link zur Wikipedia Seite über Wikis:[[wpde>Wiki]]
-  DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de:interwiki]] Links. \\
-  Ein Link zur Wikipedia Seite über Wikis:[[wpde>Wiki]]
-===== 2.4 Windows-Freigaben =====
-DokuWiki kennt auch Links auf Windows-Freigaben: [[\\server\freigabe|freigegebener-Ordner]]. \\
-Dies ist allerdings nur in einer homogenen Benutzergruppe sinnvoll (siehe [[wpde>Intranet]]).
-  [[\\server\freigabe|this]].
-Hinweis:
-  * Aus Sicherheitsgründen funktioniert direktes Navigieren durch die Freigaben standardmäßig nur mit dem Internet Explorer (und das nur in der "lokalen Zone")!
-  * Für Mozilla und Firefox kann es durch die Option [[http://www.mozilla.org/quality/networking/docs/netprefs.html#file|security.checkloaduri]] eingeschaltet werden, was aber nicht empfohlen wird! (Weitere Informationen: [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Links to local pages do not work]])
-  * Opera ignoriert als Sicherheitsfeature seit [[http://www.opera.com/windows/changelogs/754/|Version 7.54]] alle Links auf //file:// in Webseiten.
-  * Für weitere Informationen siehe: [[bug>151]]
-===== 2.5 Bilder als Links =====
-Bilder können für einen Link auf eine interne oder externe Datei verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern (siehe unten) kombiniert:
-   [[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
-[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
-Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, die in Linknamen benutzt werden können!
-====== 3 Bilder und andere Dateien ======
-===== 3.1 Bilder im DokuWiki speichern =====
-Um Bilder im DokuWiki speichern zu dürfen, muss der Benutzer die entsprechende Berechtigung besitzen ([[de:acl|ACL]]). Zum Hochladen ist mindestens die Berechtigung "Hochladen" (engl. "Upload"), zum Löschen "Entfernen" (engl. "Delete") für den [[namespaces|Namensraum]] erforderlich.
-===== 3.2 Größe von Bildern  =====
-Mit geschweiften Klammern können sowohl externe als auch interne [[doku>images|Bilder]] eingebunden werden. Optional kann deren Größe angegeben werden:
-Originalgröße:                      {{wiki:dokuwiki-128.png}}
-Eine Breite vorgeben:                {{wiki:dokuwiki-128.png?50}}
-Breite und Höhe vorgeben:            {{wiki:dokuwiki-128.png?200x50}}
-Größe für externe Bilder vorgeben:   {{http://de3.php.net/images/php.gif?200x50}}
-  Originalgröße:                        {{wiki:dokuwiki-128.png}}
-  Eine Breite vorgeben:                  {{wiki:dokuwiki-128.png?50}}
-  Breite und Höhe vorgeben:              {{wiki:dokuwiki-128.png?200x50}}
-  Größe für externe Bilder vorgeben:     {{http://de3.php.net/images/php.gif?200x50}}
-===== 3.3 Ausrichten von Bildern =====
-Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden (Links, Zentriert, Rechts).
-{{ wiki:dokuwiki-128.png|Rechts}}
-{{wiki:dokuwiki-128.png |Links}}
-{{ wiki:dokuwiki-128.png |Zentriert}}
   {{ wiki:dokuwiki-128.png}}
@@ Zeile 268: / Zeile 157: @@
   {{ wiki:dokuwiki-128.png }}
-Bei Ausrichtung und der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt:
+Of course, you can add a title (displayed as a tooltip by most browsers), too.
-  {{ wiki:dokuwiki-128.png|Rechtsbündig}}
-  {{wiki:dokuwiki-128.png |Linksbündig}}
-  {{ wiki:dokuwiki-128.png |Zentriert}}
-===== 3.4 Tooltips =====
+{{ wiki:dokuwiki-128.png |This is the caption}}
-Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.
-{{ wiki:dokuwiki-128.png |Dies ist ein Titel}}
+  {{ wiki:dokuwiki-128.png |This is the caption}}
-  {{ wiki:dokuwiki-128.png |Dies ist ein Titel}}
+For linking an image to another page see [[#Image Links]] above.
-===== 3.5 Dateidownload =====
+==== Supported Media Formats ====
-Wenn eine Datei angegeben wird, die kein Bild (''gif, jpeg, png'') ist, so wird sie als Link angezeigt und so zum Download angeboten.
+DokuWiki can embed the following media formats directly.
-{{ wiki:dokuwiki-128.txt |Beispiel}}
+| Image | ''gif'', ''jpg'', ''png''  |
-<code>{{ wiki:dokuwiki-128.txt |Beispiel}}</code>
+| Video | ''webm'', ''ogv'', ''mp4'' |
+| Audio | ''ogg'', ''mp3'', ''wav''  |
+| Flash | ''swf''                    |
-===== 3.6 Automatische Verlinkung =====
+If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
-Bilder werden automatisch mit einer Verlinkung zur Ihren [[wpde>Metadaten]] erstellt - Bsp.: {{wiki:dokuwiki-128.png?15}}
+By adding ''?linkonly'' you provide a link to the media without displaying it inline
-Dieses Verhalten kann über die Option ?nolink((ggf. mit einem "&" mit anderen Optionen wie der Größenangabe kombinieren)) unterbunden werden((Standardmäßig lässt sich [[tips:image_nolink|dieses, oft unerwünschte, Verhalten]] momentan (13.03.2009) nicht für das komplette DokuWiki deaktivieren)):
+  {{wiki:dokuwiki-128.png?linkonly}}
-{{wiki:dokuwiki-128.png?15&nolink}}
+{{wiki:dokuwiki-128.png?linkonly}} This is just a link to the image.
-  {{wiki:dokuwiki-128.png?15&nolink}}
-Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:
+==== Fallback Formats ====
-{{wiki:dokuwiki-128.png?15&direct}}
+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.
-  {{wiki:dokuwiki-128.png?15&direct}}
-====== 4 Listen ======
+For example consider this embedded mp4 video:
-DokuWiki kennt unsortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit zwei Leerzeichen. Diesen Leerzeichen folgt dann ein "*" für unsortierte oder ein "-" für nummerierte Listen.
+  {{video.mp4|A funny video}}
-  * Dies ist ein Eintrag einer unsortierten Liste
+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.
-  * Ein zweiter Eintrag
-    * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
-  * Noch ein Eintrag
-  - Dies ist ein Eintrag einer nummerierte Liste
+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.
-  - Ein zweiter Eintrag
-    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
-  - Noch ein Eintrag
-<code>
+===== Lists =====
-  * Dies ist ein Eintrag einer unsortierten Liste
-  * Ein zweiter Eintrag
-    * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
-  * Noch ein Eintrag
-  - Dies ist ein Eintrag einer nummerierte Liste
+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.
-  - Ein zweiter Eintrag
-    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
-  - Noch ein Eintrag
-</code>
-====== 5 Tabellen ======
+  * This is a list
+  * The second item
+    * You may have different levels
+  * Another item
-===== 5.1 Grundlegender Aufbau =====
+  - The same list but ordered
+  - Another item
+    - Just use indention for deeper levels
+  - That's it
-Mit DokuWiki können Tabellen ganz einfach erstellt werden:
+<code>
+  * This is a list
+  * The second item
+    * You may have different levels
+  * Another item
-^ hervorgehoben       ^ zum Beispiel für                                                  ^ eine Titelzeile         ^
+  - The same list but ordered
-| Zeile 1 Spalte 1    | Zeile 1 Spalte 2                                                  | Zeile 1 Spalte 3        |
+  - Another item
-| Zeile 2 Spalte 1    | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
+    - Just use indention for deeper levels
-| Zeile 3 Spalte 1    | Zeile 2 Spalte 2                                                   | Zeile 2 Spalte 3        |
+  - That's it
-| Zeile 4 Spalte 1    |   {{wiki:dokuwiki-128.png?400x500}}           | Zeile 4 Spalte 3        |
+</code>
-Felder einer Tabelle starten mit "|" für ein normales Feld oder mit einem "^" für hervorgehobenes Feld.
+Also take a look at the [[doku>faq:lists|FAQ on list items]].
-  ^ hervorgehoben       ^ zum Beispiel für                                                  ^ eine Titelzeile         ^
+===== Text Conversions =====
-  | Zeile 1 Spalte 1    | Zeile 1 Spalte 2                                                  | Zeile 1 Spalte 3        |
-  | Zeile 2 Spalte 1    | doppelte Spaltenbreite (beachte den doppelten senkrechten Strich) ||
-  | Zeile 3 Spalte 1    | Zeile 2 Spalte 2                                                   | Zeile 2 Spalte 3        |
-===== 5.2 Formatierung/Ausrichtung =====
+DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
-=== Leerzellen ===
-Zellen über mehrere Spalten werden erzeugt wenn man, wie oben gezeigt, am Ende einer solchen Spalte so viele "|" oder "^" ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden sollen.\\
-Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern "|" oder "^" haben.
-Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich.
-|                    ^ hervorgehoben 1           ^ hervorgehoben 2         ^
-^ hervorgehoben 3    | Zeile 1 Spalte 2          | Zeile 1 Spalte 3        |
-^ hervorgehoben 4    | Zeile 2 Spalte 2          |                         |
-^ hervorgehoben 5    | Zeile 3 Spalte 2          | Zeile 3 Spalte 3        |
-Wie wir sehen, entscheidet der Feldtrenner ("|" oder "^") vor einer Zelle über ihr Aussehen:
-  |                    ^ hervorgehoben 1           ^ hervorgehoben 2         ^
-  ^ hervorgehoben 3    | Zeile 1 Spalte 2          | Zeile 1 Spalte 3        |
-  ^ hervorgehoben 4    | Zeile 2 Spalte 2          |                         |
-  ^ hervorgehoben 5    | Zeile 3 Spalte 2          | Zeile 3 Spalte 3        |
-=== Zellen verbinden ===
-Felder über mehrere Zeilen (**vertikal verbundene Zellen**) lassen sich durch hinzufügen von '':::'' in der zu verbindenden Zelle zusammenfügen.
-^ Titelzeile 1        ^ Titelzeile 2                       ^ Titelzeile 3            ^
-| Zeile 1 Spalte 1    | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3        |
-| Zeile 2 Spalte 1    | :::                                | Zeile 2 Spalte 3        |
-| Zeile 3 Spalte 1    | :::                                | Zeile 3 Spalte 3        |
-Außer den drei Doppelpunkten darf die zu verbindende Zelle keine weiteren Inhalte haben.
-  ^ Titelzeile 1        ^ Titelzeile 2                       ^ Titelzeile 3            ^
-  | Zeile 1 Spalte 1    | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3        |
-  | Zeile 2 Spalte 1    | :::                                | Zeile 2 Spalte 3        |
-  | Zeile 3 Spalte 1    | :::                                | Zeile 3 Spalte 3        |
-Felder über mehrere Spalten (**horizontal verbundene Zellen**) lassen sich durch hinzufügen von ''^'' bzw. ''|'' in der zu verbindenden Zelle zusammenfügen.
-^ Titelzeile 1        ^ Titelzeile 2                       ^ Titelzeile 3            ^
-| Zeile 1 Spalte 1    | Diese Zelle ist horizontal verbunden                        ||
-| Zeile 2 Spalte 1    | Zeile 2 Spalte 2                   | Zeile 2 Spalte 3        |
-| Zeile 3 Spalte 1    | Zeile 3 Spalte 2                   | Zeile 3 Spalte 3        |
-Außer den drei Doppelpunkten darf die zu verbindende Zelle keine weiteren Inhalte haben.
-  ^ Titelzeile 1        ^ Titelzeile 2                       ^ Titelzeile 3            ^
-  | Zeile 1 Spalte 1    | Diese Zelle ist horizontal verbunden                         ||
-  | Zeile 2 Spalte 1    | Zeile 2 Spalte 2                   |    Zeile 2 Spalte 3      |
-  | Zeile 3 Spalte 1    | Zeile 3 Spalte 2                   | Zeile 3 Spalte 3         |
-=== Textausrichtung ===
-Der Inhalt einer Zelle kann horizontal innerhalb der Zelle ausgerichtet werden:
-  * Rechtsbündig - zwei Leerzeichen links vom Text
-  * Linksbündig - Leerzeichen rechts vom Text
-  * Zentriert - zwei Leerzeichen links und rechts vom Text
-^          Tabelle mit Ausrichtung         ^^^
-|Links         |        Rechts|  Mitte       |
-|Links         |        Rechts|    Mitte     |
-| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-So sieht die Formatierung aus:
-  ^          Tabelle mit Ausrichtung         ^^^
-  |        Rechts|    Mitte     |Links         |
-  |Links         |        Rechts|    Mitte     |
-  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-|Hinweis zu dem senkrechten Balken-Zeichen: dieses Zeichen ist auf einer PC-Tastatur erreichbar über die Taste "<" bei zusätzlich gedrückter "AltGr"-Taste. Ist dort auch aufgedruckt. Apple-Nutzer erreichen das Zeichen mit der Wahltaste ("Alt") und der "7".|
-====== 6 sonstige Formatierungen ======
-===== 6.1 Fußnoten =====
-Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)). Der Text zwischen den Klammern wird an das Ende der Seite geschrieben. Die Reihenfolge und somit die Nummerierung übernimmt DokuWiki.
-  Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote))
-===== 6.2 horizontale Linie =====
-Mit vier aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:
-----
-<nowiki>----</nowiki>
+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.
-===== 6.3 Smileys =====
+==== Text to Image Conversions ====
-DokuWiki verwandelt oft genutzte [[wpde>Emoticon]]s zu kleinen Smily-Grafiken.\\
+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:
-Weitere Smiley-Grafiken können im Ordner "smily" abgelegt und dann in der Datei ''conf/smileys.conf'' bzw. für benutzereigene Smileys unter ''conf/smileys.local.conf'' eingetragen werden.\\
-Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys:
-^  8-)  ^  8-O  ^  :-(  ^  :-)  ^  =)  ^  :-/  ^  :-\  ^  :-?  ^  :-D  ^  :-P  ^  :-O  ^  :-X  ^  :-|  ^  ;-)  ^  :?:  ^  :!:  ^  ''^_^''  ^  LOL  ^  FIXME  ^  DELETEME  ^
+  * 8-) %%  8-)  %%
-|  %%  8-)  %%  |  %%  8-O  %%  |  %%  :-(  %%  |  %%  :-)  %%  |  %%  =)   %%  |  %%  :-/  %%  |  %%  :-\  %%  |  %%  :-?  %%  |  %%  :-D  %%  |  %%  :-P  %%  |  %%  :-O  %%  |  %%  :-X  %%  |  %%  :-|  %%  |  %%  ;-)  %%  |  %%  :?:  %%  |  %%  :!:  %%  |  %%  ^_^  %%  |  %%  LOL  %%  |  %%  FIXME  %%  |  %% DELETEME  %%  |
+  * 8-O %%  8-O  %%
+  * :-( %%  :-(  %%
+  * :-) %%  :-)  %%
+  * =)  %%  =)   %%
+  * :-/ %%  :-/  %%
+  * :-\ %%  :-\  %%
+  * :-? %%  :-?  %%
+  * :-D %%  :-D  %%
+  * :-P %%  :-P  %%
+  * :-O %%  :-O  %%
+  * :-X %%  :-X  %%
+  * :-| %%  :-|  %%
+  * ;-) %%  ;-)  %%
+  * ^_^ %%  ^_^  %%
+  * m(  %%  m(   %%
+  * :?: %%  :?:  %%
+  * :!: %%  :!:  %%
+  * LOL %%  LOL  %%
+  * FIXME %%  FIXME %%
+  * DELETEME %% DELETEME %%
-===== 6.4 Typografie =====
+==== Text to HTML Conversions ====
-[[DokuWiki]] kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.\\
+Typography: [[DokuWiki]] can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
-Hier eine Liste aller Zeichen, die DokuWiki kennt:
 -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
@@ Zeile 455: / Zeile 266: @@
 </code>
-Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden
+The same can be done to produce any kind of HTML, it just needs to be added to the [[doku>entities|pattern file]].
-===== 6.5 HTML und PHP einbinden =====
+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]].
-In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden.
+===== Quoting =====
-<html>
+Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
-This is some <font color="red" size="+1">HTML-Code</font>
-</html>
 <code>
-<html>
+I think we should do it
-This is some <font color="red" size="+1">HTML-Code</font>
-</html>
-</code>
-<php>
+> No we shouldn't
-echo 'A logo generated by PHP:';
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
-</php>
-<code>
+>> Well, I say we should
-<php>
-echo 'A logo generated by PHP:';
-echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
-</php>
-</code>
-**Achtung**: Das Einbinden von HTML und PHP in einer Seite kann in der Konfigurationsdatei ausgeschaltet werden((Konfigurationsoptionen [[config:htmlok]] bzw. [[config:phpok]])). Ist diese Option aktiviert, wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.
+> Really?
-**Achtung**: Das Einbinden von HTML und PHP auf einer Seite im Internet ist gewöhnlich ein schweres Sicherheitsrisiko! Diese Funktion ist nur für das Intranet gedacht!
+>> Yes!
-====== 7 Kontroll-Makros ======
+>>> Then lets do it!
+</code>
-Einige Syntax-Befehle beeinflussen wie Dokuwiki eine Seite beim Aufruf ausgibt. Die folgenden Kontroll-Makros sind verfügbar:
+I think we should do it
-^ Makro          ^ Beschreibung ^
+> No we shouldn't
-| %%~~NOTOC~~%%   | Wenn dieses Makro in eine Seite eingebunden ist, wird das [[:toc|Table of Content]] nicht erstellt.|
-| %%~~NOCACHE~~%% | Alle Seiten werden aus Performancegründen zwischengespeichert. Unter bestimmten Umständen ist dieses Verhalten aber nicht gewollt. Beim Einfügen dieses Makros wird DokuWiki angewiesen, den Inhalt der Seite neu aufzubauen. |
-====== 8 Syntax-Plugins ======
+>> Well, I say we should
-Die Syntax von DokuWiki kann durch [[doku>plugins|Plugins]] erweitert werden. Wie die einzelnen Plugins benutzt werden, steht auf den zugehörigen Beschreibungsseiten. Die folgenden Plugins sind auf dieser DokuWiki Installation verfügbar:
-===== 8.1 Doodle Plugin =====
+> Really?
-Dieses Plugin kann dir helfen, Termine mit anderen Leuten zu planen oder Entscheidungen herbeizuführen. Die Syntax sieht wie folgt aus:
-  <doodle [id]>
-  ^ [Auswahltext] ^ [Auswahltext] ^ ... ^
-  </doodle>
-Du brauchst lediglich einen Tabellenkopf, der die Auswahlmöglichkeiten enthält, in die ''%%<doodle>%%'' Tags einbetten.
+>> Yes!
-^ [id]     | die ID des Doodle; muss eindeutig sein ((andernfalls werden Metadaten verschiedener Doodles mit der gleicher ID durcheinander gebracht, d.h. einige Antworten auf Entscheidungen aus einem früheren Doodle erscheinen im neuen Doodle)); erscheint als Titel | obligatorisch |
+>>> Then lets do it!
-^ [Auswahltext] | eine Option für die Benutzer zum Ankreuzen | obligatorisch |
-Es könne noch weitere, optionale Parameter verwendet werden...
+===== Tables =====
-  <doodle [disable] [single] [login]| [id]>
+DokuWiki supports a simple syntax to create tables.
-  ^ [Auswahltext] ^ [Auswahltext] ^ ... ^
-  </doodle>
-^ [disable]| das Ergebnis anzeigen (es kann nicht abgestimmt werden) |
+^ Heading 1      ^ Heading 2       ^ Heading 3          ^
-^ [single] | es kann nur eine Auswahl getroffen werden |
+| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
-^ [login]  | Benutzer muss eingeloggt sein, der Vor- und Nachname wird als Name verwendet |
+| Row 2 Col 1    | some colspan (note the double pipe) ||
+| Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
-Demo des Plugins: [[http://www.ichiayi.com/wiki/opensource/dokuwiki/plugin/doodle/demo| Doodle Plugin Demo]].
+Table rows have to start and end with a ''|'' for normal rows or a ''^'' for headers.
-===== 8.2 AV Bar Chart Plugin =====
+  ^ Heading 1      ^ Heading 2       ^ Heading 3          ^
-Dieses Plugin stellt Daten als Balkendiagramm dar.\\
+  | Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
-<barchart>
+  | Row 2 Col 1    | some colspan (note the double pipe) ||
-|
+  | Row 3 Col 1    | Row 3 Col 2     | Row 3 Col 3        |
-A:500,
-B:50,
-C:250,
-D:1000
-</barchart>
-<code>
-<barchart>
-|
-A:500,
-B:50,
-C:250,
-D:1000
-</barchart>
-</code>
-  * Der erste Wert ist der Maximalwert der Daten.
-  * Nach dem | folgt eine durch Komma separierte Liste mit Beschriftung:Wert-Paaren, die im Balkendiagramm angezeigt werden sollen.
-===== 8.3 Tablecalc Plugin =====
+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 perform a calculation you need to insert XL-style formula into work sheet. Any expression must be started with ''~~='' and finished by ''~~''. You can use direct range specification for functions (like XL does) or a special ''range()'' function. The range consists of a reference to the start cell and to the finish cell, like this:
-<code>
-r0c4
-</code>
-Please note, that row (''r'') and column (''c'') index starts from zero. Row and column prefixes can be swapped. The following is equal of the above:
-<code>
-c4r0
-</code>
-You can also reference to multiple cells in one range:
+Vertical tableheaders are possible, too.
-<code>
-|r0c0:r1c1||
-</code>
-Furthermore you can use multiple ranges:
+|              ^ Heading 1            ^ Heading 2          ^
-<code>
+^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
-r0c0:r1c1,r0c3:r1c4
+^ Heading 4    | no colspan this time |                    |
-</code>
+^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
-There is a recommendation not to use references for non-existing cells. For example, this is not correct (though it will work, returning "3"):
+As you can see, it's the cell separator before a cell which decides about the formatting:
-<code>
-| 1 |
-| 2 |
-| ~~=sum(r0c0:r99c99)~~ |
-</code>
-Instead use constructions like this:
+  |              ^ Heading 1            ^ Heading 2          ^
-<code>
+  ^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
-| 1 |
+  ^ Heading 4    | no colspan this time |                    |
-| 2 |
+  ^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |
-| ~~=sum(range(0,0,col(),row()-1))~~ |
-</code>
-==== Functions ====
+You can have rowspans (vertically connected cells) by adding ''%%:::%%'' into the cells below the one to which they should connect.
-The following functions are implemented:
+^ 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        |
-''x'' = column, ''y'' = row
+Apart from the rowspan syntax those cells should not contain anything else.
-^ Func                         ^              Description                                                                         ^
+  ^ Heading 1      ^ Heading 2                  ^ Heading 3          ^
-| cell(x,y)                    | Returns numeric value of (x,y) cell                                                              |
+  | Row 1 Col 1    | this cell spans vertically | Row 1 Col 3        |
-| row()                        | Returns current row                                                                              |
+  | Row 2 Col 1    | :::                        | Row 2 Col 3        |
-| col()                        | Returns current column                                                                           |
+  | Row 3 Col 1    | :::                        | Row 2 Col 3        |
-| range(x1,y1,x2,y2)           | Returns internal range for other functions                                                       |
-| sum(range)                   | Returns sum of the specified range                                                               |
-| count(range)                 | Returns number of elements in the specified range                                                |
-| round(number;decimals)       | Returns number, rounded to specified decimals                                                    |
-| label(string)                | Binds label to the table                                                                         |
-| average(range)               | Returns average of the specified range                                                           |
-| min(range)                   | Returns minimum value within specified range                                                     |
-| max(range)                   | Returns minimum value within specified range                                                     |
-| check(condition;true;false)  | Executes ''true'' statement, if ''condition'' is not zero                                        |
-| compare(a;b;operation)       | Do math compare for ''a'' and ''b''. Returns zero when conditions for the ''operation'' are not met  |
-| calc()                       | FIXME  |
-Though you can use colon as delimiter in functions semi-colon is preferred and recommended.
+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 |
-==== Operators ====
+This is how it looks in the source:
-Most of the standard Javascript arithmetic operators are supported but some ((The conflicting operators are: %%^ | ~%%)) conflict with the table markup so the following operators are available:
+  ^           Table with alignment           ^^^
+  |         right|    center    |left          |
+  |left          |         right|    center    |
+  | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
-^  Operator  ^  Description  ^
+Note: Vertical alignment is not supported.
-|  +         | Addition and unary plus |
-|  -         | Subtraction and unary negative |
-|  *         | Multiplication |
-|  /         | Division |
-|  %         | Modulus (division remainder) |
-|  &         | Logical AND |
-|  %%<<%%    | Shift left |
-|  %%>>%%    | Shift right |
-=====Examples=====
+===== No Formatting =====
-==== I ====
+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>''.
-<code>
+<nowiki>
-| 1 | 2 | ~~=r0c0+r0c1~~ | ~~=10.2+1.5~~ |
+This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
-</code>
+</nowiki>
+The same is true for %%//__this__ text// with a smiley ;-)%%.
-| 1 | 2 | 3 | 11.7 |
+  <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 ;-)%%.
-==== II ====
+===== Code Blocks =====
-<code>
-| 1 | 2 |
-| 3 | 4 |
-| ~~=sum(r0c0:r1c1)~~ ||
-</code>
-| 1 | 2 |
+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>%%''.
-| 3 | 4 |
-| 10 ||
+  This is text is indented by two spaces.
-==== III ====
 <code>
-| 1 | 2 | 3 | 4 |
+This is preformatted code all spaces are preserved: like              <-this
-| 5 | 6 | 7 | 8 |
-| **~~=sum(r0c0:r1c1,r0c3:r1c4)~~** ||||
 </code>
-| 1 | 2 | 3 | 4 |
+<file>
-| 5 | 6 | 7 | 8 |
+This is pretty much the same, but you could use it to show that you quoted a file.
-|  **26**  ||||
+</file>
+Those blocks were created by this source:
-==== IV ====
+    This is text is indented by two spaces.
-<code>
-|1|
-|2|
-|3|
-|4|
-|5.74|
-|6|
-|7|
-|8|
-|9|
-|10|
-|11|
-|~~=sum(range(col(),0,col(),row()-1))~~|
-</code>
-|1|
+  <code>
-|2|
+  This is preformatted code all spaces are preserved: like              <-this
-|3|
+  </code>
-|4|
-|5.74|
-|6|
-|7|
-|8|
-|9|
-|10|
-|11|
-|65.74|
+  <file>
+  This is pretty much the same, but you could use it to show that you quoted a file.
+  </file>
+==== Syntax Highlighting ====
-==== V ====
+[[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>
-|1|
+<code java>
-|2|
+/**
-|3|
+ * The HelloWorldApp class implements an application that
-|4|
+ * simply displays "Hello World!" to the standard output.
-|5|
+ */
-|6|
+class HelloWorldApp {
-|7|
+    public static void main(String[] args) {
-|8|
+        System.out.println("Hello World!"); //Display the string.
-|9|
+    }
-|10|
+}
-|~~=average(range(col(),0,col(),row()-1))~~|
 </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//
-|1|
+There are additional [[doku>syntax_highlighting|advanced options]] available for syntax highlighting, such as highlighting lines or adding line numbers.
-|2|
-|3|
-|4|
-|5|
-|6|
-|7|
-|8|
-|9|
-|10|
-|5.5|
-==== VI ====
+==== Downloadable Code Blocks ====
-<code>
-| ~~=label(ex6_1)~~1 | 2 |
-| 3 | 4 |
-Sum: **~~=sum(ex6_1.c0r0:c99r99)~~**
+When you use the ''%%<code>%%'' or ''%%<file>%%'' syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
-</code>
-| 1 | 2 |
-| 3 | 4 |
-Sum: **10**
-=== VII ===
 <code>
-| **~~=label(ex7_1)~~11** | ~~=sum(ex7_2.c0r0:c99r99)~~ |
+<file php myexample.php>
-| 13 | 14 |
+<?php echo "hello world!"; ?>
+</file>
+</code>
-| ~~=label(ex7_2)~~1 | 2 |
+<file php myexample.php>
-| 3 | 4 |
+<?php echo "hello world!"; ?>
+</file>
-Sum: **~~=sum(ex7_1.c0r0:c1r1)~~**
+If you don't want any highlighting but want a downloadable file, specify a dash (''-'') as the language code: ''%%<code - myfile.foo>%%''.
-</code>
+===== 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:
-| **11** | 10 |
+^ Parameter  ^ Description ^
-| 13 | 14 |
+| 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. All HTML 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). |
-| 1 | 2 |
+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.
-| 3 | 4 |
-Sum: **48**
+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''.
-=== VIII ===
+**Example:**
-<code>
-| **~~=min(c0r1:c0r3)~~** | **~~=max(c1r1:c1r3)~~** |
-| 1 | 7 |
-| 2 | 8 |
-| 3 | 9 |
-~~=calc()~~
+  {{rss>http://slashdot.org/index.rss 5 author date 1h }}
-</code>
-| **1** | **9** |
+{{rss>http://slashdot.org/index.rss 5 author date 1h }}
-| 1 | 7 |
-| 2 | 8 |
-| 3 | 9 |
-=== IX ===
+===== Control Macros =====
-<code>
-| 1 | ~~=check(cell(0,row()),#True,#False)~~ |
-| 0 | ~~=check(cell(0,row()),#True,#False)~~ |
-| x | ~~=check(cell(0,row()),#True,#False)~~ |
-|   | ~~=check(cell(0,row()),#True,#False)~~ |
-| **** | ~~=check(cell(0,row()),#True,#False)~~ |
-</code>
-| 1 | True |
+Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
-| 0 | False |
-| x | False |
-|  | False |
-|  | False |
+^ 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 |
-=== X ===
+===== Syntax Plugins =====
-<code>
-| 1 | 2 | 1=2 | ~~=check(compare(cell(0,row()),cell(1,row()),#=),#True,#False)~~ |
-| 3 | 3 | 3=3 | ~~=check(compare(cell(0,row()),cell(1,row()),#=),#True,#False)~~ |
-| 4 | 5 | 4<5 | ~~=check(compare(cell(0,row()),cell(1,row()),#<),#True,#False)~~ |
-| 6 | 7 | 6>7 | ~~=check(compare(cell(0,row()),cell(1,row()),#>),#True,#False)~~ |
-| 8 | 9 | 8>9 | ~~=check(compare(cell(0,row()),cell(1,row()),#>),#True,#False)~~ |
-| 10 | 10 | 10≥10 | ~~=check(compare(cell(0,row()),cell(1,row()),#>=),#True,#False)~~ |
-| 11 | 11 | 11≤11 | ~~=check(compare(cell(0,row()),cell(1,row()),#>=),#True,#False)~~ |
-| 12 | 12 | 12≠12 | ~~=check(compare(cell(0,row()),cell(1,row()),#!=),#True,#False)~~ |
-</code>
-| 1 | 2 | 1=2 | False |
-| 3 | 3 | 3=3 | True |
-| 4 | 5 | 4<5 | True |
-| 6 | 7 | 6>7 | False |
-| 8 | 9 | 8>9 | False |
-| 10 | 10 | 10≥10 | True |
-| 11 | 11 | 11≤11 | True |
-| 12 | 12 | 12≠12 | False |
-=== XI ===
+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:
-^  Operator  ^  Equation         ^ Result ^
+~~INFO:syntaxplugins~~
-|  +         | %%~~= 3 + 2 ~~%%  |  5  |
-|  -         | %%~~= 3 - 2 ~~%%  |  1  |
-|  *         | %%~~= 3 * 2 ~~%%  |  6  |
-|  /         | %%~~= 6 / 2 ~~%%  |  3  |
-|  %         | %%~~= 7 % 2 ~~%%  |  1  |
-|  unary +   | %%~~= +2 ~~%%     |  2  |
-|  unary -   | %%~~= -2 ~~%%     |  -2  |
-|  &         | %%~~= 3 & 2 ~~%%  |  2  |
-|  %%<<%%    | %%~~= 2 << 7 ~~%% |  256  |
-|  %%>>%%    | %%~~= 8 >> 2 ~~%% |  2  |