Formatierungssyntax

DokuWiki unterstützt eine einfache Beschreibungssprache, welche versucht den eigentlichen Text möglichst lesbar zu halten. Auf dieser Seite werden alle möglichen Syntax-Konstrukte beschrieben, die zum Aufbau einer Seiten zur Verfügung stehen. Der einfachste Weg die Verwendung zu lernen besteht darin, sich die Quelltexte einer Seite anzuschauen. Dazu einfach unten oder oben, links die Schaltfläche Zeige Quelltext anklicken. Dazu muss man nicht angemeldet sein. Ist man angemeldet, kann man auch auf Diese Seite bearbeiten klicken. Nur zum Nachschauen ist das aber nicht so gut, weil damit das Bearbeiten der Seite für andere gesperrt wird. Bitte keine ungeänderten Seiten speichern, da das ein unnötigen Eintrag in die History erzeugt. Um etwas Auszuprobieren einfach die als Spielwiese (englisch: playgrond) bezeichnete Seite benutzen. Ein Link dahin befindet sich im Beschreibungstext über den Editor-Eingabefeld. Dort befindet sich auch eine Werkzeugleiste mit den wichtigsten Formatierungen. Einfach den Textkursor auf die gewünschte Textstelle setzen und dann die jeweilige Schaltfläche anklicken. Man muss sich wirklich nicht viel merken – alles liegt nur wenige Mausklicks entfernt.

DokuWiki untestützt die Textattribute fett, kursiv, unterstrichen und nicht proportional. Selbstverständlich können diese kombiniert werden.

DokuWiki untestützt die Textattribute **fett**, //kursiv//, __unterstrichen__ und ''nicht proportional''.
Selbstverständlich können diese **__//''kombiniert''//__** werden.

Text kann _tiefgestellt oder ^hochgestellt werden.

Text kann <sub>tiefgestellt</sub> oder <sup>hochgestellt</sup> werden.

Text kann als gelöscht markiert werden.

Text kann als <del>gelöscht</del> markiert werden.

Absätze werden durch Leerzeilen erzeugt. Soll ein Zeilenvorschub erzwungen werden, ohne einen neuen Absatz zu beginnen, kann das durch zwei umgekehrte Schrägstriche gefolgt von einen Leerzeichen oder den Zeilenende erreicht werden.

Dies ist Text mit erzwungenen Zeilenumbrüchen
Diese \\Striche werden nicht erkannt
da ihn weder ein Leerzeichen noch ein Zeilenende folgt.

Dies ist Text mit erzwungenen Zeilenumbrüchen\\ Diese \\Striche werden nicht erkannt\\
da ihn weder ein Leerzeichen noch ein Zeilenende folgt.

Erzwungene Zeilenumbrüche sollten nur in begründeten Fällen benutzt werden.

In DokuWiki gibt es mehrere Wege um Links zu Erzeugen.

Externe Links werden automatisch erkannt: http://www.google.com oder einfacher www.google.com - Den Links kann ein Anzeigenamen zugeordnet werden: Dieser Link führt zu google. Email Adressen werden auch erkannt: andi@splitbrain.org.

