Benutzer-Werkzeuge

Webseiten-Werkzeuge


wiki:syntax

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 „Zeige Quelltext“.

Zum Ausprobieren oder Üben kann die Spielwiese verwendet werden.

Texte

Formatierungen

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

DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenen__
und ''dicktengleichen'' 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 markiert werden.

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

Absätze

Ein Absatz wird durch eine leere Zeile im Text erzeugt. Eine neue Zeile (Zeilenumbruch) ohne Absatz 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.

Explizite Zeilenumbrüche durch zwei „Backslashes“ sollten nur sparsam verwendet werden, am besten gar nicht.

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

====== Überschrift Ebene 1 ======
===== Überschrift Ebene 2 =====
==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

unformatierte Abschnitte

Um Text so anzuzeigen wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man eine Zeile mit zwei Leerzeichen beginnen, so wie es im Quellcode dieser Seite angewendet wirde. Oder der Text wird mit einem Bezeichner „code“ bzw. „file“ geklammert.

In diesem **Text** werden keine Formatierungen angewendet
und Zeilenumbrüche sowie     Leerzeichen     werden beibehalten.
<code>
In diesem **Text** werden keine Formatierungen angewendet
und Zeilenumbrüche sowie     Leerzeichen     werden beibehalten.
</code>

Wird ein Text mit „file“ geklammert, so kann er einfach heruntergeladen werden.

Beispiel.txt
Mit dem Bezeichner "file" kann ein Text als Bestandteil einer Datei
direkt zum Download angeboten werden. (Per Klick auf den Dateinamen)
<file plain Beispiel.txt>
Mit dem Bezeichner "file" kann ein Text als Bestandteil einer Datei
direkt zum Download angeboten werden. (Per Klick auf den Dateinamen)
</file>

Innerhalb von „code“ und „file“ ist auch Syntax-Hervorhebung aktivierbar. (s.u.)

Syntax-Hervorhebung

DokuWiki kennt Syntax-Highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält: <code java> Quelltext </code>

