====== Syntax ====== DokuWiki unterstützt einige einfache Formatierungsauszeichnungen, mit dem Ziel, die Quelltexte so leserlich wie möglich zu gestalten. Häufig benötigte Formatierungen kann man über die entsprechenden Symbole oberhalb des Bearbeitungsfensters auswählen - je nach verwendetem Browser auch über Tastaturkürzel, wie z.B. Alt-B für fetten Text (bold). ===== Grundlegende Formatierungen ===== DokuWiki unterstützt **fette**, //kursive//, __unterstrichene__ Texte und Schrift mit ''fester Breite''. Natürlich kann man das auch alles **__//''kombinieren''//__**. DokuWiki unterstützt **fette**, //kursive//, __unterstrichene__ Texte und Schrift mit ''fester Breite''. Natürlich kann man das auch alles **__//''kombinieren''//__**. Man kann Text auch hochgestellt und tiefgestellt darstellen. Man kann Text auch hochgestellt und tiefgestellt darstellen. Texte können auch als gelöscht gekennzeichnet werden. Texte können auch als gelöscht gekennzeichnet werden. **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, gefolgt von einem Leerzeichen erzeugen - damit wird verhindert, dass die Zeile an dieser Stelle umgebrochen wird, was für Angaben wie Produktnamen oder Entfernungen sinnvoll sein kann. 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://www.google.com oder einfach www.google.com. Man kann auch Namen dafür angeben: [[http://www.google.com|Dieser Link verweist auf Google]]. EMail-Adressen, wie diese: werden ebenfalls erkannt. Externe Links werden automatisch erkannt: http://www.google.com oder einfach www.google.com. Man kann auch Namen dafür angeben: [[http://www.google.com|Dieser Link verweist auf Google]]. EMail-Adressen, wie diese: werden ebenfalls erkannt. ==== Intern ==== Interne Links werden durch eckige Klammern erzeigt. Man kann entweder einfach den Seitennamen direkt angeben: [[wiki:syntax]] oder einen beschreibenden Text zusätzlich angeben: [[wiki:syntax|Syntax für Texte]]. Seitennamen werden automatisch in Kleinbuchstaben umgewandelt. Sonderzeichen sind nicht zulässig. Interne Links werden durch eckige Klammern erzeigt. Man kann entweder einfach den Seitennamen direkt angeben: [[wiki:syntax]] oder einen beschreibenden Text zusätzlich angeben: [[wiki:syntax|Syntax für Texte]]. Seitennamen werden 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#intern|diesen Abschnitt]]. Ein Link auf [[syntax#intern|diesen Abschnitt]]. Anmerkungen: * Links auf [[wiki:syntax|vorhandene Seiten]] werden anders dargestellt, als [[wiki:nonexisting|nicht existierende Seiten]]. * DokuWiki verwendet im Gegensatz zu anderen Wikis kein [[wpde>CamelCase]], um Links automatisch zu erzeugen. * 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>wiki:interwiki|Interwiki]]-Links. Das sind Links zu anderen Wikis in einer verkürzten Schreibweise - der Name des Wikis, gefolgt von dem Seitennamen. Beispielsweise ist dies ein Link zu der Seite von WikiPedia über Wikis: [[wpde>Wiki]]. DokuWiki unterstützt [[doku>wiki:interwiki|Interwiki]]-Links. Das sind Links zu anderen Wikis in einer verkürzten Schreibweise. Beispielsweise ist dies ein Link zu der Seite von WikiPedia über Wikis: [[wp>Wiki]]. 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 [[#Bilder_und_andere_Dateien|Bilder]] kombiniert (siehe unten): [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] [[http://www.php.net|{{wiki:dokuwiki-128.png}}]] Bitte beachten: Bilder sind die einzige Formatierung, die in Linkbezeichnungen akzeptiert wird. Die gesamte Syntax für Bilder (einschliesslich Grössenangaben) wird dabei unterstützt. ===== 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 ''~~NOTOC~~'' ein. 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, Ebene 3 ==== === Überschrift, Ebene 4 === == Überschrift, Ebene 5 == ==== Überschrift, Ebene 3 ==== === Überschrift, Ebene 4 === == Überschrift, Ebene 5 == 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:dokuwiki-128.png}} Feste Breite:\\ {{wiki:dokuwiki-128.png?50}} Feste Breite und Höhe:\\ {{wiki:dokuwiki-128.png?200x50}} Externes Bild mit vorgegebener Grösse:\\ {{http://de3.php.net/images/php.gif?200x50}} Originalgrösse:\\ {{wiki:dokuwiki-128.png}} Feste Breite:\\ {{wiki:dokuwiki-128.png?50}} Feste Breite und Höhe:\\ {{wiki:dokuwiki-128.png?200x50}} Externes Bild mit vorgegebener Grösse:\\ {{http://de3.php.net/images/php.gif?200x50}} Durch Leerstellen links oder rechts vom Bildnamen kann man die Ausrichtung festlegen. {{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }} Natürlich kann man auch einen Titel angeben (der von den meisten Browsern als "Tooltip" angezeigt wird, wenn man mit dem Mauszeiger über dem Bild ist). {{ wiki:dokuwiki-128.png |Das ist der Titel}} {{ wiki:dokuwiki-128.png |Das ist der Titel}} Falls ein Dateiname angegeben wird (extern oder intern), der kein Bild ist (''gif,jpeg,png''), wird er als Link angezeigt. 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 ''*'' für eine nicht numerierte Liste oder ein ''-'' für eine numerierte Liste einfügt. 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>emoticon]]s in die entsprechenden, grafischen Symbole um. Hier ist eine Liste der Smileys, die DokuWiki unterstützt: * 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, z.B. auf Diskussionsseiten. Dazu kann man die folgende Syntax verwenden: Wir sollten das so machen. > Nein, sollten wir nicht. >> Doch, ich denke schon. >>> Wirklich? >>>> Ja! >>>>> Dann lass es uns so machen! Wir sollten das so machen. > Nein, sollten wir nicht. >> Doch, ich denke schon. >>> Wirklich? >>>> Ja! >>>>> Dann lass es uns so machen! ===== 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 ''|'' anfangen und enden. Für Kopfzeilen verwendet man ''^''. ^ Ü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, fügt man mindestens zwei Leerzeichen davor ein, für eine linksbündige Darstellung mindestens zwei Leerzeichen danach und für eine zentrierte Ausrichtung auf beiden Seiten. ^ Tabelle mit Ausrichtung ^^^ | rechts| zentriert |links | |links | rechts| zentriert | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | So sieht der Quelltext dazu aus: ^ Tabelle mit Ausrichtung ^^^ | rechts| zentriert |links | |links | rechts| zentriert | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | ===== Abschnitte ohne Formatierung ===== Es ist möglich, Abschnitte ohne Formatierung in ein Dokument zu übernehmen, indem man jede Zeile mit mindestens zwei Leerzeichen einrückt (wie in den vorangegangenen Beispielen) oder indem man den jeweiligen Abschnitte durch die Tags ''code'' oder ''file'' umschliesst. 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, d.h. ohne jegliche Interpration oder Formatierung durch DokuWiki, kann man ihn durch ''nowiki''-Tags umschliessen, oder noch einfacher durch doppelte Prozentzeichen ''%%''. Das ist etwas Text, der Adressen wie diese enthält: http://www.splitbrain.org und **Formatierung**, aber er wird trotzdem unformatiert angezeigt. Und hier noch ein Beispiel für die Variante mit doppelten Prozentzeichen: %%[[wiki:syntax]]%% 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://qbnz.com/highlighter/|GeSHi]] (Generic Syntax Highlighter) eingesetzt -- dadurch ist jede Sprache möglich, die GeSHi unterstützt. Die Syntax ist die selbe, wie für unformartierte Abschnitte, nur das zusätzlich der Name der Sprache angegeben wird, wie z.B. ''''. /** * 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 momentan unterstützt: //actionscript, actionscript-french, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, c, c_mac, cfm, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, html4strict, ini, inno, java, java5, javascript, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smarty, sql, tsql, robots, ruby, vb, vbnet, vhdl, visualfoxpro, xml// ===== Syntax Plugins ===== Die Syntax von DokuWiki kann durch [[doku>wiki:plugins|Plugins]] erweitert werden. Wie die installierten Plugins eingesetzt werden, ist ihren jeweiligen Beschreibungen erläutert. Die folgenden Syntax-Plugins sind in diesem Wiki vorhanden: ~~INFO:syntaxplugins~~