Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende ÜberarbeitungNächste ÜberarbeitungBeide Seiten der Revision | ||
wiki:syntax [2009/08/11 10:29] – cg301 | wiki:syntax [2009/08/31 12:14] – cg301 | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== | + | ====== |
- | ===== Einleitung | + | ===== Seite erstellen |
- | [[DokuWiki]] zeichnet sich durch einfache Formatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar. \\ | + | Um einen neuen Artikel zu erstellen, klicken Sie im Navigationskasten links auf "[[: |
- | **Hier wird die Syntax beschrieben um Seiten zu bearbeiten.** | + | ===== Seite bearbeiten |
- | Schau dir zum **Beispiel** diese Seite an, indem du den "Diese Seite bearbeiten" | + | Um eine Seite zu bearbeiten, klicken |
- | Zum Ausprobieren oder Üben kannst du den [[playground: | + | |
- | Einfache Formatierungen sind direkt durch [[doku> | + | |
- | ===== zur Übersetzung ===== | + | * Wählen Sie eine aussagekräftige Überschrift. |
+ | * Mit Hervorhebungen aller Art (fett, kursiv, bunt etc.) bitte sparsam umgehen. | ||
- | Diese Seite ist eine Übersetzung der [[http:// | ||
- | Sie ist keine wortgleiche Übersetzung. Einige Beschreibungen sind etwas ausführlicher ausgefallen. Fachbegriffe werden nur dort verwendet, wo eine Umschreibung mehr Verwirrung stiftet als nützt.\\ | ||
- | Ähnliches gilt auch für Begriffe, die dem Englischen entspringen, | ||
- | Der Übersetzer ist sich selbst nicht sicher, ob er lieber den Begriff " | ||
- | An einigen Stellen befindet sich ein FIXME - hier gibt es etwas, was im Sinne des Übersetzers noch nicht gut umgesetzt wurde. | + | ===== Schlagwörter / Tags ===== |
- | * Anregungen, Bemerkungen oder Hinweise auf Fehler sind willkommen. | + | |
- | * euer Sebastian Koch => mr_snede *at* web ~dot~ de | + | |
- | ====== 1 Texte ====== | + | Jedem Artikel können Schlagwörter zugeordnet werden. Dies erleichtert die Navigation im Wiki, denn die verschlagworteten Seiten erscheinen automatisch auf einer Übersichtseite. Wählen Sie unter jedem Artikel die passenden Stichwörter aus. |
- | ===== 1.1 Formatierungen | + | ===== Wiki-Syntax |
- | DokuWiki unterstützt **fetten**, // | ||
- | DokuWiki unterstützt **fetten**, // | + | ==== Textformatierung ==== |
- | Natürlich kann auch alles **__//'' | + | |
- | Ebenso gibt es < | + | === Schrift === |
- | Ebenso gibt es <sub>tiefgestellten</ | + | ^Syntax^Ergebnis^ |
+ | |%%**fett**%%|**fett**| | ||
+ | |%%// | ||
+ | |%%__unterstrichen__%%|__unterstrichen__| | ||
+ | |%%'' | ||
+ | |%%<sub>tiefgestellt</ | ||
+ | |%%<sup>hochgestellt</ | ||
+ | |%%< | ||
- | Text kann als gelöscht < | ||
- | Text kann als gelöscht < | + | ===Absätze === |
- | + | Ein Absatz wird erzeugt | |
- | ===== 1.2 Absätze | + | * eine leere Zeile oder |
- | Ein Absatz wird durch eine leere Zeile erzeugt. \\ | + | * %%\\%% am Ende einer Zeile oder |
- | < | + | |
- | + | ||
- | Dies ist ein Beispieltext mit einigen Zeilenumbrüchen.\\ Beachte: Die zwei umgekehrten Schrägstriche | + | |
- | werden nur erkannt, wenn sie am Zeilenende stehen\\ | + | |
- | oder wenn ihnen ein\\ Leerzeichen folgt.\\ So\\sieht es ohne Leerzeichen aus. | + | |
- | + | ||
- | | + | |
- | werden nur erkannt, wenn sie am Zeilenende stehen\\ | + | |
- | oder wenn ihnen ein\\ Leerzeichen | + | |
- | + | ||
- | Zeilenumbrüche durch zwei " | + | |
- | + | ||
- | ===== 1.3 Überschriften ===== | + | |
- | Mit fünf unterschiedlichen Ebenen, getrennt durch Überschriften, | + | |
- | Die Überschriften werden mit maximal sechs " | + | |
- | + | ||
- | Es ist __sinnvoll__, | + | |
- | + | ||
- | Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet.\\ | + | |
- | Soll dieses Inhaltsverzeichnis nicht erstellt werden, muß der Befehl: ''< | + | |
+ | === Überschriften ==== | ||
+ | Überschriften werden mit maximal sechs " | ||
====== Überschrift Ebene 1 ====== | ====== Überschrift Ebene 1 ====== | ||
===== Überschrift Ebene 2 ===== | ===== Überschrift Ebene 2 ===== | ||
Zeile 71: | Zeile 51: | ||
Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden! | Innerhalb von Überschriften können keine weiteren Formatierungen vorgenommen werden! | ||
+ | Überschrift 1 steht am Anfang eines Artikels. Wenn in einer Seite mehr als 3 Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. | ||
+ | Soll kein Inhaltsverzeichnis erstellt werden, muss der Befehl: ''< | ||
- | ===== 1.4 unformatierte Abschnitte ===== | ||
- | Um Text so anzuzeigen, wie er geschrieben wurde, egal ob er DokuWiki Formatierungen oder andere Formatierungen enthält, kann man jede | + | === unformatierte Abschnitte === |
- | Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner " | + | |
- | < | + | Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen oder verwendet %%< |
- | Mit " | + | |
- | </ | + | |
- | < | + | Um Text unformatiert in einer Box erscheinen |
- | Mit " | + | |
- | Vielleicht um Zitate | + | |
- | </ | + | |
- | Um jegliche Umwandlung durch DokuWiki abzustellen, | + | oder %%< |
- | <nowiki> | + | <file>mit file sieht es etwas anders aus .. </file> |
- | Dieser Text enthält links wie: http:// | + | |
- | </nowiki> | + | |
- | Einfach | + | Um jegliche Umwandlung durch DokuWiki abzustellen, |
- | ===== 1.5 Syntax-Hervorhebung ===== | ||
- | [[DokuWiki]] kennt Syntax highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird [[http:// | + | === Zitat / Kommentar === |
- | Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält: | + | Zitate oder Kommentar werden mit dem |
- | ''< | + | |
- | <code java> | + | %%> Zitat 1%% |
- | /** | + | |
- | * The HelloWorldApp class implements an application that | + | |
- | * simply displays "Hello World!" | + | |
- | */ | + | |
- | class HelloWorldApp { | + | |
- | public static void main(String[] args) { | + | |
- | System.out.println(" | + | |
- | } | + | |
- | } | + | |
- | </code> | + | |
- | Es werden folgende Sprachen unterstützt: | + | %%>> Antwort auf Zitat 1%% |
- | ===== 1.6 Zitat / Kommentar ===== | + | %%>>> |
- | Um einen Text als Zitat oder Kommentar zu kennzeichen, | + | |
- | Ich denke wir sollten es tun. | + | ergibt: |
- | + | ||
- | > Nein, sollten wir nicht. | + | |
- | + | ||
- | >> Doch! | + | |
- | + | ||
- | > Wirklich? | + | |
- | + | ||
- | >> Ja! | + | |
- | + | ||
- | >>> | + | |
- | + | ||
- | >>> | + | |
- | Ich denke wir sollten es tun | + | > Zitat 1 |
- | > Nein, sollten wir nicht. | + | >> Antwort auf Zitat 1 |
- | >> | + | >>> Antwort auf Antwort |
- | > Wirklich? | ||
- | |||
- | >> Ja! | ||
- | |||
- | >>> | ||
- | |||
- | >>> | ||
- | ====== 2 Links ====== | + | ==== Links ==== |
Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden: | Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden: | ||
- | ===== 2.1 Extern ===== | + | ^Externe Links|Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: |
- | + | ^ |Links | |
- | Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http:// | + | ^E-Mail-Adressen|%%< |
- | Verweise | + | ^ |oder ebenfalls |
- | E-mail Adressen werden in spitze Klammern gesetzt: < | + | ^Interne Links|%%[[start]]%% Namen für neue Seiten werden automatisch in Kleinbuchstaben umgewandelt. Umlaute sind genauso wie Sonderzeichen nicht erlaubt!|[[start]]| |
- | + | ^ |Interne Links können ebenfalls hinter Beschreibungen versteckt | |
- | Externe Links werden automatisch erkannt: http:// | + | ^ |Links zu [[:start|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten.| | |
- | Verweise können auch hinter eigenen Begriffen versteckt werden: | + | ^Links zu anderen |
- | E-mail Adressen | + | ^Bilder als Links|BEs ist möglich, auf interne oder externe |
- | + | ||
- | ===== 2.2 Intern ===== | + | |
- | + | ||
- | Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt(" | + | |
- | [[doku>pagename]]\\ | + | |
- | + | ||
- | Ein Link kann auch hinter | + | |
- | [[doku> | + | |
- | + | ||
- | Interne Links werden in doppelten eckigen Klammern gesetzt: | + | |
- | | + | |
- | + | ||
- | Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: | + | |
- | | + | |
- | + | ||
- | Dateinamen | + | |
- | Umlaute sind genauso wie Sonderzeichen nicht erlaubt! | + | |
- | + | ||
- | Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: | + | |
- | + | ||
- | Durch einen Doppelpunkt | + | |
- | + | ||
- | Weitere Informationen zu Namensbereichen: | + | |
- | + | ||
- | Anmerkungen: | + | |
- | + | ||
- | * Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten. | + | |
- | * DokuWiki verwendet standardmäßig keine [[wp> | + | |
- | + | ||
- | ===== 2.3 Interwiki ===== | + | |
- | + | ||
- | DokuWiki unterstützt auch Links in andere | + | |
- | Ein Link zur Wikipedia Seite über Wikis:[[wp> | + | |
- | + | ||
- | DokuWiki unterstützt auch Links in andere Wikis, sogenannte | + | |
- | Ein Link zur Wikipedia Seite über Wikis:[[wp> | + | |
- | + | ||
- | ===== 2.4 Windows-Freigaben ===== | + | |
- | + | ||
- | DokuWiki kennt auch Links auf Windows-Freigaben: | + | |
- | Dies ist allerdings nur in einer homogenen Benutzergruppe sinnvoll (siehe [[wp> | + | |
- | + | ||
- | DokuWiki kennt auch Links auf Windows-Freigaben: | + | |
- | + | ||
- | Hinweis: | + | |
- | * Aus Sicherheitsgründen funktioniert direktes Navigieren durch die Freigaben standardmäßig nur mit dem Internet Explorer (und das nur in der " | + | |
- | * Für Mozilla und Firefox kann es durch die Option [[http:// | + | |
- | * Opera ingnoriert als Sicherheitsfeature seit [[http:// | + | |
- | * Für weitere Informationen siehe: [[bug> | + | |
- | + | ||
- | ===== 2.5 Bilder als Links ===== | + | |
- | + | ||
- | Bilder können für einen Link auf eine interne oder externe | + | |
- | + | ||
- | [[http:// | + | |
- | + | ||
- | [[http:// | + | |
- | + | ||
- | Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, | + | |
- | + | ||
- | ====== 3 Bilder und andere Dateien ====== | + | |
- | + | ||
- | ===== 3.1 Bilder per Dialogfeld einbauen ===== | + | |
- | Das Hochladen von Bildern muss in der Konfigurationsdatei eingeschaltet sein. Zusätzlich kann der Seitenbetreiber diese Funktion per [[acl|ACL]] beschränken. Zum Hochladen ist mindestens die Berechtigung " | + | |
- | FIXME | + | |
- | + | ||
- | ===== 3.2 Größe von Bildern | + | |
- | Mit geschweiften Klammern können sowohl externe als auch interne [[doku> | + | |
- | + | ||
- | Original Größe: | + | |
- | + | ||
- | Eine Breite vorgeben: | + | |
- | Breite | + | ==== Bilder |
- | Größe | + | Mit geschweiften Klammern können sowohl externe als auch interne eingebunden werden. Optional kann deren Größe |
- | | + | ^Original Größe|%%{{wiki:dokuwiki-128.png}}%%|{{wiki: |
- | | + | ^Breite vorgeben|%%{{wiki:dokuwiki-128.png? |
- | Breite und Höhe vorgeben: | + | ^Breite und Höhe vorgeben|%%{{wiki:dokuwiki-128.png? |
- | Größe für externe Bilder vorgeben: | + | ^Größe für externe Bilder vorgeben|%%{{http:// |
- | ===== 3.3 Ausrichten von Bildern | + | === Ausrichten von Bildern === |
Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, | Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, | ||
Zeile 255: | Zeile 124: | ||
{{ wiki: | {{ wiki: | ||
- | bei Ausrichtung und der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt | ||
- | {{ wiki: | ||
- | {{wiki: | ||
- | {{ wiki: | ||
- | ===== 3.4 Tooltips ===== | + | === Tooltipps |
Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden. | Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden. | ||
- | {{ wiki: | + | %%{{ wiki: |
- | {{ wiki: | + | === Bilderrahmen === |
+ | Mit einfachen eckigen Klammern wird ein Bilderrahmen erzeugt. Hier wird der Titel nicht als Tooltipp, sondern im Rahmen als Bilduntertitel angezeigt: | ||
- | ===== 3.5 Dateidownload ===== | + | %%[{{ wiki: |
- | Wenn eine Datei angegeben wird, die kein Bild ('' | ||
- | {{ wiki: | + | === Dateidownload ==== |
+ | |||
+ | Alle Dateien außer Bilder ('' | ||
+ | |||
+ | %%{{ wiki: | ||
===== 3.6 Automatische Verlinkung ===== | ===== 3.6 Automatische Verlinkung ===== | ||
- | Bilder werden automatisch mit einer Verlinkung zur Ihren [[wp> | + | Bilder werden automatisch mit einer Verlinkung zur Ihren [[wp> |
+ | %%{{wiki: | ||
- | Dieses Verhalten kann über die Option ? | + | Dieses Verhalten kann über die Option ? |
- | {{wiki: | + | %%{{wiki: |
- | | + | |
- | Ausserdem | + | Außerdem |
- | {{wiki: | + | %%{{wiki: |
- | | + | |
- | ====== 4 Listen ====== | + | ==== Listen ==== |
+ | Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein " | ||
- | 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 " | + | < |
- | * Dies ist ein Eintrag einer unsortierten Liste | ||
* Ein zweiter Eintrag | * 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 | + | |
- | < | ||
* Dies ist ein Eintrag einer unsortierten Liste | * Dies ist ein Eintrag einer unsortierten Liste | ||
* Ein zweiter Eintrag | * Ein zweiter Eintrag | ||
* Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | ||
- | | + | |
+ | |||
+ | < | ||
+ | |||
+ | - Ein zweiter Eintrag | ||
+ | |||
+ | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen</ | ||
- Dies ist ein Eintrag einer nummerierte Liste | - Dies ist ein Eintrag einer nummerierte Liste | ||
- Ein zweiter Eintrag | - Ein zweiter Eintrag | ||
- Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | ||
- | - Noch ein Eintrag | ||
- | </ | ||
- | ====== 5 Tabellen ====== | ||
- | Mit DokuWiki können Tabellen ganz einfach erstellt werden: | ||
- | ^ hervorgehoben | + | ==== Tabellen ==== |
- | | Zeile 1 Spalte 1 | Zeile 1 Spalte 2 | Zeile 1 Spalte 3 | | + | |
- | | Zeile 2 Spalte 1 | doppelte Spaltenbreite (beachte den doppelten | + | Tabellenfelder werden mit senkrechten |
- | | Zeile 3 Spalte 1 | Zeile2 Spalte 2 | Zeile 2 Spalte 3 | + | |
- | Felder einer Tabelle starten mit " | ||
^ hervorgehoben | ^ hervorgehoben | ||
Zeile 328: | Zeile 193: | ||
| Zeile 3 Spalte 1 | Zeile2 Spalte 2 | Zeile 2 Spalte 3 | | | Zeile 3 Spalte 1 | Zeile2 Spalte 2 | Zeile 2 Spalte 3 | | ||
- | Zellen über mehrere Spalten werden erzeugt, wenn man, wie oben gezeigt, | + | |
+ | ^ hervorgehoben | ||
+ | | 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 am Ende einer solchen Spalte soviele " | ||
Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern " | Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern " | ||
Zeile 446: | Zeile 318: | ||
~~INFO: | ~~INFO: | ||
- | ====== | + | ====== |
+ | Diese Seite ist eine Übersetzung der [[http:// | ||
+ | Sie ist keine wortgleiche Übersetzung. Einige Beschreibungen sind etwas ausführlicher ausgefallen. Fachbegriffe werden nur dort verwendet, wo eine Umschreibung mehr Verwirrung stiftet als nützt.\\ | ||
+ | Ähnliches gilt auch für Begriffe, die dem Englischen entspringen, | ||
+ | Der Übersetzer ist sich selbst nicht sicher, ob er lieber den Begriff " | ||
+ | |||
+ | An einigen Stellen befindet sich ein FIXME - hier gibt es etwas, was im Sinne des Übersetzers noch nicht gut umgesetzt wurde. | ||
+ | * Anregungen, Bemerkungen oder Hinweise auf Fehler sind willkommen. | ||
+ | * euer Sebastian Koch => mr_snede *at* web ~dot~ de | ||
Seite grundlegend überarbeitet von --- // | Seite grundlegend überarbeitet von --- // | ||
+ | {{tag> |