Sunny Sönke Lindner - Mediator (FH)

Syntax

DokuWiki zeichnet sich u. a. durch einfache Textformatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar. 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 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 „Vorschau“.

Zum Ausprobieren oder Üben kann die Spielwiese verwendet werden.

1 Texte

1.1 Formatierungen

DokuWiki unterstützt fetten, kursiven, unterstrichenen und dicktengleichen (Dickte) Text. Natürlich kann auch alles kombiniert werden.

DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__ und ''dicktengleichen'' Text. 
Natürlich kann auch alles **__//''kombiniert''//__** werden.

1.2 Absätze

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 notwendig sind.

1.3 Überschriften

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.

Wenn in einer Seite mehr als drei Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. Soll dieses Inhaltsverzeichnis nicht erstellt werden, muss 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 standardmäßig keine weiteren Formatierungen vorgenommen werden! (s. FAQ - Headerlinks)

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 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

1.6 Zitat / Kommentar

Um einen Text als Zitat oder Kommentar zu kennzeichnen, wird das „größer als“ - Zeichen folgendermaßen verwendet:

Ich denke wir sollten es tun.

> Nein, sollten wir nicht.

>> Doch!

Ich denke wir sollten es tun

Nein, sollten wir nicht.
Doch!

1.8 Fußnoten

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 durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote))

2 Links

Mit DokuWiki können fünf unterschiedliche Arten von Links benutzt werden:

2.1 Extern

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>.

2.2 Intern

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): pagename

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:
[[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! Umlaute sind genauso wie Sonderzeichen nicht erlaubt!

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}}]]

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

3.2 Größe von Bildern

Mit geschweiften Klammern können sowohl externe als auch interne Bilder eingebunden werden. Das Bild heißt in diesem Beispiel „dokuwiki-128.png“. Optional kann deren Größe angegeben werden:

Originalgröße:

Eine Breite vorgeben:

Breite und Höhe vorgeben:

Größe für externe Bilder vorgeben:

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).

Rechts

Links

Zentriert

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

Bei Ausrichtung und der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt:

{{ wiki:dokuwiki-128.png|Rechtsbündig}}
{{wiki:dokuwiki-128.png |Linksbündig}}
{{ wiki:dokuwiki-128.png |Zentriert }}

3.4 Tooltips

Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.

Dies ist ein Titel

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

3.5 Dateidownload

Wenn eine Datei angegeben wird, die kein Bild (gif, jpeg, png) ist, so wird sie als Link angezeigt und so zum Download angeboten.

Beispiel

{{ wiki:dokuwiki-128.txt |Beispiel}}

3.6 Automatische Verlinkung

Bilder werden automatisch mit einer Verlinkung zur Ihren Metadaten erstellt - Bsp.:

Dieses Verhalten kann über die Option ?nolink3) unterbunden werden4):

{{wiki:dokuwiki-128.png?15&nolink}}

Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:

{{wiki:dokuwiki-128.png?15&direct}}

4 Listen

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.

  • Dies ist ein Eintrag einer unsortierten Liste
  • Ein zweiter Eintrag
    • Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
  • Noch ein Eintrag
  1. Dies ist ein Eintrag einer nummerierte Liste
  2. Ein zweiter Eintrag
    1. Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
  3. Noch ein Eintrag
  * 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
  - Ein zweiter Eintrag
    - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen
  - Noch ein Eintrag

6 sonstige Formatierungen

6.1 horizontale Linie

Mit vier aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:


----

6.2 Smileys

DokuWiki verwandelt oft genutzte Emoticons zu kleinen Smiley-Grafiken. 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-O :-( :-) =) :-/ :-\ :-? :-D :-P :-O :-X :-| ;-) :?: :!: ^_^ LOL FIXME DELETEME

6.3 Typografie

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'..."

Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden


1) dies ist eine Fußnote
2) eine zweite Fußnote
3) ggf. mit einem „&“ mit anderen Optionen wie der Größenangabe kombinieren
4) Standardmäßig lässt sich dieses, oft unerwünschte, Verhalten momentan (13.03.2009) nicht für das komplette DokuWiki deaktivieren