Auf dieser Seite wird die Syntax zum Formatieren von DokuWiki-Seiten beschrieben.
Zum Ausprobieren oder Üben können Sie den Spielplatz verwenden.
Mit dem Knopf „Diese Seite bearbeiten“ wird die Bearbeitung gestartet. Einfache Formatierungen sind direkt durch die Buttons in der „Menüleiste“ über dem Editor erreichbar.
Am besten üben Sie das parallel zum Lesen des Textes in einen zweiten Fenster.
DokuWiki unterstützt fetten, kursiven, unterstrichenen und monospaced
Text. Natürlich kann auch alles kombiniert
werden.
DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''monospaced'' Text. Natürlich kann auch alles **__''kombiniert''//__** werden.
Ebenso gibt es tiefgestellten und hochgestellten Text.
Ebenso gibt es <sub>tiefgestellten</sub> und <sup>hochgestellten</sup> Text.
Text kann als gelöscht deleted markiert werden.
Text kann als gelöscht <del>deleted</del> markiert werden.
Ein Absatz wird durch eine leere Zeile erzeugt.
Eine neue Zeile (Zeilenumbruch) kann durch zwei "backslashes" (umgekehrte Schrägstriche: \\) gefolgt von einem Leerzeichen erzeugt werden.
Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.
Beachte die zwei umgekehrten Schrägstriche
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 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 gebraucht werden.
Mit 5 unterschiedliche Ebenen, getrennt durch Überschriften, kann der Inhalt einer Seite strukturiert werden.
Die Überschriften werden mit maximal sechs „=“ eingrahmt, je nach Größe. H1 ist die Überschrift auf höchster Ebene. Am einfachsten wird zur Erzeugung der Überschriften die Symbolleiste verwendet (auf die die Buttons H1
, H2
oder H3
klicken).
Es ist sinnvoll, immer eine Level 1 Überschrift an den Anfang eines Artikels zu setzen.
Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. Soll dieses Inhaltsverzeichnis nicht erstellt werden, muß der Befehl: ~~NOTOC~~
mit in die Seite aufgenommen werden.
====== Überschrift Ebene 1 ====== ===== Überschrift Ebene 2 ===== ==== Überschrift Ebene 3 ==== === Überschrift Ebene 4 === == Überschrift Ebene 5 ==
→ Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden!
Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner „code“ bzw „file“ benutzen:
Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier <-- zwischen
Mit "file": Eigentlich das Gleiche wie oben, sieht nur etwas anders aus. Eine neue Zeile wird auch immer als neue Zeile dargestellt.
Um jegliche Umwandlung durch Dokuwiki abzustellen, umschließt man den entsprechenden Bereich mit „nowiki“ Bezeichnern oder kürzer mit doppelten Prozentzeichen %%
.
Dieser Text enthält links wie: http://www.splitbrain.org und **Formatierungen** aber sie werden nicht umgesetzt und erscheinen als normaler Text.
Sie können sich einfach den Quelltext dieser Seite anschauen, um zu sehen, wie diese Blöcke angewendet werden.
Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das „größer als“ - Zeichen folgendermaßen verwendet:
Originaltext von Person A > Antwort von Person B >> Reaktion von Person C
Originaltext von Person A
Antwort von Person B
Reaktion von Person C
Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden:
Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com
Verweise können auch hinter eigenen Begriffen versteckt werden: 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>
Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt:
playground
Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: Beschreibung für einen Link.
Interne Links werden in doppelten eckigen Klammern gesetzt: [[playground:playground]] Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: [[playground:playground|Beschreibung für einen Link]].
Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt!
Umlaute sind genauso wie Sonderzeichen nicht erlaubt! (Verweis auf erlaubte Zeichen in Dateinamen - englisch)
Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst. Namensbereiche sind in etwa mit Verzeichnissen zu vergleichen, die man zur Strukturierung der Dateien benutzt. Alle Bilder einer Bildergallerie sollte man z.B. in einem eigenen Namensbereich ablegen.
Namensbereiche werden angelegt, in dem man beim Hochladen einer Datei (siehe unten) den Namen und einen Doppelpunkt vor den Dateinamen setzt (impressionen:sonnenuntergang:pic123.jpg).
Weitere Informationen zu Namensbereichen: wiki:namespaces.
Anmerkungen:
DokuWiki unterstützt auch Links in andere Wikis, sogenannte wiki:interwiki Links.
Ein Link zur Wikipedia Seite über Wikis:Wiki
DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>wiki:interwiki]] Links. \\ Ein Link zur Wikipedia Seite über Wikis:[[wp>Wiki]]
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}}]]
Das Hochladen von Bildern erfolgt über das Icon „Bilder und andere Dateien hinzufügen“, das sich oberhalb des Editor-Fensters befindet. Es öffnet sich ein neues Fenster. Dort kann man Dateien hochladen und in einen bestimmten Namespace unter einem bestimmten Namen ablegen. Danach kann man diese Datei(en) per Icon über dem Namen bzw. Bild in das Editorfenster übernehmen, bearbeiten oder löschen.
Wenn eine Datei angegeben wird, die kein Bild (gif,jpeg,png
) ist, so wird sie als Link angezeigt und so zum Download angeboten.
Mit geschweiften Klammern können sowohl externe als auch interne Bilder eingebunden werden. Optional kann deren Größe angegeben werden:
Größe für externe Bilder vorgeben:
Original Größ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}}
Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden (links, mitte, rechts). Bei Ausrichtung nach rechts oder links umfließt der nachfolgende Text das Bild dann auf der anderen Seite. Bei mittiger Ausrichtung geht der Text unter dem Bild weiter. Mit ~~CLEARFLOAT~~ wird das Umfließen beendet. ~~CLEARFLOAT~~
{{wiki:dokuwiki-128.png }} Mit Leerzeichen ... ~~CLEARFLOAT~~
Man kann auf diese Weise auch 3 Bilder im Blocksatz in eine Reihe stellen
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.
{{ wiki:dokuwiki-128.png |Dies ist ein Titel}}
Eine Bildergallerie, die alle Bilder aus einem Verzeichnis (d.h. aus einem Namensbereich) anzeigt, wird erstellt durch
{{gallery>impressionen:bellerkirche?lightbox}}
Der Namensbereich im Beispiel ist „impressionen:bellerkirche“. „lightbox“ sorgt dafür, dass jedes Bild quasi „vor“ der Seite angezeigt wird (mit Hilfe von JavaScript). Ohne den Parameter wird jedes angeklickte Bild auf einer neuen Seite angezeigt. (Lightbox ist der Name der zugrunde liegenden Software.)
Die Gallerie kennt weitere optionale Parameter
{{gallery>impressionen:bellerkirche?lightbox&80x80&1000X800&6}}
DokuWiki kennt sortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein „*“ für unsortierte oder ein „-“ für nummerierte Listen.
* Dies ist ein Eintrag einer unsortierten Liste * Ein zweiter Eintrag * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen * Noch ein Eintrag - Dies ist ein Eintrag einer nummerierte Liste - Ein zweiter Eintrag - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen - Noch ein Eintrag
Mit DokuWiki können Tabellen ganz einfach erstellt werden:
hervorgehoben | zum Beispiel für | eine Titelzeile |
---|---|---|
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 | Zeile2 Spalte 2 | Zeile 2 Spalte 3 |
Felder einer Tabelle starten mit „|“ für ein normales Feld oder mit einem „^“ für hervorgehobenes Feld.
^ hervorgehoben ^ zum Beispiel für ^ Titelzeile ^ | 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 | Zeile2 Spalte 2 | Zeile 2 Spalte 3 |
Zellen über mehrere Spalten werden erzeugt, wenn man, wie oben gezeigt, am Ende einer solchen Spalte soviele „|“ oder „^“ ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden.
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 |
Anmerkung: Felder über mehrere Zeilen werden nicht unterstützt.
Tabelle mit Ausrichtung | ||
---|---|---|
Rechts | Mitte | Links |
Links | Rechts | Mitte |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
So sieht die Formatierung aus:
^ Tabelle mit Ausrichtung ^^^ | Rechts| Mitte |Links | |Links | Rechts| Mitte | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Fußnoten 1) werden durch eine doppelte runde Klammer dargestellt 2). 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 duch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote))
Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horrizontale Linie erzeugt werden:
----
Dokuwiki verwandelt oft genutzte emoticons zu kleinen Smily-Grafiken. Hier ist eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys:
8-) | 8-O | :-( | :-) | =) | :-/ | :-\ | :-? | :-D | :-P | :-O | :-X | :-| | ;-) | :?: | :!: | LOL | FIXME | DELETEME |
sowie ^_^ 3)
DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.
Hier eine Liste aller Zeichen, die DokuWiki kennt:
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
Diese Seite ist eine Übersetzung und Anpassung der englischen Syntax Seite.
— Arno Mann 18.10.2006 00:21