Formatting Syntax

DokuWiki unterstützt einige Formatierungsmöglichkeiten um die Lesbarkeit der Textseiten zu vereinfachen. Diese beschreibt alle möglichen Formatierungen, welche du bei der Bearbeitung von Seiten nutzen kannst. Schaut euch einfach mal den Quelltext mithilfe des Diese Seite bearbeiten Button oben links auf der Seite an. Wenn du etwas ausprobieren möchtest kannst du die Spielwiese benutzen. Die einfacheren Formatierungen sind auch über die Quickbuttons benutzbar.

Einfache Textformatierung

DokuWiki unterstützt fetten, kursiven, unterstrichenenen sowie breitengleicher Text. Natürlich kannst du diese auch kombinieren.

DokuWiki unterstützt **fetten**, //kursiven//, __unterstrichenenen__ sowie ''breitengleicher'' Text.
Natürlich kannst du diese auch **__//''kombinieren''//__**..

Du kannst den Text auch tiefstellen beziehungsweise hochstellen.

Du kannst den Text auch <sub>tiefstellen</sub> beziehungsweise <sup>hochstellen</sup>.

Du kannst Text auch als gelöscht markieren.

Du kannst Text auch als <del>gelöscht</del> markieren.

Absätze werden durch Leerzeilen erstellt. Wenn du eine neue Zeile erzwingen möchtest, dann beende die Zeile mit zwei umgekehrten Schrägstrichen, gefolgt von einem Leerzeichen.

Dies ist ein Beispieltext mit einigen Zeilenumbrüchen
Beachte, dass die zwei umgekehrte Schrägstrichen nur dann erkannt werden,
wenn sie am Ende einer Zeile stehen oder von einem
Leerzeichen gefolgt werden. \\So sieht es ohne Leerzeichen aus.

Dies ist ein Beispieltext mit einigen Zeilenumbrüchen\\ Beachte, dass die
zwei umgekehrte Schrägstrichen nur dann erkannt werden,\\
wenn sie am Ende einer Zeile stehen oder von einem\\ Leerzeichen gefolgt
werden. \\So sieht es ohne Leerzeichen aus.

Du solltest erzwungene neue Zeilen nur dann verwenden, wenn du sie unbedingt benötigst.

Links

DokuWiki unterstützt mehrere Möglichkeiten Verlinkungen zu erstellen.

Extern

Externe Links 1) werden automatisch erkannt: http://www.google.de oder einfach www.google.de - Du kannst auch den Linktext setzen: Dieser Link verweist auf Google. Email Adressen werden in spitze Klammen gesetzt: user@example.com