Externe Links werden automatisch erkannt: http://www.google.com oder einfacher www.google.com - Den Links kann ein 
Anzeigenamen zugeordnet werden: [[http://www.google.com| Dieser Link führt zu google]]. Email Adressen werden auch 
erkannt: <andi@splitbrain.org>.

Interne Links werden durch doppelte, eckige Klammern erzeugt. Ohne Anzeigetext wiki:pagename oder mit Anzeigetext Title Text. Wiki Seitennamen werden automatisch in Kleinbuchstaben konvertiert. Leerzeichen werden zu Unterstrichen konvertiert. Ein Seitenname darf nur mit einen Buchstaben aus den 26 Zeichen umfassenden Grundalphabet oder einen Unterstrich beginnen. Danach sind auch Ziffern erlaubt.

Interne Links werden durch doppelte, eckige Klammern erzeugt. Ohne Anzeigetext [[doku>wiki:pagename]] oder mit    
Anzeigetext [[doku>wiki:pagename|Title Text]]. Wiki Seitennamen werden automatisch in Kleinbuchstaben
konvertiert. Leerzeichen werden zu Unterstrichen konvertiert. Ein Seitenname darf nur mit einen Buchstaben aus
den 26 Zeichen umfassenden Grundalphabet oder einen Unterstrich beginnen. Danach sind auch Ziffern erlaubt. 

Man kann den Seitennamen einen Namensraum voranstellen namespaces. Beides wird durch ein Doppelpunkt getrennt.

Man kann den Seitennamen einen Namensraum voranstellen [[wiki:namespaces]].
Beides wird durch ein Doppelpunkt getrennt.

Näheres zum Thema Namensräume steht unter wiki:namespaces.

Es ist möglich eine bestimmten Sektion einer Seite anzugeben. Wie in HTML üblich wird dazu der Sektionsname, getrennt durch ein '#'-Zeichen, an die URL angehängt. Der folgende Link zeigt auf diese Sektion this Section.

Anmerkung:

• Links zu existierenden Seiten existing pages werden in Grün und auf nicht existierende Seiten nonexisting in Rot dargestellt.
• DokuWiki benutzt in der Voreinstellung keine CamelCase zum automatischen erzeugen von Links. Dies kann aber in der config Datei eingeschaltet werden. Hinweis: Ist DokuWiki ein Link, dann ist diese Option eingeschaltet.
• Wird die Sektionsüberschrift geändert, verlieren alle Link darauf ihre Gültigkeit. Deshalb sollte man Links auf Sektionen nicht zu oft benutzen.

DokuWiki unterstützt wiki:interwiki Links. Das sind Kurzbezeichner zu anderen Wikis. Zum Beispiel ist das ein Link zur Wikipedia's Seite über Wikis: Wiki.

DokuWiki unterstützt [[doku>wiki:interwiki]] Links. Das sind Kurzbezeichner zu anderen Wikis. Zum Beispiel ist das 
ein Link zur Wikipedia's Seite über Wikis: [[wp>Wiki]].

Windows Netzverzeichnisse wie zum Beispiel this werden auch erkannt. Diese Art von Links ist nur sinnvoll inerhalb eines Firmen Intranet.

Windows Netzverzeichnisse wie zum Beispiel [[\\server\share|this]] werden auch erkannt. Diese Art von Links ist   
nur sinnvoll inerhalb eines Firmen [[wp>Intranet]].

Hinweis:

• Aus Sicherheitsgründen wird der Direktzugriff auf Netzverzeichnisse nur von Microsoft Internet Explorer unterstützt.

Man kann ein Bild zum Anzeigen eines Links benutzen, indem man den Syntax eines internen oder externen Links mit den eines Bildes (siehe weiter unten) kombiniert:

[[http://www.php.net|{{wiki:php-powered.png}}]]

Hinweis: Die Bildformatierung ist der einzige Formatierungssyntax, der in Anzeigenamen eines Links zulässig ist.

Fußnoten werden durch doppelte Klammern ¹⁾ eingefügt.

Fußnoten werden durch doppelte Klammern ((Das ist eine Fußnote)) eingefügt.

Es können bis zu fünf verschiedene Ebenen von Überschriften benutzt werden um den Text zu strukturieren. Werden mehr als drei Überschriften auf einer Seite platziert, wird automatisch ein Inhaltsverzeichnis angezeigt. Das kann man durch Angabe von ~~NOTOC~~ abschalten.

==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

Unter Verwendung von vier oder mehr Bindestriche kann eine horizontale Trennlinie erzeugt werden:

Interne oder externe Bilder werden mit doppelten, geschweiften Klammern eingebunden. Optional kann die Anzeigegröße mit angegeben werden.

Unskaliert:

Auf die angegebene Breite skaliert:

Auf angegebene Breite und Höhe skaliert:

Externes Bild:

Unskaliert: {{wiki:dokuwiki-128.png}}
Auf die angegebene Breite skaliert: {{wiki:dokuwiki-128.png?100}}
Auf angegebene Breite und Höhe skaliert: {{wiki:dokuwiki-128.png?80x80}}
Externes Bild: {{http://www.google.de/intl/de_de/images/logo.gif?150x50}}

Mit einen Leerzeichen vor oder/und nach den Link kann das Bild ausgerichtet werden.

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Selbstverständlich kann auch ein Titel angegeben werden. Die meisten Browser zeigen ihn als Hinweistext an.

{{wiki:dokuwiki-128.png | Das ist ein Titel}}

Wird ein Datei angegeben (egal ob extern oder intern), die kein Bild ist (gif,jpeg,png), dann wird ein Link statt eines Bildes angezeigt.

Dokuwiki unterstützt Aufzählungen und Listen. Zum Erzeugen eines Eintrages werden am Zeilenanfang zwei Leerzeichen gefolgt von einen * für eine Liste oder ein - für eine Aufzählung angegeben.

• Das ist eine Liste
• Der zweite Eintrag
  • Unterpunkte sind möglich
• Noch ein Eintrag

1. Die selbe Liste aber als Aufzählung
2. Ein weiterer Eintrag
   1. Für Unterpunkte einfach weitere einrücken
3. Mehr ist nicht erforderlich

  * Das ist eine Liste
  * Der zweite Eintrag
    * Unterpunkte sind möglich
  * Noch ein Eintrag

  - Die selbe Liste aber als Aufzählung
  - Ein weiterer Eintrag
    - Für Unterpunkte einfach weitere einrücken
  - Mehr ist nicht erforderlich

DokuWiki konvertiert gebräuchliche Smileys in ihre grafische Entsprechung. Zusätzliche Smileys können in das smiley Verzeichnis abgelegt und mittels Eintrag in die conf/smileys.conf Datei eingebunden werden. Hier ist ein Überblick über die in DokuWiki vorhandenen Smileys.

• 8-)
• 8-O
• :-(
• :-)
• =)
• :-/
• :-\
• :-?
• :-D
• :-P
• :-O
• :-X
• :-|
• ;-)
• ^_^
• :?:
• :!:
• LOL
• FIXME
• DELETEME

DokuWiki kann verschiedene Textzeichenfolgen in ihr typografisch korrekte Entsprechung umwandeln. Hier is eine Auflistung dererkannten Textzeichenfolgen:

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Hinweis: Diese Konvertierung kann in der Konfigurationsdatei abgeschaltet werden.

DokuWiki besitzt einen einfachen Syntax zum erzeugen von Tabellen.

Tabllenzeilen beginnen und enden mit einen |-Zeichen für normale Zeilen und mit einen ^-Zeichen für eine Kopfzeile.

^ Heading 1      ^ Heading 2       ^ Heading 3          ^
| Row 1 Col 1    | Row 1 Col 2     | Row 1 Col 3        |
| Row 2 Col 1    | some colspan (note the double pipe) ||
| Row 3 Col 1    | Row 2 Col 2     | Row 2 Col 3        |

Um zwei horizontal benachbarte Zellen zusammenzufassen, muss die rechte Zelle komplett leer sein, wie oben gezeigt. Jede Zeile muss die gleiche Anzahl von Trennzeichen beinhalten.

Vertikale Tabellenköpfe sind auch möglich.

Wie man leicht erkennenkann, bestimmt das Trennzeichen vor der Zelle die Formatierung:

|              ^ Heading 1            ^ Heading 2          ^
^ Heading 3    | Row 1 Col 2          | Row 1 Col 3        |
^ Heading 4    | no colspan this time |                    |
^ Heading 5    | Row 2 Col 2          | Row 2 Col 3        |

Hinweis: Es ist nicht möglich Zellen einer Spalte zusammen zu fassen.

Der Inhalt von Zellen kan ausgerichtet werden. Dazu werden zwei aufeinander folgende Leerzeichen benutzt. Links zwei Leerzeichen richtet den Inhalt nach Rechts aus und umgekehrt. Zum Zentrieren des Inhaltes werden rechts und links zwei Leerzeichen eingefügt.

So sieht der zugehörige Quelltext aus:

^           Table with alignment           ^^^
|         right|    center    |left          |
|left          |         right|    center    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Man kann Text vom Parsen ausschließen, indem man ihn um mindestens zwei Leerzeichen einrückt. Diese Methode wurde bei den bisherigen Beispielen verwendet. Des weiteren besteht die Möglichkeit, mehrzeiligen Text mit den Tags <code> oder <file> einzuschließen.

Das ist vorformatierte Text, alle Leerzeichen bleiben erhalten: Wie die              <-hier

<code>
Das ist vorformatierte Text, alle Leerzeichen bleiben erhalten: Wie die              <-hier
</code>

Das funktioniert genauso, sieht nur etwas anderst aus. Man kann 
es z.B. dazu benutzen Zitate optisch hervorzuheben.

<file>
Das funktioniert genauso, sieht nur etwas anderst aus. Man kann 
es z.B. dazu benutzen Zitate optisch hervorzuheben.
</file>

Soll der Parser einen Textbereich komplett unverändert lassen, dann kann man diesen Bereich mit den Tag <nowiki>, oder noch einfacher, mit doppelten Prozentzeichen %% von der Interpretation ausschließen.

Dieser Text enthält eine URL: http://www.splitbrain.org und Formatierungen **wäre sonst fett**, aber nichts geschieht mit diesen.

<nowiki>
Dieser Text enthält eine URL: http://www.splitbrain.org und Formatierungen **wäre sonst fett**, aber
nichts geschieht mit diesen.
</nowiki>

Zur Erhöhung der Lesbarkeit von Quelltexten unterstützt DokuWiki Syntaxeinfärbung. Dazu wird der Internetdienst Generic Syntax Highlighter (GeSHi) benutzt. Alle von diesem Dienst unterstützten Sprachen können angegeben werden. Der Syntax ist der selbe wie für Quelltextblöcke, im öffnenten Tag muss zusätzlich die Programmiersprache angegeben werden, z.B. <code java>.

/** 
 * The HelloWorldApp class implements an application 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 java>
/** 
 * The HelloWorldApp class implements an application 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>

Die folgenden Sprachen werden derzeit unterstützt: actionscript, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, html4strict, java, javascript, lisp, lua, nsis, objc, oobas, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, visualfoxpro, xml

Beispiele:

• <key>C-A-del</key> für Neustart. (<key>C-A-del</key>)
• <key>C - c</key> Text in die Zwischenablage kopieren. (<key>C - c</key>)
• <key>C-x</key> Text ausschneiden und in die Zwischenablage kopieren. (<key>C-x</key>)
• <key>C-v</key> Text aus der Zwischenablage kopieren. (<key>C-v</key>)
• <key>C-enter</key> einen Seitenwechsel einfügen. (<key>C-enter</key>)
• <key>C-S-Right</key> selektiert von aktueller Kursorposition bis zum Wortende. (<key>C-S-Right</key>)
• <key>C-S-Left</key> selektiert von aktueller Kursorposition bis zum Wortanfang. (<key>C-S-Left</key>)
• <key>C-PageUp</key> eine Seite aufwärts blättern. (<key>C-PageUp</key>)
• <key>C-Minus</key> (<key>C-Minus</key>)
• <key>'Beliebige Taste'</key> zum Beenden. (<key>'Beliebige Taste'</key>)

weitere Infos: http://wiki.foosel.net/snippets/dokuwiki/keyboard

Ein einfacher Rahmen:

<box> Der Text im Rahmen </box>

<box> Der Text im Rahmen </box>

Zwei etwas aufwändigere Rahmen <box 80% round orange|Ein Titel> Text im Rahmen </box>

<box 80% round orange|Ein Titel> Text im Rahmen </box>

<box 50% left blue>Inhalt des Rahmens</box| Untertitel >

<box 50% left blue>Inhalt des Rahmens</box| Untertitel >

Der vollständige Syntax:

<box width classes | Titeltext > Text im Rahmen </box | Untertitel >

• width — Breite des Rahmens in Prozent von 1% bis 100%.
• classes — eine Anzahl von Formatierungsbezeichner. Folgende Bezeichner sind definiert:
  • round — Rahmen mit abgerundeten Ecken
  • blue — blaues Farbschema
  • red — rotes Farbschema
  • green — grünes Farbschema
  • orange — oranges Farbschema
  • left — Linksausrichtung
  • right — Rechtsausrichtung
• Titeltext — Der Titeltext des Rahmens (darf dokuwiki Zeichenformatierung enthalten)
• Untertitel — Text für ein optionalen Untertitel (darf dokuwiki Zeichenformatierung enthalten)

Zwischen der öffnenden und der schließende Klammer eines Tags <box … > dürfen keine Zeilenumbrüche stehen.

Das Rahmen-Plugin unter Verwendung: siehe hier. Die Beispielseite zeigt alle Möglichkeiten der Rahmen-Formatierung.