, , hilfe:syntax

Formatierung für Wiki-Texte

1 Texte

1.1 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. Zeilenumbrüche durch zwei "backslashes" (umgekehrte Schrägstriche: \\) sollten nur verwendet werden, wenn sie unbedingt gebraucht werden.

1.2 Ü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 zur Erzeugung der Überschriften die Symbolleiste verwenden und hier auf die die Buttons H1, H2 oder H3 klicken.

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

Es ist sinnvoll, wenn immer eine Level 1 Überschrift am Anfang eines Artikels steht. Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden!

Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet.

1.3 Listen

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

1.4 Formatierungen

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 deleted1) markiert werden.

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

1.5 unformatierte Abschnitte

Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man einen der Bezeichner "code" bzw "file" benutzen:

Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier              <-- zwischen

<code> Mit "code": In diesem Text werden keine überflüssigen Leerzeichen entfernt: wie hier <-- zwischen </code>

Mit "file": Eigentlich das Gleiche wie oben, sieht nur etwas anders aus. \\ 
Vielleicht um Zitate zu kennzeichnen oder ähnliches.

Um jegliche Umwandlung durch Dokuwiki abzustellen, umschließe 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.

1.6 Syntax-Hervorhebung

DokuWiki kennt Syntax highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird GeSHi "Generic Syntax Highlighter" benutzt. Somit wird jede Programmiersprache unterstützt, die GeSHi kennt.
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.
    }
}

Es werden folgende Sprachen 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

1.7 Zitat / Kommentar

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

Ich denke wir sollten es tun.
  
  > Nein, sollten wir nicht.
  
  >> Doch!
  
  > Wirklich?
  
  >> Ja!
  
  >>> Dann lass es uns tun!
  
  >>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das "größer als" - Zeichen folgendermaßen verwendet

Ich denke wir sollten es tun

Nein, sollten wir nicht.
Doch!
Wirklich?
Ja!
Dann lass es uns tun
Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das "größer als" - Zeichen folgendermaßen verwendet

2 Links

Mit DokuWiki können 5 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("altgr+8" bzw. altgr+9 auf einer win-tastatur bzw Wahltaste+5 und Wahltaste+6 bei Apple) auf:
wiki: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:
[[doku>wiki:pagename]] 
  
Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:
[[doku>wiki: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!

Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: namespaces

Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[wiki:de:namespaces]] 

Weitere Informationen zu Namensbereichen: wiki:de:namespaces.

Anmerkungen:

  • Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
  • DokuWiki verwendet standardmäßig keine CamelCase für Links.
    In der Einstellungsdatei: config kann das aber geändert werden.
    Hinweis: wenn das Wort: DokuWiki als Link angezeigt wird, dann ist diese Option eingeschaltet.

2.3 Interwiki

DokuWiki unterstützt auch Links in andere Wikis, sogenannte wiki:de:interwiki Links.
Ein Link zur Wikipedia Seite über Wikis:Wiki

DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>wiki:de:interwiki]] Links. \\
Ein Link zur Wikipedia Seite über Wikis:[[wp>Wiki]]

2.4 Bilder als Links

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 Größe von Bildern

Mit geschweiften Klammern können sowohl externe als auch interne Bilder eingebunden werden. Optional kann deren Größe angegeben werden:

Original Größe:

Eine Breite vorgeben:

Größe für externe Bilder vorgeben:

Original Größe:                        {{wiki:dokuwiki-128.png}}
Eine Breite vorgeben:                  {{wiki:dokuwiki-128.png?50}}
Größe für externe Bilder vorgeben:     {{http://de3.php.net/images/php.gif?200}}

3.3 Ausrichten von Bildern

Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, mitte, rechts).

Rechts

Links

Zentriert

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

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

5 Tabellen

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.

Der Inhalt einer Zelle kann horizontal ausgerichtet werden. Füge 2 Leerzeichen hinzu:

  • 2 Leerzeichen Links vom Text: rechtsbündig
  • 2 Leerzeichen Rechts vom Text: linksbündig
  • 2 Leerzeichen Links und Rechts vom Text: zentriert
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 |

6 sonstige Formatierungen

6.1 Fußnoten

Fußnoten 2) werden durch eine doppelte runde Klammer dargestellt 3). 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))

6.2 horizontale Linie

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


----

6.3 Smileys

Dokuwiki verwandelt oft genutzte emoticons zu kleinen Smily-Grafiken.
Weitere Smiley-Grafiken können im Ordener "smily" abgelegt und dann in der Datei conf/smileys.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

sowie ^_^ ^_^ 4)

6.4 Typografie

DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.
Hier eine Liste aller Zeichen, die DokuWiki kennt:

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640x480 © ™ ® "He thought 'It's a man's world'…"

Weitere Sonderzeichen unter dem Button [Ω] über dem Editierfenster.

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

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

Änderungen

Dieses Dokument ist eine Kopie der offiziellen Syntaxbeschreibung vom 09.03.2005 und wurde an lokale Gegebenheiten angepasst:

  • 18.04.2009 randolf: Abschnitte zu Windows-Freigaben, HTML- und PHP-Einbettung entfernt
  • 05.04.2011 randolf: code-Beispiele repariert, umsortiert
1) wer eingefügt <ins> braucht. kann dies über Plugins realisieren. Siehe ganz unten!
2) dies ist eine Fußnote
3) eine zweite Fußnote
4) lässt sich wohl nicht in einer Tabelle darstellen
hilfe/syntax.txt · Zuletzt geändert: 08.12.2012 14:56 von btu_gengler