Externe Links werden automatisch erkannt: http://www.google.de or simply www.google.de -
Du kannst auch den Linktext setzen: [[http://www.google.de|Dieser Link verweist auf Google]].
Email Adressen werden in spitze Klammen gesetzt: <user@example.com>

Intern

Interne Links 2) werden in doppelte eckige Klammen gesetzt. Dieser Link kann nur aus dem Seitennamen oder aus einem zusätzlichen Linktext bestehen.

Interne Links werden in doppelte eckige Klammen gesetzt. Dieser
Link kann nur aus dem [[Seitennamen]] oder aus einem
zusätzlichen [[Seitennamen|Linktext]] bestehen.

Wiki Seitennamen werden automatisch in Kleinbuchstaben umgewandelt. Umlaute wie auch Sonderzeichen sind nicht erlaubt!

Durch einen Doppelpunkt werden Namensbereiche im DokuWiki getrennt.

Durch einen Doppelpunkt werden [[wiki:Namensbereiche]] im DokuWiki getrennt.

Weitere Informationen kannst du unter de:namespaces finden.

Es ist auch möglich auf bestimmte Abschnitte zu verlinken. Füge an den Link noch ein Rautenzeichen (#) an, gefolgten von der Überschrift des Abschnitts. Dieser Link verweist auf diesen Abschnitt.

Dieser Link verweist auf diesen [[syntax#Intern|Abschnitt]].

Anmerkungen:

  • Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
  • Dieses DokuWiki verwendet keine CamelCase für Links.
  • Wenn die Überschrift eines Abschnitts geändert wird, dann ändert sich auch der Link auf diesen Abschnitt. Verlasse dich also nicht all zu sehr auf Links zu Abschnitte.

Interwiki

DokuWiki unterstützt Interwiki Links3). Zum Beispiel zeigt dieser Link auf den Wikipedia Artikel zu Wiki: Wiki.

DokuWiki unterstützt [[doku>Interwiki]] Links.
Zum Beispiel zeigt dieser Link auf den Wikipedia Artikel zu Wiki: [[wp>Wiki]].

Dieses Dokuwiki stellt Interwiki Links zu den folgenden Wikis bereit:

  • Englische Wikipedia ⇒ wp
  • Deutsche Wikipedia ⇒ wpde
  • Deutsche Google Suche ⇒ google.de
  • Dokuwiki Projekt ⇒ doku
  • Valve Developer Wiki ⇒ valve

Bilder als Links

Bilder können als Link auf eine interne oder externe Datei genutzt werden. Dazu wird die Syntax mit der von von Bildern kombiniert.

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

Anmerkung: Die Formatierung für Bilder ist die einzig erlaubte Formatierung innerhalb es Linkstexts.

Du kannst die komplette Bilder und Links Syntax nutzen, inklusive Bilderskalierung, interne und externe Bilder und URLs, sowie InterWiki Links.

Fußnoten

Du kannst Fußnoten 4) mit doppelten runden Klammen einfügen. Die Reihenfolge und Nummerierung werden durch die Position im Text bestimmt.

Du kannst Fußnoten ((Das ist eine Fußnote)) mit doppelten runden Klammen einfügen.

Sektionen

Du kannst bis zu 5 verschiede Überschriftenebenen nutzen, um den Inhalt einer Seite zu strukturieren. Wenn es auf einer Seite mehr als 3 Überschriften gibt, dann wird automatisch ein Inhaltsverzeichnis mit einer Auflistung aller Überschriften erzeugt. Wenn dieses automatische Inhaltsverzeichnis nicht erstellt werden soll, dann füge das ~~NOTOC~~ Makro in die Seite ein.

Überschrift Ebene 3

Überschrift Ebene 4

Überschrift Ebene 5
==== Überschrift Ebene 3 ====
=== Überschrift Ebene 4 ===
== Überschrift Ebene 5 ==

Mit 4 oder mehr aufeinanderfolgenden Bindestrichen kannst du eine horizontale Linie erzeugen.


Bilder und andere Dateien

Du kannst interne und externe Bilder mit geschweiften Klammern einfügen. Wahlweise kannst du auch noch die Größe des Bildes angeben.

Echte Größe:

Eine Breite vorgeben:

Breite wie auch Höhe vorgeben 5):

Skaliertes externes Bild:

Echte Größe:                   {{wiki:dokuwiki-128.png}}
Eine Breite vorgeben:          {{wiki:dokuwiki-128.png?50}}
Breite wie auch Höhe vorgeben: {{wiki:dokuwiki-128.png?200x50}}
Skaliertes externes Bild:      {{http://de3.php.net/images/php.gif?200x50}}

Du kannst mit Leerzeichen rechts oder links der URL die Ausrichtung des Bildes bestimmen.

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

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

Dies ist ein Titel

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

Wenn eine externe oder interne Datei angegeben wird, welche kein Bild ist (gif, jpeg, png), dann wird diese als Link angezeigt.

Listen

Dokuwiki kennt nummerierte und unnummerierte Listen. Um eine einen Listeneintrag zu erstellen beginne eine Zeile mit zwei Leerzeichen. Diesen Leerzeichen folgt dann ein „*“ für unnummerierte Listen oder ein Bindestrich (-) für eine nummerierte Liste. Listen können ineinander verschachtelt werden, dafuer müssen für jede Verschachtlungstiefe zwei weitere Leerzeichen eingefügt werden.

  • Dies ist ein Eintrag einer unnummerierten Liste
  • Ein zweiter Eintrag
    • Dieser Listeneintrag ist verschachtelt
  • Der letzte Eintrag
  1. Dies ist die gleiche Liste, nur mit Nummerierung
  2. Ein zweiter Eintrag
    1. Dieser Listeneintrag ist verschachtelt
  3. Der letzte Eintrag
  * Dies ist ein Eintrag einer unnummerierten Liste
  * Ein zweiter Eintrag
    * Dieser Listeneintrag ist verschachtelt
  * Der letzte Eintrag

  - Dies ist die gleiche Liste, nur mit Nummerierung
  - Ein zweiter Eintrag
    - Dieser Listeneintrag ist verschachtelt
  - Der letzte Eintrag

Wenn du weitere Details wissen möchtest kannst du diese in der FAQ über Listen nachlesen.

Textersetzung

DokuWiki kann bestimmte Buchstaben oder Texte durch Bilder, andere Texte oder HTML ersetzen.

Texte durch Bilder ersetzen

In diesem DokuWiki werden die folgenden Texte durch Bilder ersetzt:

  • FIXME FIXME
  • DELETEME DELETEME

Text durch HTML ersetzen

DokuWiki kann einfache Textrepräsentationen durch die typographisch korrekten Zeichen ersetzen. Hier ist eine Auflistung der unterstützten Zeichen:

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

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

Tabellen

Mit DokuWiki können ganze einfach Tabellen erstellt werden.

Kopf 1 Kopf 2 Kopf 3
Zeile 1 Spalte 1 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Zeile 2 Spalte 1 Spaltenübergreifende Zelle (Beachte den doppelten senkrechten Strich)
Zeile 3 Spalte 1 Zeile 3 Spalte 2 Zeile 3 Spalte 3

Tabellenfelder werden mit einem | für normale Felder oder ^ für Tabellenköpfe getrennt.

^ Kopf 1    ^ Kopf 2    ^ Kopf 3      ^
| Zeile 1 Spalte 1 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3   |
| Zeile 2 Spalte 1 | Spaltenübergreifende Zelle (Beachte den doppelten senkrechten Strich) ||
| Zeile 3 Spalte 1 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3   |

Um Zellen waagerecht zu verbinden lasse die nachfolgenden Zellen leer. Die Zelle wird sich über die gleiche Anzahl von Spalten spannen, wie Trennzeichen vorhanden sind.

Senkrechte Tabellenköpfe sind auch möglich.

Kopf 1 Kopf 2
Kopf 3 Zeile 1 Spalte 2 Zeile 1 Spalte 3
Kopf 4 Dieses mal keine spaltenübergreifende Zellen
Kopf 3 Zeile 3 Spalte 2 Zeile 3 Spalte 3

Wie du sehen kannst entscheidet das Trennzeichen vor der Zelle die Formatierung der Zelle.

|        ^ Kopf 1            ^ Kopf 2                   ^
^ Kopf 3 | Zeile 1 Spalte 2  | Zeile 1 Spalte 3         |
^ Kopf 4 | Dieses mal keine spaltenübergreifende Zellen |     |
^ Kopf 3 | Zeile 3 Spalte 2  | Zeile 3 Spalte 3         |

Es ist auch möglich zeilenübergreifende Zellen zu erstellen, indem man in die Zellen unter der zu spannenden Zelle ::: einfügt.

Kopf 1 Kopf 2 Kopf 3
Zeile 1 Spalte 1 Diese Zelle ist zeilenübergreifend Zeile 1 Spalte 3
Zeile 2 Spalte 1 Zeile 2 Spalte 3
Zeile 3 Spalte 1 Zeile 2 Spalte 3

Neben der Syntax für zeilenübergreifende Zellen sollten Zellen leer sein.

^ Kopf 1           ^ Kopf 2                             ^ Kopf 3           ^
| Zeile 1 Spalte 1 | Diese Zelle ist zeilenübergreifend | Zeile 1 Spalte 3 |
| Zeile 2 Spalte 1 | :::                                | Zeile 2 Spalte 3 |
| Zeile 3 Spalte 1 | :::                                | Zeile 2 Spalte 3 |

Du kannst auch Zelleninhalte ausrichten. Füge dafür mindestens zwei Leerzeichen an die gegenüberliegende Seite des Textes.

  • Zwei Leerzeichen auf der linken Seite richten den Inhalt rechts aus.
  • Zwei Leerzeichen auf der rechten Seite richten den Inhalt links aus.
  • Wenn links wie auch rechts zwei Leerzeichen eingefügt wurden, wird der Inhalt zentriert.
Tabelle mit Ausrichtung
rechts zentriert links
links rechts zentriert
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Dies sieht in der Formatierung so aus:

^           Tabelle mit Ausrichtung        ^^^
|        rechts|  zentriert   |links         |
|links         |        rechts|  zentriert   |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Anmerkung: Eine senkrechte Ausrichtung wird nicht unterstützt.

Formatierung unterdrücken

Um Text exakt so anzuzeigen, wie er geschrieben wurde, unabhängig davon ob er DokuWiki Formatierungen oder ander Formatierungen enthält kann man entweder den Text mit <nowiki> Tags oder mit doppelten Prozentzeichen %% einschliessen.

Dieser Text enthält Addressen wie: http://www.splitbrain.org und **Formatierungen**, aber diese wird nicht angewendet. Das gleiche gilt für //__diesen__ Text// mit einer Textersetung FIXME.

<nowiki>
Dieser Text enthält Addressen wie: http://www.splitbrain.org und **Formatierungen**, aber diese wird nicht angewendet.
</nowiki>
Das gleiche gilt für %%//__diesen__ Text// mit einer Textersetung FIXME%%.

Vorformatierte Texte

Du kannst Texte vorformatieren, indem du entweder jeder Zeile mindestens zwei Leerzeichen voranstellst wie in den vorherigen Beispielen oder den Text mit den <code> oder <file> einschliesst.

Dieser Text wurde mit zwei Leerzeichen eingerückt.
Dieser Text wird vorformatiert und alle Leerzeichen werden beibehalten.        <- beispielsweise so.
Diese Vorformatierung ist der vorherigen ziemlich ähnlich, aber du kannst sie zum zitieren von Dateiinhalten nutzen.

Diese Absätze wurden durch den folgenden Quellcode erzeugt.

  Dieser Text wurde mit zwei Leerzeichen eingerückt.
<code>
Dieser Text wird vorformatiert und alle Leerzeichen werden beibehalten.        <- beispielsweise so.
</code>
<file>
Diese Vorformatierung ist der vorherigen ziemlich ähnlich, aber du kannst sie zum zitieren von Dateiinhalten nutzen.
</file>

Syntaxhervorhebung

DokuWiki kann Quellcode hervorheben, was die Lesbarkeit verbessern soll. Der Syntax ist ähnlich zu code und file Absätzen, mit dem Unterschied, dass dieses mal die zu hervorhebende Sprache in den Tag eingetragen wird, beispielsweise <code java> oder <file 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 werden zur Zeit unterstützt: 4cs, abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, ecmascript, eiffel, email, erlang, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lisp, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, plsql, postgresql, povray, powerbuilder, powershell, progress, prolog, properties, providex, purebasic, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, z80

Herunterladbarer Vorformatierter Text

Wenn du die <code> oder die <file> Syntax wie oben erwähnt benutzt, möchtest du vielleicht den Code als Download zur Verfügung stellen. Das kannst du umsetzen, indem du den Dateinamen nach der Sprache angibst.

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>
myexample.php
<?php echo "hello world!"; ?>

Wenn du keine Hervorhebung nutzen möchtest, aber dennoch eine herunterladbare Datei angeben möchtest, dann benutze einen Bindestrich (-) anstelle der Sprache: <code - myfile.foo>.

RSS/ATOM Feed Aggregation

DokuWiki bietet die Möglichkeit externe XML feeds in die Seite zu integrieren. Du kannst die Darstellung durch mehrere zusätzliche Parameter bestimmen:

Parameter Beschreibung
beliebige Nummer Gibt die Anzahl der maximalen anzuzeigenden Feedeinträge an.
reverse Zeige den neusten Eintrag zuerst an
author Zeige den Namen des Authors
date Zeige das Datum des Feedeintrages
description Zeige die Beschreibung des Eintrages. HTML tags werden hierbei entfernt
n[dhm] Gibt an wie oft die Feedeinträge aktualisiert werden sollen. d=Tage, h=Stunden, m=Minuten. (e.g. 12h = 12 Stunden).

Der voreingestellte Aktualisierungszeitraum beträgt vier Stunden. Alle Werte unter 10 Minuten werden als 10 Minuten interpretiert. DokuWiki wird versuchen eine zwischengespeicherte Version der Seite zurückzugeben, wenn diese verfügbar ist. Wenn der Aktualisierungszeitraum überschritten wurde, wird die Seite im Zwischenspeicher aktualisiert.

Beispiel:

{{rss>http://www.heise.de/open/news/news-atom.xml 5 author date 1h }}

Steuerungsmakros

Ein paar der implementierten Formatierungen steuern wie DokuWiki Seiten darstellt, ohne selber eine Ausgabe zu erzeugen. Die folgenden Steuerungsmakros sind verfügbar:

Makro Beschreibung
~~NOTOC~~ Wenn dieses Makro in einer Seite gefunden wird, wird kein Inhaltsverzeichnis erzeugt.
~~NOCACHE~~ DokuWiki speichert bei Standardeinstellung alle Ausgaben zwischen. Manchmal ist dieses Verhalten unerwünscht, beispielsweise wenn interaktive Funktionen genutzt werden. Wenn dieses Makro hinzugefügt wird, dann untersrückt DokuWiki die Zwischenspeicherung des Seite.

Syntax Plugins

DokuWiki's Syntax kann mit Hilfe von Plugins erweitert werden. Wie diese Plugins genutzt werden ist der dazugehörigen Projektseite beschrieben. Die folgenden Syntax Plugins sind in diesem Wiki installiert.

1) Verweise auf andere Webseiten
2) Verweise auf andere Seiten dieses Dokuwikis
3) Links zu anderen, vordefinierten Wikis
4) Das ist eine Fußnote
5) Wenn das Seitenverhältnis der gegebenen Breite und Höhe nicht mit dem Bild übereinstimmt, wird das Bild vor der Größenänderung zugeschnitten.
Die Verwendung aller Dokumente einschließlich der Abbildungen ausschließlich zu nichtkommerziellen Zwecken. Verbreitung des Dokuments auf Speichermedien, (insbesondere auf CD-ROMs als Beilage zu Zeitschriften und Magazinen oder sog. "Mission-Packs" etc.) ist untersagt.
 
wiki/syntax.txt · Zuletzt geändert: 2012/10/07 13:30 (Externe Bearbeitung)