Dies ist eine alte Version des Dokuments!


Syntaxregeln

Das DokuWiki besteht aus einer einfachen Beschreibungssprache die versucht die Files mit den „Rohdaten“ so lesbar wie möglich zu machen. Auf dieser Seite sind alle Syntaxregeln zusammengefasst die benötigt werden um Seiten zu editieren. Den Sourcecode dieser Seite sieht man durch drücken des Diese Seite bearbeiten-Knopfes oben oder unten auf dieser Seite. Wenn Du etwas ausprobieren möchtest dann benutzte bitte die playground Seite. The simpler markup is easily accessible via quickbuttons, too.

DokuWiki unterstützt fetten, schrägen, unterstrichenen and monospaced text. Natürlich sind auch alle Kombinationen davon möglich.

DokuWiki unterstützt **fetten**, //schrägen//, __unterstrichenen__ and ''monospaced'' text.
Natürlich sind auch alle **__//''Kombinationen''//__** davon möglich.

Du kannst auch tiefgestellten und hochgestellten Text verwenden.

Du kannst auch <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text verwenden.

Du kannst ebenfalls etwas als gelöscht markieren.

Du kannst ebenfalls etwas als <del>gelöscht</del> markieren.

Absätze werden automatisch durch eine Leerzeile erstellt. Wenn Du einen manuellen Zeilenumbruch ohne Absatz erreichen möchtest so musst Du zwei Backslashes gefolgt von einem Leerzeichen einfügen.

Dies ist ein Beispieltext mit ein paar Zeilenumbrüchen.
Beachte bitte, daß die beiden Backslashes nur am Ende der Zeile
oder durch ein Leerzeichen gefolgt
beachtet werden. Hier \\passiert nichts.

Dies ist ein Beispieltext mit ein paar Zeilenumbrüchen.\\ Beachte
bitte, daß die beiden Backslashes nur am Ende der Zeile\\
oder durch ein Leerzeichen gefolgt\\ beachtet werden. Hier \\passiert nichts.

Du solltest manuelle Zeilenumbrüche nur da einsetzen wo Sie wirklich benötigt werden.

DokuWiki unterstützt viele verschiedene Arten von Links.

Externe Links werden automatisch erkannt: http://www.google.de oder nur www.google.de Du kannst auch den Anzeigenamen der Links beeinflussen: Dieser Link führt zu Google. Emailadressen werden so dargestellt: andi@splitbrain.org.

