dokuwiki:handbuch

Formatierungssyntax

DokuWiki unterstützt eine einfache „Auszeichnungssprache“ (Tags und Steuerformatierungen beschreiben den Text) die versucht die Datendateien so lesbar wie möglich zu machen. Diese Seite enthält alle möglichen Anweisungen die Sie beim Bearbeiten der Seiten benutzen können. Nach jedem Beispiel ist der Quelltext in einem Kasten beschrieben oder schauen sie sich einfach den Quelltext der Seite an indem sie die „Zeige Quelltext“-Schaltfläche am Anfang oder Ende der Seite drücken.

Wenn sie etwas versuchen wollen, nehmen sie einfach die Sandkasten Seite. Einen einfacheren Zugriff ermöglichen die Schnellzugriffsknöpfe.

DokuWiki unterstützt dick, kursiv, unterstrichen and nichtproportionale Schrift. Natürlich kann man auch alle kombinieren

DokuWiki unterstützt **dick**, //kursiv//, __unterstrichen__ and ''nichtproportionale Schrift''. 
Natürlich kann man auch alle **__//''kombinieren''//__**

Sie können auch Tiefgestellt und Hochgestellt formatieren.

Sie können auch <sub>Tiefgestellt</sub> und <sup>Hochgestellt</sup> formatieren.

Sie können etwas als <del>gelöscht</del markieren

Sie können etwas als <del>gelöscht</del markieren

Absätze werden durch leere Zeilen gemacht. Wenn sie eine neue Zeile erzwingen wollen (ohne einen Absatz zu benutzen), können sie zwei umgekehrte Schrägstriche (Backslash) gefolgt von einem Leerzeichen oder einem Zeilenende

Das ist eine beliebiger Text mit einigen Zeilenumbrüchen
Beachten sie das die beiden umgekehrte Schrägstriche nur am Ende einer Zeile
oder gefolgt von einem
Leerzeichen erkannt werden, \\das passiert ohne ihn.

Das ist eine beliebiger Text mit einigen Zeilenumbrüchen\\ Beachten sie das die
beiden umgekehrte Schrägstriche nur am Ende einer Zeile\\
oder gefolgt von einem \\ Leerzeichen erkannt werden, \\das passiert ohne ihn.

Sie sollten erzwungene Leerzeilen nur benutzen wenn sie wirklich nötig sind…

DokuWiki unterstützt verschiedene Wege um Links zu erstellen.

Externe Links werden automatisch erkannt: http://www.google.com oder einfach www.google.com - Sie können auch einen Linknamen vergeben: Dieser Link zeigt auf Google. Email Addressen wie diese: andi@splitbrain.org werden auch erkannt.