/**
 * 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.
    }
}

Zitat / Kommentar

Um einen Text als Zitat oder Kommentar zu kennzeichnen, wird das „größer als“ Zeichen > verwendet. Das sieht dann ähnlich aus wie z.B. in Mails. Auch dabei können wieder verschiedene Ebenen verwendet werden.

Ich denke wir sollten es jetzt tun.
Nein, sollten wir nicht.

Doch!

Wirklich?
Ich weiß auch nicht..

Los jetzt!

Dann lasst es uns tun
Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt.
> Ich denke wir sollten es jetzt tun.
>> Nein, sollten wir nicht.
> Doch!
>> Wirklich?
>>> Ich weiß auch nicht..
> Los jetzt!
>> Dann lasst es uns tun

>>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt.

Fußnoten

Fußnoten1) werden durch eine doppelte runde Klammer dargestell 2). Der Text zwischen den Klammern wird an das Ende der Seite geschrieben, kann aber mit einem Mousover angezeigt werden. Die Reihenfolge und die Nummerierung übernimmt DokuWiki automatisch.

Fußnoten((dies ist eine Fußnote)) werden durch eine doppelte
runde Klammer dargestellt((eine zweite Fußnote))

Escapezeichen

Will man komplett verhindern, dass DokuWiki irgendwelche Formatierungen bzw. Umwandlungen im Text vornimmt so kann man die Prozentzeichen benutzen.

%%[[wiki:testseite|Testseite]]%%

Die Ausgabe würde dann folgendermaßen aussehen [[wiki:testseite|Testseite]]

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

Tabellen

Grundlegender Aufbau

Mit DokuWiki können Tabellen ganz einfach im Quellcode erstellt werden. Felder einer Tabelle starten mit „|“ (normales Feld) oder mit einem „^“ (hervorgehobenes Feld).

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 Zeile 2 Spalte 2 Zeile 2 Spalte 3
Zeile 4 Spalte 1 Zeile 4 Spalte 3
^ 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    | Zeile 2 Spalte 2                                                   | Zeile 2 Spalte 3        |

Leerzellen / Hervorhebung

Zellen über mehrere Spalten werden erzeugt wenn man, wie oben gezeigt, am Ende einer solchen Zeile so viele „|“ oder „^“ 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. Der Feldtrenner („|“ oder „^“) vor einer Zelle entscheidet ü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
|                    ^ 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. 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
^ 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
^ 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         |

Zellenausrichtung

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
Rechts Mitte Links
Links Rechts Mitte
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx
^          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“.

Links

Mit DokuWiki können mehrere 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. Links können auch hinter eigenen Begriffen versteckt werden: hier ist google. E-Mail Adressen werden in spitze Klammern gesetzt: andi@splitbrain.org.

Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt:
http://www.google.com oder einfach www.google.com.
Links 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 („AltGr+8“ bzw. „AltGr+9“). Befindet sich eine Seite in einem Namespace 3), so muss dieser ebenfalls mit einem Doppelpunkt als Trenner angegeben werden.

playground

[[playground:start]]

Auch ein interner Link kann hinter einem Begriff oder einer Beschreibung versteckt werden:.

Spielwiese zum Ausprobieren

[[playground:start|Spielwiese zum Ausprobieren]]

Dateinamen für neue Seiten im Wiki werden automatisch in Kleinbuchstaben umgewandelt! Umlaute sind genauso wie Sonderzeichen nicht erlaubt!

Die Verlinkung zu einem speziellen Abschnitt (einer Überschrift) innerhalb des Dokuments ist auch möglich. Man nennt dies „Anker“. Der Anker wird getrennt durch ein Doppelkreuz „#“ an den Seitennamen gehängt.

Dieses Beispiel verlinkt zu diesem Abschnitt.

Dieses Beispiel verlinkt zu [[syntax#Links|diesem Abschnitt]].

Anmerkungen:

  • Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
  • Ändert sich eine Überschrift im Zieldokument, führt der Anker ins Leere ohne dass der Link dabei als fehlerhaft angezeigt wird.
  • Anker werden klein geschrieben, es werden Leerzeichen mit Unterstrichen und Umlaute mit ihren Umschreibungen (ä = ae) verwendet.

Auch Bilder können für einen Link auf eine interne oder externe Seite verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern kombiniert.

[[https://www.dokuwiki.org/start?id=de:dokuwiki|{{wiki:dokuwiki-128.png?100}}]]

Bilder und andere Dateien

Bilder im DokuWiki speichern

Um Bilder im DokuWiki speichern zu dürfen, muss der Benutzer die entsprechende Berechtigung besitzen (ACL). Zum Hochladen ist mindestens die Berechtigung „Hochladen“ (engl. „Upload“), zum Löschen „Entfernen“ (engl. „Delete“) für den Namensraum erforderlich.

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:

Maximal 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}}
Maximale Breite und Höhe vorgeben:   {{wiki:dokuwiki-128.png?200x50}}
Größe für externe Bilder vorgeben:   {{https://www.php.net/images/php.gif?100x50}}

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

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

Dateidownload

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

Beispiel

{{ dokuwiki-128.png |Beispiel}}

Verlinkung von Bildern

Bilder werden standardmäßig mit einer Verlinkung zur Ihren Metadaten erstellt. Ein Klick auf das Bild ruft eine Informationsseite auf.

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

Dieses Verhalten kann über die Option ?nolink4) unterbunden werden.

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

Außerdem kann mit ?direct die Bilddatei direkt verlinkt werden:

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

sonstige Formatierungen

horizontale Linie

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


----

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

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

Kontroll-Makros

Einige Syntax-Befehle beeinflussen wie Dokuwiki eine Seite beim Aufruf ausgibt. Die folgenden Kontroll-Makros sind verfügbar:

Makro Beschreibung
~~NOTOC~~ Wenn dieses Makro in eine Seite eingebunden ist, wird das 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.
1)
dies ist eine Fußnote
2)
eine zweite Fußnote
3)
Weitere Informationen zu Namensbereichen: de:namespaces.
4)
ggf. mit „&“ mit anderen Optionen wie der Größenangabe kombinieren
wiki/syntax.txt · Zuletzt geändert: 2020/02/14 11:49 von localwed