Externe Links werden automatisch erkannt: http://www.google.de oder nur www.google.de
Du kannst auch den Anzeigenamen der Links beeinflussen: [[http://www.google.de|Dieser Link führt zu Google]].
Emailadressen werden so dargestellt: <andi@splitbrain.org>.

Interne Links werden mit eckigen Klammern erzeugt. Du kannst nur den wiki:seitennamen oder auch zusätzlich einen Titel Text anzeigen. Die Seitennamen im Wiki werden automatisch in Kleinbuchstaben umgewandelt. Sonderzeichen sind nicht erlaubt.

Interne Links werden mit eckigen Klammern erzeugt. Du kannst nur den [[doku>wiki:seitennamen]]
oder auch zusätzlich einen [[doku>wiki:pagename|Titel Text]] anzeigen. Die Seitennamen im Wiki
werden automatisch in Kleinbuchstaben umgewandelt. Sonderzeichen sind nicht erlaubt. 

Du kannst namespaces mit einem Doppelpunkt verwenden.

Du kannst [[wiki:namespaces]] mit einem Doppelpunkt verwenden.

Hier findest Du Details zu den wiki:namespaces.

Ein Link auf einen bestimmten Abschnitt einer Seite ist ebenfalls möglich. Einfach den Abschnittsnamen wie in HTML üblich hinter ein Doppelkreuz schreiben. Dies verlinkt einen Interner Abschnitt.

Dies verlinkt einen [[syntax#abschnitt|Interner Abschnitt]]

Bemerkung:

  • Links zu existierenden Seiten werden anders angezeigt, als Links zu nicht existierenden Seiten.
  • DokuWiki verwendet nicht automatisch CamelCase um Links zu erzeugen, dieses Verhalten kann aber in der config Datei eingestellt werden. Hinweis: Wenn DokuWiki ein Link ist, dann wird er auch aktiviert.
  • Wenn sich eine Abschnitts-Überschrift ändert, dann ändert sich auch sein Lesezeichen.

Interwiki

DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.

DokuWiki supports [[doku>wiki:interwiki|Interwiki]] links. These are quick links to other Wikis.
For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].

Windows Shares

So werden Windowsfreigaben dargestellt. Dies mach natürlich nur innerhalb eines Intranet sinn.

So werden [[\\server\share|Windowsfreigaben]] dargestellt.

Bemerkung:

  • Aus Sicherheitsgründen lassen sich Windowsfreigaben standardmäßig nur im Microsoft Internet Explorer verwenden. (und hier auch nur in der „Lokalen Zone“).
  • In Mozilla und Firefox kann dies mit der Option security.checkloaduri konfiguriert werden. Davon wird allerdings abgeraten.
  • Unter 151 findest Du mehr Informationen.

Um eine Grafik für einen internen oder externen Link zu verwenden, musst Du die Syntax einfach wie folgt kombinieren:

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

Bitte beachten: Die Formatierung von Grafiken ist die einzige im Linknamen akzeptierte Formatierung.

Du kannst Fußnoten 1) durch doppelte Klammernsetzung hinzufügen.

Du kannst Fußnoten ((Dies ist eine Fußnote)) durch doppelte Klammernsetzung hinzufügen.

Du kannst bis zu fünf verschiedenen Stufen von Überschriften einsetzen um Dein Dokument zu formatieren. Wenn mehr als drei Überschriften existieren dann wird automatisch ein Inhaltsverzeichniss für diese Seite eingefügt. Dieses Verhalten kann durch das Einfügen von ~~NOTOC~~ im Dokument verhindert werden.

Level 3 Überschrift

Level 4 Überschrift

Level 5 Überschrift
==== Level 3 Überschrift ====
=== Level 4 Überschrift ===
== Level 5 Überschrift ==

Durch das verwenden von vier oder mehr Trennstrichen wird eine horizontale Linie erzeugt.


Mit geschweiften Klammern kannst Du interne und externe Grafiken einfügen. Optional lässt sich auch eine Größe festlegen.

Orginal Größe:

Feste Breite:

Feste Breite und Höhe:

Angepasste externe Grafik:

Orginal Größe:                    {{wiki:dokuwiki-128.png}}
Feste Breite:                     {{wiki:dokuwiki-128.png?50}}
Feste Breite und Höhe:            {{wiki:dokuwiki-128.png?200x50}}
Angepasste externe Grafik:        {{http://de3.php.net/images/php.gif?200x50}}

Die Ausrichtung wird durch ein Leerzeichen Links oder Rechts festgelegt

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

Natürlich kann man auch eine Beschreibung angeben die meist als Tooltip dargestellt wird.

Hier steht eine Bemerkung zum Bild

{{ wiki:dokuwiki-128.png |Hier steht eine Bemerkung zum Bild}}

Wenn Du auf eine interne oder externe Datei verweist die keine Grafik ist, so wird stattdessen ein Link angezeigt.

Dokuwiki unterstützt nummerierte und aufgezählte Listen. Um einen Listenpunkt zu erzeugen, beginne Deinen Text mit zwei Leerzeichen und einem * für aufgezählte Listen, oder einem - für nummerierte Listen.

  • Dies ist eine Liste
  • Der zweite Eintrag
    • Es gibt verschiedene Abstufungen
  • Noch ein Eintrag
  1. Die selbe Liste nummeriert
  2. Der zweite Eintrag
    1. Verwende eine Einrückung für tiefere Stufen.
  3. Genau so funktioniert es
  * Dies ist eine Liste
  * Der zweite Eintrag
    * Es gibt verschiedene Abstufungen
  * Noch ein Eintrag

  - Die selbe Liste nummeriert
  - Der zweite Eintrag
    - Verwende eine Einrückung für tiefere Stufen.
  - Genau so funktioniert es

Dokuwiki konvertiert die am meisten verwendeten emoticons in die grafische Darstellung. Eigene Smileys können im Smiley-Verzeichniss abgelegt werden und unter conf/smileys.conf eingetragen werden. Hier ist eine Liste mit den Smileys die im Lieferumfang vom DokuWiki dabei sind.

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

DokuWiki kann auch einfache Typografische Zeichen in den richtigen HTML-Code umsetzen. Die Darstellung hängt aber letztendlich vom Browser ab.

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

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

Bitte beachten: Diese Konvertierung kann in der Konfiguration abgeschaltet werden.

Manchmal möchte man einen Text markieren, damit ersichtlich wird dass es sich um eine Antwort oder Kommentar handelt. Hierfür ist die folgende Syntax:

Ok. dann am Dienstag.

Nein, ich denke am Dienstag ist besser.
Können wir uns am Montag treffen?
Ok. dann am Dienstag.
> Nein, ich denke am Dienstag ist besser.
>> Können wir uns am Montag treffen?

DokuWiki bietet eine einfach Syntax um Tabellen darzustellen.

Überschrift 1 Überschrift 2 Überschrift 3
Zeile 1 Spalte 1 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Zeile 2 Spalte 1 Verbunde Zellen (Beachte die beiden pipes ohne Leerzeichen dazwischen)
Zeile 3 Spalte 1 Zeile 3 Spalte 2 Zeile 3 Spalte 2

Normale Spalten beginnen und enden mit einem |, Überschriften mit einem ^.

^ Überschrift 1    ^ Überschrift 2     ^ Überschrift 3      ^
| Zeile 1 Spalte 1 | Zeile 1 Spalte 2  | Zeile 1 Spalte 3   |
| Zeile 2 Spalte 1 | Verbunde Zellen (Beachte die beiden pipes ohne Leerzeichen dazwischen) ||
| Zeile 3 Spalte 1 | Zeile 3 Spalte 2  | Zeile 3 Spalte 2   |

Um zwei nebeneinander liegende Zellen zu verbinden muss die nächste Zelle einfach leer bleiben. Die Anzahl der Zelltrenner in eine Zeile muss aber immer gleich bleiben.

Überschriften sind auch in der ersten Spalte möglich.

Überschrift 1 Überschrift 2
Überschrift 3 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Überschrift 4 Diesmal keine verbundenen Zellen
Überschrift 5 Zeile 3 Spalte 2 Zeile 3 Spalte 3

Wie man sieht bestimmt der Zelltrenner vor der Zelle über deren formatierung.

|               ^ Überschrift 1        ^ Überschrift 2      ^
^ Überschrift 3 | Zeile 1 Spalte 2     | Zeile 1 Spalte 3   |
^ Überschrift 4 | Diesmal keine verbundenen Zellen |  |
^ Überschrift 5 | Zeile 3 Spalte 2     | Zeile 3 Spalte 3   |

Bemerkung: Vertikale Verbindungen von Zellen sind nicht möglich.

Ausrichtungen innerhalb von den Zellen sind durch das Einfügen von zwei Leerzeichen möglich. Zwei Leerzeichen rechts richten den Text nach Links, zwei Leerzeichen links richten den Text nach rechts. Zwei Leerzeichen auf beiden Seiten zentrieren den Text.

Tabelle mit Ausrichtung
rechts zentriert links
links rechts zentriert
xxxx dummy xxxx xxxx dummy xxxx xxxx dummy xxxx

So wirds gemacht:

^  Tabelle mit Ausrichtung  ^^^ 
|          rechts |    zentriert    | links           |
| links           |          rechts |  zentriert      |
| xxxx dummy xxxx | xxxx dummy xxxx | xxxx dummy xxxx |

Du kannst in Deine Dokumente Abschnitte einfügen die vom Dokuwiki nicht interpretiert werden. Die Zeilen beginnen (wie in den vorher verwendeten Beispielen) mit mindestens zwei Leerzeichen oder werden durch die Tags code oder file eingeschlossen.

Dies ist ein formatierter Text bei dem alle Leerzeichen dargestellt werden. Wie zum Beispiel:               <- hier.
Dies ist Quasi das Selbe. Wird verwendet um den Inhalt einer Datei darzustellen.

Um den Interpreter einen Abschniss komplett ignorieren zu lassen kann man die Tags nowiki verwenden oder einfach in zwei Prozentzeichen %% einschließen.

Dieser Text enthält Links wie http://www.splitbrain.org und **formatierungen** die nicht interpretiert werden.

Schau Dir den Quellcode zu dieser Seite an, um zu sehen wie die Tage verwendet werden.

DokuWiki kann beim Quellcode von Programmiersprachen die Syntax hervorheben, damit dieser besser Lesbar wird. Hier wird der GeSHi - Generic Syntax Highlighter verwendet. Alle vom GeSHi unterstützten Sprachen werden auch im Dokuwi richtig dargestellt. Die syntax ist dieselbe wie im vorhergegangenen Codebeispiel, nur wird in der ersten Zeile der Name der Programmiersprache mitgegeben. 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.
    }
}

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

Mit den Tags html oder php kannst Du HTML oder PHP code in Deinen Dokumenten verwenden.

<html>
Hier ein bisschen <font color="red" size="+1">HTML</font>
</html>

Hier ein bisschen HTML

<php>
echo 'Ein von PHP erzeugtes Logo:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

echo 'Ein von PHP erzeugtes Logo:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';

Bitte Beachten:
Das Einbinden HTML und PHP ist in der Standardkonfiguration deaktiviert. In diesem Fall wird der Code nicht Ausgeführt, sondern Angezeigt.

1)
Dies ist eine Fußnote