Externe Links werden automatisch erkannt: http://www.google.com oder einfach www.google.com - Sie können auch einen Linknamen vergeben:
[[http://www.google.de|Dieser Link zeigt auf Google]]. Email Addressen wie diese: <andi@splitbrain.org> werden auch erkannt.

Interne Links werden mit eckigen Klammern gekennzeichnet. Sie können entweder wiki:pagename, pagename oder auch einen Beschreibungstext angeben.

Interne Links werden mit eckigen Klammern gekennzeichnet. Sie können entweder [[doku>wiki:pagename]], [[wiki:pagename]] oder auch
einen [[doku>wiki:pagename|Beschreibungstext]] angeben.

Sie können Namensbereiche mit einem Doppelpunkt abtrennen.

Sie können [[wiki:namespaces|Namensbereiche]] mit einem Doppelpunkt abtrennen.

Namesbereiche sind ein sehr nützliches Mittel um Bereiche zu definieren, für mehr Informationen schauen sie unter Namesbereiche.

Um zu einer speziellen Sektion (einer Seite) zu verlinken muss man lediglich ein Rautezeichen anhängen, wie es aus HTML bekannt ist. Beispiel: Dieser Link verweist auf diese Sektion.

Beispiel: [[syntax#Interne Links|Dieser Link verweist auf diese Sektion]].

Anmerkungen

Tip: Wenn DokuWiki ein Link ist dann aber doch.

DokuWiki unterstüzt Interwiki links. Das sind schnelle Links zu anderen Wikis: Wiki.

DokuWiki unterstüzt [[doku>wiki:interwiki|Interwiki]] links. Das sind schnelle Links zu anderen Wikis: [[wp>Wiki]].

Windows Freigaben wie diese werden auch erkannt. Das macht natürlich nur in homogenen Usergruppen (wie in einem Unternehmensnetz Sinn.

Windows Freigaben wie [[\\Server\Freigabe|diese]] werden auch erkannt.

Anmerkungen:

  • Aus Sicherheitsgründen funktioniert das direkte Durchsuchen von Freigaben nur im Internet Explorer (und das auch nur in der lokalen Zone bzw. „Lokales Intranet“.
  • Für Mozilla and Firefox kann es durch die conf option eingeschaltet werden security.checkloaduri but this is not recommended
  • siehe auch 151 für mehr Informationen.

Sie können auch ein Bild als Link benutzen, indem man die Syntax für Links und Bilder (siehe unten) kombiniert. Beispiel:

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

Anmerkung: Die Bildformatierung ist die einzigste Formatierung die in Linknamen erlaubt ist.

Die ganze Bilder and Link syntax wird unterstützt (inklusive Bildgrößenänderungen, interne und externe Bilder, URLs und interwiki-Links).

Sie können Fußnoten hinzufügen 1) indem sie doppelte Klammern setzen.

Sie können Fußnoten hinzufügen (( das ist eine Fußnote)) indem sie doppelte Klammern setzen.

Sie können bis zu fünf verschiedene Überschriftenlevel für die Gliederung des Inhaltes einsetzen. Wenn sie mehr als drei Überschriften einsetzen wird automatisch ein Inhaltsverzeichnis generiert. Das kann durch die Zeichenkette ~~NOTOC~~ im Dokument abgeschaltet werden.

Überschrift Level 4

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

Eine horizontale Linie kann durch vier oder mehr Bindestriche erzeugt werden.


Sie können externe und interne Bilder mit geschweiften Klammern einfügen. Zusätzlich kann die Größe definiert werden.

Reale Größe:

Angepasst an eine gegebene Breite:

Angepasst an eine gegebene Breite und Höhe:

Angepasstes externes Bild:

Reale Größe: 					{{wiki:dokuwiki-128.png}}
Angepasst an eine gegebene Breite:		{{wiki:dokuwiki-128.png?50}}
Angepasst an eine gegebene Breite und Höhe: 	{{wiki:dokuwiki-128.png?200x50}}
Angepasstes externes Bild:          		{{http://de3.php.net/images/php.gif?200x50}}

Durch Leerzeichen rechts oder links kann man die Ausrichtung festlegen:

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

Natürlich kann man auch einen Bildbeschreibungstext festlegen. Dieser wird bei den meisten Browsern bei ruhendem Mauszeiger (über dem Bild) angezeigt.

Das ist der Bildbeschreibungstext

{{ wiki:dokuwiki-128.png |Das ist der Bildbeschreibungstext}}

Wenn Sie einen Dateinamen angeben, der kein Bild (gif,jpeg,png)ist, dann wird er statt dessen als Link angezeigt.

Um ein Bild als Link zu genutzen, siehe Bilder Links.

Dokuwiki unterstützt Aufzählungen und Nummerierungen. Rücken sie ihren Text um zwei Leerzeichen ein und setzen sie ein * für eine Aufzählung oder ein - für eine Nummerierung dahinter.

  • Das ist eine Aufzählung
  • ein Begriff
    • sie können auch verschiedene Level benutzen
  • noch ein Begrif
  1. Das gleiche aber nummeriert
  2. ein Begriff
    1. einfach eine Einrückung für untergeordnete Level benutzen
  3. Das war's
  * Das ist eine Aufzählung
  * ein Begriff
    * sie können auch verschiedene Level benutzen
  * noch ein Begrif

  - Das gleiche aber nummeriert
  - ein Begriff
    - einfach eine Einrückung für untergeordnete Level benutzen
  - Das war's

Dokuwiki wandelt weit verbreitete emoticons in ihre grafischen Entsprechungen um. Zusätzliche Smiley können im Smiley Ordner erstellt und in conf/smileys.conf konfiguriert. Hier ist eine Übersicht der mitgelieferten Smileys: ere is an overview of Smileys included in DokuWiki.

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

Außerdem kann man grafische Bearbeitungshinweise hinterlassen

  • FIXME FIXME (Repariere mich)
  • DELETEME DELETEME (Lösche mich)

DokuWiki kann einfache Textzeichen in ihre typografisch korrekten Entsprechungen umwandeln. Hier sind Beispiele erkannter Zeichen:.

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

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

Anmerkung: Diese Umwandlungen können in der Konfigurationsdatei ausgeschaltet werden.

Manchmal möchte man einen Text als Antwort oder Kommentat markieren. Dazu kann man folgende Syntax verwenden:

Ich denke wir sollten es tun
> Nein sollten wir nicht
>> Na gut, ich sage wir sollten!
> Wirklich?
>> Ja!
>>> Ok, dann machen wir´s!

Ich denke wir sollten es tun

Nein sollten wir nicht
Na gut, ich sage wir sollten!

Wirklich?

Ja!
Ok, dann machen wir´s!

DokuWiki unterstützt eine einfache Syntax zum Anlegen von Tabellen:

Überschrift 1 Überschrift 2 Überschrift 3
Zeile 1 Spalte 1 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Zeile 2 Spalte 1 Spaltenübergreifende Zelle (Beachten sie die doppelt „Pipe“-Symbol)
Zeile 3 Spalte 1 Zeile 2 Spalte 2 Zeile 2 Spalte 3

Überschriften müssen mit einem ^ anfangen und enden, Normale Tabellenzeilen mit |.

Überschrift 1 Überschrift 2 Überschrift 3
Zeile 1 Spalte 1 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Zeile 2 Spalte 1 Spaltenübergreifende Zelle (Beachten sie die doppelt „Pipe“-Symbol)
Zeile 3 Spalte 1 Zeile 2 Spalte 2 Zeile 2 Spalte 3

Zum verbinden von horizontalen Zeilen muss man nur die Zellen komplett leer machen, wie es oben gezeigt wird. Achten sie auf eine gleiche Anzahl von Zellteilern!

Vertikale Überschriften sind auch möglich:

Überschrift 1 Überschrift 2
Überschrift 3 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Überschrift 4 keine übergreifende Zelle diesmal
Überschrift 5 Zeile 2 Spalte 2 Zeile 2 Spalte 3

Wie mach sehen kann entscheidet der Zellteiler (vor einer Zelle) über die Formatierung:

Überschrift 1 Überschrift 2
Überschrift 3 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Überschrift 4 keine übergreifende Zelle diesmal
Überschrift 5 Zeile 2 Spalte 2 Zeile 2 Spalte 3

Anmerkung: Vertikal-verbundene Zelle sind nicht möglich.

Sie können der Tabelleninhalt auch eine Ausrichtung (links-, rechtsbündig und zentriert) geben: Einfach zwei Leerzeichen links, rechts oder auf beiden Seiten des Textes einfügen.

Tabelle mit Ausrichtung
rechts zentriert links
links rechts zentriert
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Das sieht im Quelltext so aus:

Tabelle mit Ausrichtung
rechts zentriert links
links rechts zentriert
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Sie können unformatierte Blöcke in ihr Dokument einfügen indem sie entweder mit zwei Leezeichen einrücken (wie im vorherigen Beispiel) oder indem sie die Anweisungen <code> oder <file> benutzen.

Das ist vorformatierter Code, alle Leerzeichen bleiben erhalten: wie man                      <- sieht
Das ist eigentlich das gleiche, man kann es nehmen um ein Zitat aus einer Datei zu kennzeichnen...

Um einen Bereich komplett von der Interpretierung durch Dokuwiki auszunehmen, umschließt man ihn einfach mit nowiki Anweisungen. Alternativ kann man auch (doppelte) %%-Zeichen nehmen.

Das ist Text, der Adressen wie http://www.splitbrain.org und **Formatierungen** enthält. Doch er wird nicht interpretiert.

<nowiki>
Das ist Text, der Adressen wie http://www.splitbrain.org und **Formatierungen** enthält. Doch er wird nicht interpretiert.
</nowiki>

DokuWiki kann Quellcode farbig darstellen um die Lesbarkeit zu vereinfachen. Es benutzt GeSHi (Generic Syntax Highlighter) – alle Sprachen die GeSHi unterstützt sind auch in DokuWiki enthalten. Die Syntax ist die gleiche wie bei den Unformatierten Blöcken oben, diesmal muss die benutzte Sprache angegeben werden:

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

Die folgenden Sprachen sind aktuell unterstützt:

actionscript, actionscript-french, ada, apache, applescript, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, javascript, lisp, lua, matlab, mpasm, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, ruby, vb, vbnet, vhdl, visualfoxpro, xml//

Sie können rohen HTML oder PHP-Code durch <html> oder <php>-Anweisungen in ihre Dokumente einfügen:

<html>
Das ist <font color="red" size="+1">HTML</font>
</html>

<html> Das ist <font color=„red“ size=„+1“>HTML</font> </html>

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

<php> echo 'Ein PHP-generiertes Logo:'; echo '<img src=„' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '“ alt=„PHP Logo !“ />'; </php>

Anmerkungen: HTML und PHP-Einbettung ist standardmäßig ausgeschaltet. Wenn es ausgeschaltet ist wird nur der Code angezeigt.

DokuWiki's syntax kann durch Plugins erweitert werden. Wie die Plugins benuzt werden, steht auf ihrer jeweiligen Beschreibungsseite. Die folgenden Plugins sind in dieser Dokuwiki-Installation verfügbar:

  • Box Plugin 2022-08-16 von Christopher Smith
    Boxes with titles, colour and rounded corners. Syntax: <box width class colours|title> ... </box|caption> width, class, colours title & caption are optional. The title can include some wiki markup, the box contents can include almost any wiki markup.
  • Dw2Pdf plugin 2023-11-25 von Andreas Gohr and Luigi Micco
    DokuWiki to PDF converter
  • Info Plugin 2020-06-04 von Andreas Gohr
    Displays information about various DokuWiki internals

1)
das ist eine Fußnote