Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen RevisionVorhergehende Überarbeitung | |||
wiki:syntax [2023/07/26 08:37] – cbuehler | wiki:syntax [2025/01/07 16:26] (aktuell) – Externe Bearbeitung 127.0.0.1 | ||
---|---|---|---|
Zeile 137: | Zeile 137: | ||
Resize to given width and height((when the aspect ratio of the given width and height doesn' | Resize to given width and height((when the aspect ratio of the given width and height doesn' | ||
- | Resized external image: {{https://secure.php.net/ | + | Resized external image: {{https://www.php.net/ |
Real size: {{wiki: | Real size: {{wiki: | ||
Resize to given width: | Resize to given width: | ||
Resize to given width and height: {{wiki: | Resize to given width and height: {{wiki: | ||
- | Resized external image: {{https://secure.php.net/ | + | Resized external image: {{https://www.php.net/ |
Zeile 474: | Zeile 474: | ||
~~INFO: | ~~INFO: | ||
- | |||
- | ====== Syntax ====== | ||
- | |||
- | [[DokuWiki]] zeichnet sich u. a. durch einfache Textformatierungen aus. Dadurch bleiben die Dateien, die den Inhalt enthalten, gut lesbar. | ||
- | In den nachfolgenden Abschnitten sind die möglichen Formatierungsarten aufgelistet, | ||
- | Ein erstes Beispiel, wie der Aufbau einer Seite aussehen kann, findest du, wenn du dir diese Seite im Quelltext-Modus anzeigen lässt. Klicke dazu auf den Button " | ||
- | |||
- | Zum Ausprobieren oder Üben kann die [[playground: | ||
- | |||
- | |||
- | ====== 1 Texte ====== | ||
- | ===== 1.1 Formatierungen ===== | ||
- | |||
- | DokuWiki unterstützt **fetten**, // | ||
- | |||
- | DokuWiki unterstützt **fetten**, // | ||
- | Natürlich kann auch alles **__//'' | ||
- | |||
- | Ebenso gibt es < | ||
- | |||
- | Ebenso gibt es < | ||
- | |||
- | Text kann als < | ||
- | |||
- | Text kann als < | ||
- | |||
- | ===== 1.2 Absätze ===== | ||
- | |||
- | Ein Absatz wird durch eine leere Zeile erzeugt. Eine neue Zeile (Zeilenumbruch) kann durch zwei " | ||
- | |||
- | 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. | ||
- | |||
- | 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. | ||
- | |||
- | 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 drei Überschriften vorkommen, wird automatisch ein Inhaltsverzeichnis erstellt, welches alle Überschriften auflistet. | ||
- | Soll dieses Inhaltsverzeichnis nicht erstellt werden, muss der Befehl: ''< | ||
- | |||
- | ====== Überschrift Ebene 1 ====== | ||
- | ===== Überschrift Ebene 2 ===== | ||
- | ==== Überschrift Ebene 3 ==== | ||
- | === Überschrift Ebene 4 === | ||
- | == Überschrift Ebene 5 == | ||
- | |||
- | Innerhalb von Überschriften können standardmäßig keine weiteren Formatierungen vorgenommen werden! (s. [[faq: | ||
- | |||
- | ===== 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 | ||
- | Zeile mit zwei Leerzeichen beginnen (so wie es in dieser Seite angewendet wurde) oder einen der Bezeichner " | ||
- | |||
- | < | ||
- | Mit " | ||
- | </ | ||
- | |||
- | |||
- | <file plain Beispiel.txt> | ||
- | Mit dem Bezeichner " | ||
- | auf einer Seite zum Download angeboten werden. | ||
- | </ | ||
- | |||
- | Innerhalb von " | ||
- | |||
- | <file perl HelloWorld.pl> | ||
- | # | ||
- | print "Hello World!\n"; | ||
- | </ | ||
- | |||
- | <file perl HelloWorld.pl> | ||
- | # | ||
- | print "Hello World!\n"; | ||
- | </ | ||
- | |||
- | Um jegliche Umwandlung durch DokuWiki abzustellen, | ||
- | |||
- | < | ||
- | Dieser Text enthält Links wie: http:// | ||
- | </ | ||
- | |||
- | %%Dieser Text ist nun mit %%''< | ||
- | |||
- | " | ||
- | |||
- | Einfach den Quelltext dieser Seite anschauen (den Knopf " | ||
- | |||
- | ===== 1.5 Syntax-Hervorhebung ===== | ||
- | |||
- | [[DokuWiki]] kennt Syntax-Highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird [[http:// | ||
- | Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält: | ||
- | ''< | ||
- | |||
- | <code java> | ||
- | /** | ||
- | * The HelloWorldApp class implements an application that | ||
- | * simply displays "Hello World!" | ||
- | */ | ||
- | class HelloWorldApp { | ||
- | public static void main(String[] args) { | ||
- | System.out.println(" | ||
- | } | ||
- | } | ||
- | </ | ||
- | |||
- | Es werden folgende Sprachen unterstützt: | ||
- | |||
- | ===== 1.6 Zitat / Kommentar ===== | ||
- | Um einen Text als Zitat oder Kommentar zu kennzeichnen, | ||
- | |||
- | Ich denke wir sollten es tun. | ||
- | | ||
- | > Nein, sollten wir nicht. | ||
- | | ||
- | >> Doch! | ||
- | | ||
- | > Wirklich? | ||
- | | ||
- | >> Ja! | ||
- | | ||
- | >>> | ||
- | | ||
- | >>> | ||
- | |||
- | Ich denke wir sollten es tun | ||
- | |||
- | > Nein, sollten wir nicht. | ||
- | |||
- | >> Doch! | ||
- | |||
- | > Wirklich? | ||
- | |||
- | >> Ja! | ||
- | |||
- | >>> | ||
- | |||
- | >>> | ||
- | |||
- | ===== 1.7 Escapezeichen ===== | ||
- | Will man verhindern, dass DokuWiki irgendwelche Formatierungen am bzw. Umwandlungen im Text vornimmt so kann man die Prozentzeichen benutzen | ||
- | < | ||
- | Die Ausgabe würde dann folgendermaßen aussehen %%[[wiki: | ||
- | |||
- | ===== 1.8 Fußnoten ===== | ||
- | |||
- | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)). 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 durch eine doppelte runde Klammer dargestellt ((eine zweite Fußnote)) | ||
- | | ||
- | ===== 1.9 Linien ===== | ||
- | |||
- | Durch vier oder mehr Bindestriche bzw. Minuszeichen " | ||
- | ----- | ||
- | |||
- | |||
- | |||
- | |||
- | ====== 2 Links ====== | ||
- | |||
- | Mit DokuWiki können fünf unterschiedliche Arten von Links benutzt werden: | ||
- | |||
- | ===== 2.1 Extern ===== | ||
- | |||
- | Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http:// | ||
- | Verweise können auch hinter eigenen Begriffen versteckt werden: [[http:// | ||
- | E-Mail Adressen werden in spitze Klammern gesetzt: < | ||
- | |||
- | Externe Links werden automatisch erkannt: http:// | ||
- | Verweise können auch hinter eigenen Begriffen versteckt werden: [[http:// | ||
- | E-Mail Adressen werden in spitze Klammern gesetzt: < | ||
- | |||
- | ===== 2.2 Intern ===== | ||
- | |||
- | Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt ("Alt Gr+8" bzw. Alt Gr+9 unter Windows bzw. Wahltaste+5 und Wahltaste+6 bei Apple-Betriebssystemen): | ||
- | [[doku> | ||
- | |||
- | Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: | ||
- | [[pagename|Beschreibung für einen Link]]. | ||
- | |||
- | Interne Links werden in doppelten eckigen Klammern gesetzt: | ||
- | [[pagename]] | ||
- | | ||
- | Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden: | ||
- | [[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: [[de: | ||
- | |||
- | Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst: | ||
- | |||
- | Weitere Informationen zu Namensbereichen: | ||
- | |||
- | Die Verlinkung zu einem speziellen Abschnitt innerhalb des Dokuments (Anker) ist auch möglich. Der Abschnittsnamen wird getrennt durch ein Doppelkreuz (#) an den Seitennamen gehängt. | ||
- | |||
- | Dieses Beispiel verlinkt zu [[de: | ||
- | |||
- | Dieses Beispiel verlinkt zu [[de: | ||
- | |||
- | |||
- | Anmerkungen: | ||
- | |||
- | * Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten. | ||
- | * DokuWiki verwendet standardmäßig keine [[wpde> | ||
- | * Ändert sich eine Überschrift im Zieldokument, | ||
- | * Anker werden klein geschrieben, | ||
- | |||
- | ===== 2.3 Interwiki ===== | ||
- | |||
- | DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku> | ||
- | Ein Link zur Wikipedia Seite über Wikis: | ||
- | |||
- | DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku> | ||
- | Ein Link zur Wikipedia Seite über Wikis: | ||
- | |||
- | ===== 2.4 Windows-Freigaben ===== | ||
- | |||
- | DokuWiki kennt auch Links auf Windows-Freigaben: | ||
- | Dies ist allerdings nur in einer homogenen Benutzergruppe sinnvoll (siehe [[wpde> | ||
- | |||
- | [[\\server\freigabe|this]]. | ||
- | |||
- | 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 ignoriert 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 Datei verwendet werden. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern (siehe unten) kombiniert: | ||
- | |||
- | | ||
- | |||
- | [[http:// | ||
- | |||
- | Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, | ||
- | |||
- | ====== 3 Bilder und andere Dateien ====== | ||
- | |||
- | ===== 3.1 Bilder im DokuWiki speichern ===== | ||
- | |||
- | Um Bilder im DokuWiki speichern zu dürfen, muss der Benutzer die entsprechende Berechtigung besitzen ([[de: | ||
- | |||
- | ===== 3.2 Größe von Bildern | ||
- | Mit geschweiften Klammern können sowohl externe als auch interne [[doku> | ||
- | |||
- | Originalgröße: | ||
- | |||
- | Eine Breite vorgeben: | ||
- | |||
- | Breite und Höhe vorgeben: | ||
- | |||
- | Größe für externe Bilder vorgeben: | ||
- | |||
- | Originalgröße: | ||
- | Eine Breite vorgeben: | ||
- | Breite und Höhe vorgeben: | ||
- | Größe für externe Bilder vorgeben: | ||
- | |||
- | ===== 3.3 Ausrichten von Bildern ===== | ||
- | Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden (Links, Zentriert, Rechts). | ||
- | |||
- | {{ wiki: | ||
- | |||
- | {{wiki: | ||
- | |||
- | {{ wiki: | ||
- | |||
- | | ||
- | {{wiki: | ||
- | {{ 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 ===== | ||
- | Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden. | ||
- | |||
- | {{ wiki: | ||
- | |||
- | {{ wiki: | ||
- | |||
- | ===== 3.5 Dateidownload ===== | ||
- | |||
- | Wenn eine Datei angegeben wird, die kein Bild ('' | ||
- | |||
- | {{ wiki: | ||
- | < | ||
- | |||
- | ===== 3.6 Automatische Verlinkung ===== | ||
- | |||
- | Bilder werden automatisch mit einer Verlinkung zur Ihren [[wpde> | ||
- | |||
- | Dieses Verhalten kann über die Option ? | ||
- | |||
- | {{wiki: | ||
- | {{wiki: | ||
- | |||
- | Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, | ||
- | |||
- | {{wiki: | ||
- | {{wiki: | ||
- | |||
- | ====== 4 Listen ====== | ||
- | |||
- | DokuWiki kennt unsortierte und nummerierte Listen. Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit zwei Leerzeichen. Diesen Leerzeichen folgt dann ein " | ||
- | |||
- | * Dies ist ein Eintrag einer unsortierten Liste | ||
- | * Ein zweiter Eintrag | ||
- | * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen | ||
- | * Noch ein Eintrag | ||
- | |||
- | - Dies ist ein Eintrag einer nummerierte Liste | ||
- | - Ein zweiter Eintrag | ||
- | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen | ||
- | - Noch ein Eintrag | ||
- | |||
- | < | ||
- | * Dies ist ein Eintrag einer unsortierten Liste | ||
- | * Ein zweiter Eintrag | ||
- | * Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen | ||
- | * Noch ein Eintrag | ||
- | |||
- | - Dies ist ein Eintrag einer nummerierte Liste | ||
- | - Ein zweiter Eintrag | ||
- | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren zwei Leerzeichen | ||
- | - Noch ein Eintrag | ||
- | </ | ||
- | |||
- | ====== 5 Tabellen ====== | ||
- | |||
- | ===== 5.1 Grundlegender Aufbau ===== | ||
- | |||
- | Mit DokuWiki können Tabellen ganz einfach erstellt werden: | ||
- | |||
- | ^ 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 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 | | ||
- | | Zeile 4 Spalte 1 | | Zeile 4 Spalte 3 | | ||
- | |||
- | Felder einer Tabelle starten mit " | ||
- | |||
- | ^ 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 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 | | ||
- | |||
- | ===== 5.2 Formatierung/ | ||
- | |||
- | === Leerzellen === | ||
- | |||
- | Zellen über mehrere Spalten werden erzeugt wenn man, wie oben gezeigt, am Ende einer solchen Spalte so viele " | ||
- | Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern " | ||
- | |||
- | 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 (" | ||
- | |||
- | | ^ 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 | | ||
- | |||
- | === Zellen verbinden === | ||
- | |||
- | Felder über mehrere Zeilen (**vertikal verbundene Zellen**) lassen sich durch hinzufügen von '':::'' | ||
- | :!: Zum Stand der //Release 2015-08-10a " | ||
- | |||
- | |||
- | ^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^ | ||
- | | Zeile 1 Spalte 1 | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3 | | ||
- | | Zeile 2 Spalte 1 | ::: | Zeile 2 Spalte 3 | | ||
- | | Zeile 3 Spalte 1 | ::: | Zeile 3 Spalte 3 | | ||
- | |||
- | Außer den drei Doppelpunkten darf die zu verbindende Zelle keine weiteren Inhalte haben. | ||
- | |||
- | ^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^ | ||
- | | Zeile 1 Spalte 1 | Diese Zelle ist vertikal verbunden | Zeile 1 Spalte 3 | | ||
- | | Zeile 2 Spalte 1 | ::: | Zeile 2 Spalte 3 | | ||
- | | Zeile 3 Spalte 1 | ::: | Zeile 3 Spalte 3 | | ||
- | |||
- | |||
- | Felder über mehrere Spalten (**horizontal verbundene Zellen**) lassen sich durch hinzufügen von '' | ||
- | |||
- | ^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^ | ||
- | | Zeile 1 Spalte 1 | Diese Zelle ist horizontal verbunden | ||
- | | Zeile 2 Spalte 1 | Zeile 2 Spalte 2 | Zeile 2 Spalte 3 | | ||
- | | Zeile 3 Spalte 1 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 | | ||
- | |||
- | ^ Titelzeile 1 ^ Titelzeile 2 ^ Titelzeile 3 ^ | ||
- | | Zeile 1 Spalte 1 | Diese Zelle ist horizontal verbunden | ||
- | | Zeile 2 Spalte 1 | Zeile 2 Spalte 2 | ||
- | | Zeile 3 Spalte 1 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 | | ||
- | |||
- | === Textausrichtung === | ||
- | |||
- | Der Inhalt einer Zelle kann horizontal innerhalb der Zelle ausgerichtet werden: | ||
- | * Rechtsbündig - zwei Leerzeichen links vom Text | ||
- | * Linksbündig - Leerzeichen rechts vom Text | ||
- | * Zentriert - zwei Leerzeichen links und rechts vom Text | ||
- | |||
- | ^ Tabelle mit Ausrichtung | ||
- | | Rechts | Mitte | Links | | ||
- | | Links | ||
- | | xxxxxxxxxxxx | ||
- | |||
- | So sieht die Formatierung aus: | ||
- | |||
- | ^ Tabelle mit Ausrichtung | ||
- | | Rechts| | ||
- | |Links | ||
- | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | |||
- | | Hinweis zu dem senkrechten Balken-Zeichen: | ||
- | |||
- | ====== 6 sonstige Formatierungen ====== | ||
- | |||
- | ===== 6.1 horizontale Linie ===== | ||
- | Mit vier aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden: | ||
- | ---- | ||
- | < | ||
- | |||
- | |||
- | ===== 6.2 Smileys ===== | ||
- | |||
- | DokuWiki verwandelt oft genutzte [[wpde> | ||
- | Weitere Smiley-Grafiken können im Ordner " | ||
- | Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys: | ||
- | |||
- | ^ 8-) ^ 8-O ^ :-( ^ :-) ^ =) ^ :-/ ^ :-\ ^ :-? ^ :-D ^ :-P ^ :-O ^ :-X ^ :-| ^ ;-) ^ :?: ^ :!: ^ '' | ||
- | | %% 8-) %% | %% 8-O %% | %% :-( %% | %% :-) %% | %% =) | ||
- | |||
- | ===== 6.3 Typografie ===== | ||
- | |||
- | [[DokuWiki]] kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln. | ||
- | Hier eine Liste aller Zeichen, die DokuWiki kennt: | ||
- | |||
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
- | "He thought ' | ||
- | |||
- | < | ||
- | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
- | "He thought ' | ||
- | </ | ||
- | |||
- | Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden | ||
- | |||
- | ===== 6.4 HTML und PHP einbinden ===== | ||
- | |||
- | In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden. | ||
- | |||
- | < | ||
- | This is some <font color=" | ||
- | </ | ||
- | |||
- | < | ||
- | < | ||
- | This is some <font color=" | ||
- | </ | ||
- | </ | ||
- | |||
- | < | ||
- | <php> | ||
- | echo 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | </ | ||
- | </ | ||
- | |||
- | < | ||
- | <php> | ||
- | echo 'A logo generated by PHP:'; | ||
- | echo '< | ||
- | </ | ||
- | </ | ||
- | |||
- | **Achtung**: | ||
- | |||
- | **Achtung**: | ||
- | |||
- | ====== 7 Kontroll-Makros ====== | ||
- | |||
- | Einige Syntax-Befehle beeinflussen wie Dokuwiki eine Seite beim Aufruf ausgibt. Die folgenden Kontroll-Makros sind verfügbar: | ||
- | |||
- | ^ Makro ^ Beschreibung ^ | ||
- | | %%~~NOTOC~~%% | ||
- | | %%~~NOCACHE~~%% | Alle Seiten werden aus Performancegründen zwischengespeichert. Unter bestimmten Umständen ist dieses Verhalten aber nicht gewollt. Beim Einfügen dieses Makros wird DokuWiki angewiesen, den Inhalt der Seite neu aufzubauen. | | ||
- | |||
- | ---- | ||
- | ====== 8 Syntax-Plugins ====== | ||
- | Die Syntax von DokuWiki kann durch [[doku> | ||
- | |||
- | ~~INFO: | ||
- | |||
- | ====== 9 Color Plugin ====== | ||
- | |||
- | Platzieren Sie dieses Code-Beispiel auf Ihrer Testumgebung: | ||
- | |||
- | < | ||
- | <color green> | ||
- | <color blue/ | ||
- | <color # | ||
- | <color /# | ||
- | <color rgb(80%, | ||
- | <color hsl(120, | ||
- | </ | ||
- | |||
- | folgendes Ergebnis sollte dann zu sehen sein: | ||
- | |||
- | {{https:// | ||
- | |||
- | Dieses Plugin unterstützt die [[wp> | ||
- | Hex-Dreifache (wie #123 oder #123456 für RGB), | ||
- | Hex-Vierfach (#1234 oder #12345678 für RGBA), | ||
- | [[https:// | ||
- | Farbspezifikationen. | ||
- | Dieses Plugin kann keine Syntaxfehler in Ihren Farbspezifikationen erkennen. | ||
- | Wenn Sie diese Spezifikationen falsch verwenden, werden Sie nicht funktionieren. | ||
- | Beachten Sie, dass nicht alle Farbspezifikationen auf allen Browsern funktionieren. | ||
- | Überprüfen Sie im Zweifelsfall [[https:// | ||
- | |||
- | ====== 10 Zellen Hintergrund Plugin ====== | ||
- | |||
- | ===== 10.1 Syntax und Verwendung ===== | ||
- | |||
- | Eine Hintergrundfarbe wird durch " | ||
- | Sie können alle Namen und Farbcodes aus HTML verwenden. | ||
- | Wenn Sie keine Farbe angeben, wird Gelb verwendet. | ||
- | Siehe Beispiele unten: | ||
- | |||
- | ===== 10.2 Beispiele ===== | ||
- | |||
- | Dieser Code: | ||
- | < | ||
- | ^ Header 1 | ||
- | | @lightgreen: | ||
- | | @# | ||
- | | Ligne 2 | Oui | ||
- | | @:Ligne 3 | Oui | @red: | ||
- | </ | ||
- | erzeugt folgendes: \\ | ||
- | ^ Header 1 | ||
- | | @lightgreen: | ||
- | | @# | ||
- | | Ligne 2 | Oui | ||
- | | @:Ligne 3 | Oui | @red: | ||
- | |||
- | Dieser Code: | ||
- | < | ||
- | | @palegreen: | ||
- | </ | ||
- | dieses Ergebnis: \\ | ||
- | | @palegreen: | ||
- | |||
- | ===== 10.3 Features ===== | ||
- | * Uses HTML color codes and names [[http:// | ||
- | * Works with other table formatting (alignment, bold, ...) | ||
- | |||
- | ====== 11 Table Width Plugin ====== | ||
- | |||
- | ===== 11.1 Syntax ===== | ||
- | |||
- | The width has to be specified at the start of a line before the table. The first value is used as width of the table, the rest is for columns. If you want to omit some value use a dash instead. The widths can be specified in any CSS units: | ||
- | |||
- | < | ||
- | |< 100% 50px - 5em 10em 10% >| | ||
- | ^ A ^ B ^ C ^ D ^ E ^ | ||
- | | 1 | 2 | 3 | 4 | 5 | | ||
- | </ | ||
- | |||
- | The relative units (percentage) for the table width refer to the width of the page, and when used for columns they refer for the table wight. For example, the width specification '' | ||
- | |||
- | If there are more columns in the table than there are values in the width specification, | ||
- | |||
- | < | ||
- | |< 50em 20% >| | ||
- | ^ 20% ^ 80% ^ | ||
- | | Specified width | The rest of the table width | | ||
- | </ | ||
- | |||
- | ====== 12 Wrap Plugin ====== | ||
- | |||
- | Universal plugin which combines the functionality of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction. | ||
- | |||
- | ===== 12.1 One plugin to rule them all ===== | ||
- | |||
- | This plugin gives you the ability to wrap wiki text inside containers (divs or spans) and give them | ||
- | - a certain class (with loads of useful preset classes) | ||
- | - a width | ||
- | - a language with its associated text direction | ||
- | |||
- | It potentially replaces a lot of other plugins and is IMHO the better alternative for many. | ||
- | |||
- | It fully replaces: [[class]], [[clearfloat]], | ||
- | |||
- | It partly replaces: [[box]], [[button]], [[color]], [[columns]], | ||
- | |||
- | ===== 12.2 Syntax ===== | ||
- | |||
- | Basic Syntax: | ||
- | <WRAP classes #id width : | ||
- | " | ||
- | </ | ||
- | | ||
- | **or** | ||
- | <block classes #id width : | ||
- | " | ||
- | </ | ||
- | | ||
- | or | ||
- | <div classes #id width : | ||
- | " | ||
- | </ | ||
- | An uppercase **%%< | ||
- | | ||
- | <wrap classes #id width : | ||
- | | ||
- | or | ||
- | <inline classes #id width : | ||
- | | ||
- | or | ||
- | <span classes #id width : | ||
- | A lowercase **%%< | ||
- | |||
- | Since version 2013-06-13 there is also a shorthand syntax (for wraps without content): | ||
- | |||
- | <WRAP classes #id /> or <block classes #id /> or <div classes #id /> | ||
- | |||
- | and | ||
- | |||
- | <wrap classes #id /> or <inline classes #id /> or <span classes #id /> | ||
- | |||
- | :!: Please note, some things **won' | ||
- | |||
- | ==== 12.2.1 Examples ==== | ||
- | |||
- | The plugin comes with an example page, which should explain a lot and looks like this in the default template (see below). | ||
- | |||
- | ==== 12.2.2 Classes ==== | ||
- | |||
- | The following classes are currently available: | ||
- | |||
- | {{ : | ||
- | |||
- | ^ class name ^ description/ | ||
- | ^ __columns__ -- similar to [[columns]], | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | ^ __widths__ -- :!: **experimental**, | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | ^ __alignments__ -- similar to [[divalign]], | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | ^ __boxes and notes__ -- similar to [[box]], [[note]], [[tip]] | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | ^ __marks__ -- similar to [[emphasis]], | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | ^ __miscellaneous__ | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | | **'' | ||
- | |||
- | === 12.2.2.1 Known restrictions === | ||
- | |||
- | * WRAPs export to ODT format but not everything works 100% | ||
- | * Round corners only work in modern browsers (no IE8 and below). | ||
- | * Multiple columns only work in modern browsers (no IE9 and below). | ||
- | * Width classes are experimental and only work in modern browsers (no IE8 and below). | ||
- | * Normal DokuWiki Headlines used to not work and a work-around was added. Now that headlines do work, the work-around is not needed anymore but kept for backwards-compatibility. It was deprecated in version 2018-04-22 and disabled by default. They can be enabled by using the '' | ||
- | * %%//**__Big Underlined Headline__**// | ||
- | * %%//**Small Headline**// | ||
- | |||
- | You might need to adjust a few of the classes to your template' | ||
- | |||
- | The classes are easily adjustable and extensible. Any wishes are welcome. | ||
- | |||
- | ==== 12.2.3 Widths ==== | ||
- | |||
- | You can set any valid widths on any uppercase %%< | ||
- | <WRAP someclass 50% anotherclass> | ||
- | All except percentages will be reduced to have the maximum width available on smaller screens. | ||
- | |||
- | You can also use the width keywords '' | ||
- | <WRAP group> | ||
- | <WRAP half column> | ||
- | <WRAP half column> | ||
- | </ | ||
- | will result in two columns next to each other, which will wrap underneath each other on smaller screens and mobile devices. | ||
- | |||
- | ==== 12.2.4 Languages and Text Directions ==== | ||
- | |||
- | You can change the language and the direction of a container by simply adding a colon followed by the language code, like this: | ||
- | |||
- | <wrap :en>This text is explicitly marked as English.</ | ||
- | |||
- | The text direction ('' | ||
- | |||
- | If you like to mark a text with a different text direction than the default one, you should use divs, i.e. uppercase '' | ||
- | |||
- | This makes it a better replacement of [[ltr]] (and [[lang]]). | ||
- | |||
- | ===== 12.3 Demo ===== | ||
- | |||
- | You can see a demo of the plugin on [[http:// | ||
- | |||
- | [[https:// | ||
- | |||
- | ===== 12.4 Configuration options ===== | ||
- | |||
- | ^ Option | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |'' | ||
- | |||
- | ===== 12.5 ODT Support ===== | ||
- | |||
- | FIXME There have been more updates to the Wrap as well as the ODT plugin, so more stuff works. The below should be updated with what works and what doesn' | ||
- | |||
- | Since version 2015-06-13 the Wrap plugin supports exporting most of its functionality/ | ||
- | |||
- | * add wrap to the ' | ||
- | * set the ' | ||
- | |||
- | If you prefer a user defined CSS style for the Wrap ODT export, then simply place a file ' | ||
- | |||
- | Here is what is currently **not** supported: | ||
- | |||
- | * columns: left/ | ||
- | * widths are not supported except % and half/ | ||
- | * boxes and notes: hardly any formatting inside them is supported, therefore emulated headings also don't work | ||
- | * tabs will just show a list of links | ||
- | * noprint | ||
- | * nopagebreak | ||
- | * onlyprint only works on boxes | ||
- | * languages are set correctly but do not seem to affect text alignment | ||
- | * shorthand syntax | ||
- | * Not supported because not relevant in ODT: clear, prewrap | ||
- | |||
- | ===== 12.6 Toolbar picker ===== | ||
- | |||
- | {{ : | ||
- | |||
- | The wrap picker in the editing toolbar adds the most common wrap syntaxes. | ||
- | |||
- | * " | ||
- | * " | ||
- | * "info, tip, important, alert, help, download, todo box" creates specifically themed boxes (also 60% wide, centered) | ||
- | * "clear floats" | ||
- | * " | ||
- | |||
- | ===== 12.7 Extend with custom styles ===== | ||
- | |||
- | If you like to add your own classes and styles to the plugin, you can simply add the styles for your class preceded by "'' | ||
- | |||
- | E.g. if you need a '' | ||
- | |||
- | User permissions for every file used must be similar to original DokuWiki files. | ||
- | |||
- | |||
- | Since version 2010-03-14 you have the possibility to exclude certain class names from being prefixed with " | ||
- | |||
- | ==== 12.7.1 Examples ==== | ||
- | |||
- | in style.css | ||
- | |||
- | <code css> | ||
- | .dokuwiki div.wrap_note{ /* added */ | ||
- | background-color: | ||
- | color: #000; | ||
- | padding: .5em .5em .5em .5em; | ||
- | margin-bottom: | ||
- | overflow: hidden; | ||
- | } | ||
- | </ | ||
- | |||
- | call in DW-page: | ||
- | <WRAP note> | ||
- | |||
- | Here are some [[plugin: | ||
- | ==== 12.7.2 Add former typography classes ==== | ||
- | |||
- | The old typography classes were removed in version 2011-05-15. If you need something similar, use the [[Block]] plugin instead. Or you can use your own and copy them to your own user styles (see [[#Extend with custom styles|above]]). | ||
- | |||
- | ===== 12.8 How to use the helper ===== | ||
- | |||
- | From version 2011-05-15 on the plugin includes a helper plugin which you can use to add classes, width and lang/dir to any other plugin. | ||
- | |||
- | ==== 12.8.1 Example how to get just one kind of attribute ==== | ||
- | |||
- | <code php> | ||
- | // get lang from wrap helper plugin | ||
- | $lang = ''; | ||
- | if(!plugin_isdisabled(' | ||
- | $wrap = plugin_load(' | ||
- | $attr = $wrap-> | ||
- | if($attr[' | ||
- | } | ||
- | |||
- | // add lang to your plugin' | ||
- | $renderer-> | ||
- | </ | ||
- | |||
- | '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | * '' | ||
- | |||
- | ==== 12.8.2 Example how to get all attributes ==== | ||
- | |||
- | <code php> | ||
- | // get attributes from wrap helper plugin | ||
- | $attr = ''; | ||
- | if(!plugin_isdisabled(' | ||
- | $wrap = plugin_load(' | ||
- | $attr = $wrap-> | ||
- | } | ||
- | |||
- | // add those attributes to your plugin' | ||
- | $renderer-> | ||
- | </ | ||
- | |||
- | '' | ||