Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung | ||
wiki:syntax [2008-08-05 23:18 UTC] – awelzel | wiki:syntax [2017-10-14 09:11 UTC] (aktuell) – Aktuelle Kontaktadresse im Beispiel eingetragen admin | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
+ | ====== Syntax ====== | ||
+ | |||
+ | DokuWiki unterstützt einige einfache Formatierungsauszeichnungen, | ||
+ | |||
+ | ===== Grundlegende Formatierungen ===== | ||
+ | |||
+ | DokuWiki unterstützt **fette**, // | ||
+ | |||
+ | DokuWiki unterstützt **fette**, // | ||
+ | mit '' | ||
+ | |||
+ | Man kann Text auch < | ||
+ | |||
+ | Man kann Text auch < | ||
+ | |||
+ | Texte können auch als < | ||
+ | |||
+ | Texte können auch als < | ||
+ | |||
+ | **Absätze** werden durch Leerzeilen erzeugt. Einfache Zeilenumbrüche werden normalerweise ignoriert. Möchte man einen Zeilenumbruch einfügen, ohne einen neuen Absatz zu beginnen, kann man dazu zwei umgekehrte Schrägstriche (backslashes) am Zeilenende oder innerhalb einer Zeile gefolgt von einem Leerzeichen verwenden. | ||
+ | |||
+ | Dies ist etwas Text mit einigen Zeilenumbrüchen\\ Man beachte, | ||
+ | dass die beiden Schrägstriche nur am Zeilenende erkannt werden\\ | ||
+ | oder, wenn sie von einem\\ Leerzeichen \\gefolgt werden. | ||
+ | |||
+ | Dies ist etwas Text mit einigen Zeilenumbrüchen\\ Man beachte, | ||
+ | dass die beiden Schrägstriche nur am Zeilenende erkannt werden\\ | ||
+ | oder, wenn sie von einem\\ Leerzeichen \\gefolgt werden. | ||
+ | |||
+ | Man sollte Zeilenumbrüche nur dort einfügen, wo sie wirklich gebraucht werden. | ||
+ | |||
+ | **Geschützte Leerzeichen**((dies wird durch ein Syntax-Plugin ermöglicht)) kann mit einem einfachen umgekehrten Schrägstrich, | ||
+ | |||
+ | Beispiele: SON\ XS, 42\ km | ||
+ | |||
+ | Beispiele: SON\ XS, 42\ km | ||
+ | |||
+ | ===== Links ===== | ||
+ | |||
+ | DokuWiki unterstützt verschiedene Methoden, um Links zu erzeugen. | ||
+ | |||
+ | ==== Extern ==== | ||
+ | |||
+ | Externe Links werden automatisch erkannt: http:// | ||
+ | |||
+ | Externe Links werden automatisch erkannt: http:// | ||
+ | einfach www.google.com. Man kann auch Namen dafür angeben: | ||
+ | [[http:// | ||
+ | wie diese: < | ||
+ | |||
+ | ==== Intern ==== | ||
+ | |||
+ | Interne Links werden durch eckige Klammern erzeigt. Man kann entweder einfach den Seitennamen direkt angeben: [[wiki: | ||
+ | |||
+ | Interne Links werden durch eckige Klammern erzeigt. Man kann entweder einfach | ||
+ | den Seitennamen direkt angeben: [[wiki: | ||
+ | Text zusätzlich angeben: [[wiki: | ||
+ | automatisch in Kleinbuchstaben umgewandelt. Sonderzeichen sind nicht zulässig. | ||
+ | |||
+ | Durch Doppelpunkte in den Seitennamen werden Namensräume bezeichnet. Mehr dazu siehe auch [[namespaces|hier]]. | ||
+ | |||
+ | Ein Links auf einen bestimmten Abschnitt einer Seite ist ebenfalls möglich. Dazu wird der Abschnitt mit einem Doppelkreuz (#) an den Seitennamen angehängt, so wie man es in HTML auch macht: Ein Link auf [[syntax# | ||
+ | |||
+ | Ein Link auf [[syntax# | ||
+ | |||
+ | Anmerkungen: | ||
+ | |||
+ | * Links auf [[wiki: | ||
+ | * DokuWiki verwendet im Gegensatz zu anderen Wikis kein [[wpde> | ||
+ | * Wenn die Überschrift eines Abschnittes geändert wird, ändert sich auch der anzugebende Name in Links, deshalb sollte man sich auf diese Art der Links nicht zu sehr verlassen. | ||
+ | |||
+ | ==== Interwiki ==== | ||
+ | |||
+ | DokuWiki unterstützt [[doku> | ||
+ | |||
+ | DokuWiki unterstützt [[doku> | ||
+ | Links zu anderen Wikis in einer verkürzten Schreibweise. Beispielsweise | ||
+ | ist dies ein Link zu der Seite von WikiPedia über Wikis: [[wp> | ||
+ | |||
+ | Die Liste der möglichen Ziele ist in der DokuWiki-Konfiguration definiert und kann beliebig erweitert werden. Eine detaillierte Übersicht der hier möglichen Ziele findet sich [[interwikinames|hier]]. | ||
+ | |||
+ | ==== Bilder als Links ==== | ||
+ | |||
+ | Man kann auch ein Bild als Link zu einer anderen externen oder internen Seite verwenden, indem man die Syntax für Links und [[# | ||
+ | |||
+ | [[http:// | ||
+ | |||
+ | [[http:// | ||
+ | |||
+ | Bitte beachten: Bilder sind die einzige Formatierung, | ||
+ | |||
+ | ===== Fußnoten ===== | ||
+ | |||
+ | Fußnoten können durch doppelte Klammern eingefügt werden ((das ist eine Fußnote)). | ||
+ | |||
+ | Fußnoten können durch doppelte Klammern eingefügt | ||
+ | werden ((das ist eine Fußnote)). | ||
+ | |||
+ | ===== Abschnitte ===== | ||
+ | |||
+ | Eine Seite kann mit bis zu fünf verschiedenen Überschriftsebenen strukturiert werden. Falls mehr als drei Überschriften vorhanden sind, wird automatisch ein Inhaltsverzeichnis erzeugt. Soll kein Inhaltsverzeichnis erscheinen, fügt man im Dokument ''< | ||
+ | |||
+ | Abschnitte können separat bearbeitet und als Ziel für Links verwendet werden, wobei sich der Name des Abschnitts aus dem Text der Überschrift ergibt (auf dieser Seite finden sich einige Beispiele dafür). | ||
+ | |||
+ | ==== Überschrift, | ||
+ | === Überschrift, | ||
+ | == Überschrift, | ||
+ | |||
+ | ==== Überschrift, | ||
+ | === Überschrift, | ||
+ | == Überschrift, | ||
+ | |||
+ | Mit vier oder mehr Minuszeichen wird eine horizontale Trennlinie erzeugt: | ||
+ | |||
+ | ---- | ||
+ | |||
+ | ===== Bilder und andere Dateien ===== | ||
+ | |||
+ | Bilder werden mit geschweiften Klammen eingefügt. Optional kann man die gewünschte Grösse angeben. | ||
+ | |||
+ | Originalgrösse: | ||
+ | {{wiki: | ||
+ | |||
+ | Feste Breite:\\ | ||
+ | {{wiki: | ||
+ | |||
+ | Feste Breite und Höhe:\\ | ||
+ | {{wiki: | ||
+ | |||
+ | Externes Bild mit vorgegebener Grösse:\\ | ||
+ | {{http:// | ||
+ | |||
+ | Originalgrösse: | ||
+ | {{wiki: | ||
+ | | ||
+ | Feste Breite:\\ | ||
+ | {{wiki: | ||
+ | | ||
+ | Feste Breite und Höhe:\\ | ||
+ | {{wiki: | ||
+ | | ||
+ | Externes Bild mit vorgegebener Grösse:\\ | ||
+ | {{http:// | ||
+ | |||
+ | Durch Leerstellen links oder rechts vom Bildnamen kann man die Ausrichtung festlegen. | ||
+ | |||
+ | {{ wiki: | ||
+ | {{wiki: | ||
+ | {{ wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | {{wiki: | ||
+ | {{ wiki: | ||
+ | |||
+ | Natürlich kann man auch einen Titel angeben (der von den meisten Browsern als " | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | {{ wiki: | ||
+ | |||
+ | Falls ein Dateiname angegeben wird (extern oder intern), der kein Bild ist ('' | ||
+ | |||
+ | Bilder können auch als Links verwendet werden, siehe [[#Bilder als Links|oben]]. | ||
+ | |||
+ | ===== Listen ===== | ||
+ | |||
+ | DokuWiki unterstützt numerierte und nicht numerierte Listen. Ein Listeneintrag wird dadurch erzeugt, dass man eine Zeile mit zwei Leerzeichen beginnt und dann ein '' | ||
+ | |||
+ | Liste ohne Numerierung: | ||
+ | |||
+ | * Das ist eine Liste | ||
+ | * Der zweite Eintrag | ||
+ | * Mehrere Ebenen sind auch möglich | ||
+ | * Ein weiterer Eintrag | ||
+ | |||
+ | Die selbe Liste mit Numerierung: | ||
+ | |||
+ | - Die selbe Liste, aber numeriert | ||
+ | - Der zweite Eintrag | ||
+ | - Für eine weitere Ebene einfach einrücken | ||
+ | - Das war's | ||
+ | |||
+ | < | ||
+ | Liste ohne Numerierung: | ||
+ | |||
+ | * Das ist eine Liste | ||
+ | * Der zweite Eintrag | ||
+ | * Mehrere Ebenen sind auch möglich | ||
+ | * Ein weiterer Eintrag | ||
+ | |||
+ | Die selbe Liste mit Numerierung: | ||
+ | |||
+ | - Die selbe Liste, aber numeriert | ||
+ | - Der zweite Eintrag | ||
+ | - Für eine weitere Ebene einfach einrücken | ||
+ | - Das war's | ||
+ | </ | ||
+ | |||
+ | ===== Smileys ===== | ||
+ | |||
+ | DokuWiki wandelt häufig verwendete [[wp> | ||
+ | |||
+ | * 8-) %% 8-) %% | ||
+ | * 8-O %% 8-O %% | ||
+ | * :-( %% :-( %% | ||
+ | * :-) %% :-) %% | ||
+ | * =) %% =) %% | ||
+ | * :-/ %% :-/ %% | ||
+ | * :-\ %% :-\ %% | ||
+ | * :-? %% :-? %% | ||
+ | * :-D %% :-D %% | ||
+ | * :-P %% :-P %% | ||
+ | * :-O %% :-O %% | ||
+ | * :-X %% :-X %% | ||
+ | * :-| %% :-| %% | ||
+ | * ;-) %% ;-) %% | ||
+ | * ^_^ %% ^_^ %% | ||
+ | * :?: %% :?: %% | ||
+ | * :!: %% :!: %% | ||
+ | * LOL %% LOL %% | ||
+ | * FIXME %% FIXME %% | ||
+ | * DELETEME %% DELETEME %% | ||
+ | |||
+ | ===== Typographie ===== | ||
+ | |||
+ | DokuWiki wandelt einige Texte in die korrekten, typografischen Zeichen um. Hier ist ein Beispiel für die erkannten Zeichen: | ||
+ | |||
+ | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
+ | |||
+ | < | ||
+ | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
+ | </ | ||
+ | |||
+ | ===== Kommentare ===== | ||
+ | |||
+ | In manchen Fällen möchte man Text als Kommentar kennzeichnen, | ||
+ | |||
+ | Wir sollten das so machen. | ||
+ | | ||
+ | > Nein, sollten wir nicht. | ||
+ | | ||
+ | >> Doch, ich denke schon. | ||
+ | | ||
+ | >>> | ||
+ | | ||
+ | >>>> | ||
+ | | ||
+ | >>>>> | ||
+ | |||
+ | Wir sollten das so machen. | ||
+ | |||
+ | > Nein, sollten wir nicht. | ||
+ | |||
+ | >> Doch, ich denke schon. | ||
+ | |||
+ | >>> | ||
+ | |||
+ | >>>> | ||
+ | |||
+ | >>>>> | ||
+ | |||
+ | ===== Tabellen ===== | ||
+ | |||
+ | DokuWiki unterstützt eine einfache Syntax zur Erstellung von Tabellen ((innerhalb von Tabellen sind nicht alle Formatierungen möglich)). | ||
+ | |||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Spalte 1 | Spalte 1 Zeile 2 | Zeile 1 Spalte 3 | | ||
+ | | Zeile 2 Spalte 1 | Mehrspaltige Zelle (man beachte den doppelten Strich) || | ||
+ | | Zeile 3 Spalte 1 | Spalte 2 Zeile 2 | Zeile 2 Spalte 3 | | ||
+ | |||
+ | Tabellenzeilen müssen mit einem '' | ||
+ | |||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Spalte 1 | Spalte 1 Zeile 2 | Zeile 1 Spalte 3 | | ||
+ | | Zeile 2 Spalte 1 | Mehrspaltige Zelle (man beachte den doppelten Strich) || | ||
+ | | Zeile 3 Spalte 1 | Spalte 2 Zeile 2 | Zeile 2 Spalte 3 | | ||
+ | |||
+ | Um mehrere Zellen horizontal zu verbinden, lässt man die angrenzenden Zellen, wie oben gezeigt, einfach komplett leer. Man muss beachten, in jeder Zeile die gleiche Anzahl an Trennzeichen zu verwenden! | ||
+ | |||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Spalte 1 | Mehrzeilige Zelle | Zeile 1 Spalte 3 | | ||
+ | | Zeile 2 Spalte 1 | ::: | Zeile 2 Spalte 3 | | ||
+ | | Zeile 3 Spalte 1 | ::: | Zeile 2 Spalte 3 | | ||
+ | |||
+ | Es ist auch möglich, mehrere Zellen vertikal zu verbinden. Dazu trägt man in die nachfolgenden Zellen als einzigen Text drei Doppelpunkte ein: | ||
+ | |||
+ | ^ Überschrift 1 ^ Überschrift 2 ^ Überschrift 3 ^ | ||
+ | | Zeile 1 Spalte 1 | Mehrzeilige Zelle | Zeile 1 Spalte 3 | | ||
+ | | Zeile 2 Spalte 1 | ::: | Zeile 2 Spalte 3 | | ||
+ | | Zeile 3 Spalte 1 | ::: | Zeile 2 Spalte 3 | | ||
+ | |||
+ | Vertikale Tabellenköpfe sind ebenfalls möglich. | ||
+ | |||
+ | ^ ^ Überschrift 1 ^ Überschrift 2 ^ | ||
+ | ^ Überschrift 3 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 | | ||
+ | ^ Überschrift 4 | diesmal nur eine Zelle | | | ||
+ | ^ Überschrift 5 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 | | ||
+ | |||
+ | Wie man sieht, ist das Trennzeichen vor der Zelle entscheidend dafür, wie wie Zelle formatiert wird: | ||
+ | |||
+ | ^ ^ Überschrift 1 ^ Überschrift 2 ^ | ||
+ | ^ Überschrift 3 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 | | ||
+ | ^ Überschrift 4 | diesmal nur eine Zelle | | | ||
+ | ^ Überschrift 5 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 | | ||
+ | |||
+ | Die Ausrichtung von Zelleninhalten kann ebenfalls festgelegt werden. Dazu fügt man einfach zwei Leerzeichen vor oder nach dem Text ein: um den Text rechtsbündig darzustellen, | ||
+ | |||
+ | ^ | ||
+ | | rechts| | ||
+ | |links | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | So sieht der Quelltext dazu aus: | ||
+ | |||
+ | ^ | ||
+ | | rechts| | ||
+ | |links | ||
+ | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
+ | |||
+ | ===== Abschnitte ohne Formatierung ===== | ||
+ | |||
+ | Es ist möglich, Abschnitte ohne Formatierung in ein Dokument zu übernehmen, | ||
+ | |||
+ | < | ||
+ | Dieser Text wird mit allen Leerzeichen darin unverändert ausgegeben: wie <-das | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | Diese Variante ist nahezu identisch, aber sie kann verwendet werden, um die | ||
+ | Darstellung einer Datei zu kennzeichnen. | ||
+ | </ | ||
+ | |||
+ | Um einen Abschnitt vollständig im Original darzustellen, | ||
+ | |||
+ | < | ||
+ | Das ist etwas Text, der Adressen wie diese enthält: http:// | ||
+ | </ | ||
+ | |||
+ | Und hier noch ein Beispiel für die Variante mit doppelten Prozentzeichen: | ||
+ | |||
+ | Sehen Sie sich den Quelltext dieser Seite an, wenn die Verwendung dieser Möglichkeiten unklar ist. | ||
+ | |||
+ | ===== Syntax Highlighting ===== | ||
+ | |||
+ | DokuWiki kann Quelltexte mit syntax highlighting versehen, um sie leserlicher zu gestalten. Dazu wird [[http:// | ||
+ | |||
+ | <code java> | ||
+ | /** | ||
+ | * The HelloWorldApp class implements an application that | ||
+ | * simply displays "Hello World!" | ||
+ | */ | ||
+ | class HelloWorldApp { | ||
+ | public static void main(String[] args) { | ||
+ | System.out.println(" | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | Die folgenden Sprachen werden momentan unterstützt: | ||
+ | |||
+ | |||
+ | ===== Syntax Plugins ===== | ||
+ | |||
+ | Die Syntax von DokuWiki kann durch [[doku> | ||
+ | |||
+ | ~~INFO: | ||