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/31 12:14] – cg301 | wiki:syntax [2010/06/16 16:45] – bush | ||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== Wiki-Hilfe====== | + | ====== Wiki-Guide====== |
+ | \\ | ||
+ | // | ||
+ | \\ | ||
+ | ====== Regeln fürs Mitmachen ====== | ||
+ | - Bitte regen Sie größere **Veränderungsvorschläge** / Korrekturen - wie z. B. in der Wikipedia üblich - zunächst auf den jeweiligen **Diskussionsseiten**, | ||
+ | * Auf den Diskussionsseiten können zudem fachliche (!) Differenzen und Unklarheiten sachlich diskutiert werden. | ||
+ | * Jeden Diskussionsbeitrag bitte " | ||
+ | * Antworten / Reaktionen auf Beiträge [[# | ||
+ | - Machen Sie die von Ihnen vorgenommenen **Änderungen** deutlich: | ||
+ | * Sofern Sie nur kleine Änderungen in einem Artikel vornehmen (sprich: Komma ergänzt, Tippfehler korrigiert), | ||
+ | * Bei allen anderen Änderungen bitte unter dem Artikel unter " | ||
+ | - Artikel bitte sachlich formulieren und sparsam formatieren. Hierzu bitte die [[# | ||
+ | |||
+ | |||
+ | <note tip> | ||
+ | |||
+ | \\ | ||
===== Seite erstellen ===== | ===== Seite erstellen ===== | ||
Um einen neuen Artikel zu erstellen, klicken Sie im Navigationskasten links auf " | Um einen neuen Artikel zu erstellen, klicken Sie im Navigationskasten links auf " | ||
+ | **Neue Seiten können Sie alternativ auf folgende Weise anlegen: | ||
+ | |||
+ | Verlinken Sie auf einer bestehenden Seite ein Wort mit doppelten eckigen Klammern < | ||
+ | |||
+ | \\ | ||
===== Seite bearbeiten ===== | ===== Seite bearbeiten ===== | ||
- | Um eine Seite zu bearbeiten, klicken an der oberen Leiste auf "Seite bearbeiten" | + | * Um eine Seite zu bearbeiten, klicken an der oberen Leiste auf "Seite bearbeiten" |
+ | * Nutzen Sie beim Bearbeiten der Seite den " | ||
- | * Wählen Sie eine aussagekräftige Überschrift. | + | \\ |
- | * Mit Hervorhebungen aller Art (fett, kursiv, bunt etc.) bitte sparsam umgehen. | + | ===== Formatierungshinweise ===== |
+ | Bitte orientieren Sie sich an den bestehenden Seiten. | ||
- | ===== Schlagwörter | + | * Wählen Sie eine aussagekräftige Überschrift. |
+ | * Artikel beginnen mit der Überschrift 1 (H1). Diese ist gleichzeitig der Seitenname und wird so in den Index übernommen | ||
+ | * Den Artikel sinnvoll mit Überschriften ab H2 strukturieren | ||
+ | * Möglichst sparsam mit Hervorhebungen aller Art umgehen (fett, unterstrichen, | ||
+ | * Bilder möglichst in einen Rahmen setzen und mit einer Bildbeschriftung versehen (s.u. [[# | ||
+ | * Bilder zuerst links im Menü unter Werkzeuge in den passenden Bereich hochladen, dann in den Artikel einfügen. | ||
+ | * Verlinken Sie den Artikel möglichst mit bereits bestehenden Seiten (wie das geht: [[# | ||
+ | * Fügen Sie in den Artikel __nicht__ manuell ein Änderungsdatum (" | ||
+ | * Ordnen Sie jedem Artikel die passenden | ||
- | 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. | ||
+ | \\ | ||
+ | ===== Ältere Versionen ===== | ||
+ | |||
+ | * Über den Reiter " | ||
+ | |||
+ | |||
+ | \\ | ||
===== Wiki-Syntax ===== | ===== Wiki-Syntax ===== | ||
Zeile 23: | Zeile 61: | ||
==== Textformatierung ==== | ==== Textformatierung ==== | ||
+ | \\ | ||
=== Schrift === | === Schrift === | ||
Zeile 29: | Zeile 68: | ||
|%%// | |%%// | ||
|%%__unterstrichen__%%|__unterstrichen__| | |%%__unterstrichen__%%|__unterstrichen__| | ||
- | |%%'' | + | |%%'' |
|%%< | |%%< | ||
|%%< | |%%< | ||
|%%< | |%%< | ||
+ | \\ | ||
===Absätze === | ===Absätze === | ||
Ein Absatz wird erzeugt durch | Ein Absatz wird erzeugt durch | ||
Zeile 41: | Zeile 80: | ||
* %%\\%% plus ein Leerzeichen | * %%\\%% plus ein Leerzeichen | ||
+ | \\ | ||
=== Überschriften ==== | === Überschriften ==== | ||
Überschriften werden mit maximal sechs " | Überschriften werden mit maximal sechs " | ||
Zeile 55: | Zeile 95: | ||
Soll kein Inhaltsverzeichnis erstellt werden, muss der Befehl: ''< | Soll kein Inhaltsverzeichnis erstellt werden, muss der Befehl: ''< | ||
- | + | \\ | |
- | === unformatierte | + | === Unformatierte |
Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen oder verwendet %%< | Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen oder verwendet %%< | ||
- | Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen | + | Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen |
- | oder %%< | + | %%< |
- | < | + | < |
Um jegliche Umwandlung durch DokuWiki abzustellen, | Um jegliche Umwandlung durch DokuWiki abzustellen, | ||
+ | \\ | ||
=== Zitat / Kommentar === | === Zitat / Kommentar === | ||
Zitate oder Kommentar werden mit dem " | Zitate oder Kommentar werden mit dem " | ||
Zeile 87: | Zeile 127: | ||
+ | \\ | ||
==== Links ==== | ==== Links ==== | ||
Zeile 96: | Zeile 136: | ||
^E-Mail-Adressen|%%< | ^E-Mail-Adressen|%%< | ||
^ |oder ebenfalls hinter Begriffen versteckt %%[[andi@splitbrain.org|Mail an Andi]]%%|[[andi@splitbrain.org|Mail an Andi]]| | ^ |oder ebenfalls hinter Begriffen versteckt %%[[andi@splitbrain.org|Mail an Andi]]%%|[[andi@splitbrain.org|Mail an Andi]]| | ||
- | ^Interne Links|%%[[start]]%% Namen für neue Seiten werden automatisch in Kleinbuchstaben umgewandelt. Umlaute sind genauso wie Sonderzeichen nicht erlaubt!|[[start]]| | + | ^Interne Links|%%[[syntax]]%% Namen für neue Seiten werden automatisch in Kleinbuchstaben umgewandelt. Umlaute sind genauso wie Sonderzeichen nicht erlaubt!|[[syntax]]| |
- | ^ |Interne Links können ebenfalls hinter Beschreibungen versteckt werden %%[[start|Startseite]]%%|[[start|Startseite]]| | + | ^ |Interne Links können ebenfalls hinter Beschreibungen versteckt werden %%[[syntax|Hilfe zur Wiki-Syntax]]%%|[[syntax|Hilfe zur Wiki-Syntax]]| |
- | ^ |Links zu [[:start|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten.| | | + | ^ |Links zu [[syntax|existierenden Seiten]] werden anders angezeigt als Links zu [[nicht-existierenden]] Seiten.| | |
^Links zu anderen Wikis|%%[[doku> | ^Links zu anderen Wikis|%%[[doku> | ||
- | ^Bilder als Links|BEs ist möglich, auf interne oder externe Bilddateien zu verlinken. Dazu wird die Syntax zur Anzeige von Links einfach mit der zur Anzeige von Bildern kombiniert: %%[[http:// | ||
+ | \\ | ||
+ | ==== Benannte Anker ==== | ||
+ | |||
+ | Um innerhalb einer Seite an bestimmte Textstelle positionieren zu können, finden benannte Anker Anwendung. | ||
+ | Da die Wiki-Syntax diese nicht direkt unterstützt, | ||
+ | |||
+ | Hier zwei Beispiele: | ||
+ | |||
+ | < | ||
+ | [[# | ||
+ | |||
+ | [[# | ||
+ | |||
+ | bla bla bla bla bla | ||
+ | ... | ||
+ | bla bla bla bla bla | ||
+ | |||
+ | Das ist ein **unsichtbarer Anker**: | ||
+ | < | ||
+ | <a name=" | ||
+ | </ | ||
+ | |||
+ | < | ||
+ | <a name=" | ||
+ | </ | ||
+ | </ | ||
+ | |||
+ | |||
+ | **Überschriften** werden vom Wiki-System automatisch mit Anker versehen. Sie werden z.B. in der Inhaltsangabe am Seitenanfang verwendet. Den Namen des Ankers bildet man einfach nach folgenden Regeln aus der Überschrift: | ||
+ | |||
+ | - Alles wird in Kleinbuchstaben übersetzt | ||
+ | - Die Leerzeichen werden durch ein ' | ||
+ | - Die Umlaute/ | ||
+ | |||
+ | Um z.B. den aktuellen Abschnitt zu adressieren, | ||
+ | |||
+ | < | ||
+ | [[# | ||
+ | </ | ||
+ | |||
+ | |||
+ | Übrigens können solche Ankerpunkte auch von anderen Wiki-Seiten... | ||
+ | |||
+ | < | ||
+ | [[syntax# | ||
+ | </ | ||
+ | |||
+ | ... oder von außerhalb adressiert werden: | ||
+ | |||
+ | < | ||
+ | [[http:// | ||
+ | </ | ||
+ | |||
+ | |||
+ | \\ | ||
==== Bilder und andere Dateien ==== | ==== Bilder und andere Dateien ==== | ||
+ | * Bilder zuerst links im Menü unter Werkzeuge in den passenden Bereich hochladen, dann in den Artikel einfügen. | ||
+ | * Laden Sie nur Bilder und Medien auf das RZ-Wiki hoch, die Sie selbst gemacht haben oder die unter einer Freien Lizenz veröffentlicht wurden (Lizenzbedingungen beachten, z. B. Nennung des/der Autoren. | ||
+ | * Nur Bilder verwenden, die jeweils zum Thema passen. | ||
+ | * Größe Bilder vor dem Hochladen verkleinern. | ||
- | Mit geschweiften Klammern | + | Bilder werden mit geschweiften Klammern |
^Original Größe|%%{{wiki: | ^Original Größe|%%{{wiki: | ||
^Breite vorgeben|%%{{wiki: | ^Breite vorgeben|%%{{wiki: | ||
^Breite und Höhe vorgeben|%%{{wiki: | ^Breite und Höhe vorgeben|%%{{wiki: | ||
- | ^Größe für externe Bilder vorgeben|%%{{http:// | ||
+ | \\ | ||
=== 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 124: | Zeile 222: | ||
{{ wiki: | {{ wiki: | ||
+ | <note tip> | ||
+ | Wenn Bilder links oder rechts angeordnet werden, fließt der Text um das Bild herum.\\ | ||
+ | Will man das verhindern und den nachfolgenden Text unter den Elementen anordnen, kann man folgenden kurzen HTML-Code einfügen: | ||
+ | </ | ||
+ | < | ||
+ | <br clear=" | ||
+ | </ | ||
+ | \\ | ||
=== Tooltipps === | === 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. | ||
Zeile 130: | Zeile 236: | ||
%%{{ wiki: | %%{{ wiki: | ||
+ | \\ | ||
=== Bilderrahmen === | === Bilderrahmen === | ||
Mit einfachen eckigen Klammern wird ein Bilderrahmen erzeugt. Hier wird der Titel nicht als Tooltipp, sondern im Rahmen als Bilduntertitel angezeigt: | Mit einfachen eckigen Klammern wird ein Bilderrahmen erzeugt. Hier wird der Titel nicht als Tooltipp, sondern im Rahmen als Bilduntertitel angezeigt: | ||
Zeile 135: | Zeile 242: | ||
%%[{{ wiki: | %%[{{ wiki: | ||
+ | \\ | ||
=== Dateidownload ==== | === Dateidownload ==== | ||
Zeile 142: | Zeile 249: | ||
%%{{ wiki: | %%{{ wiki: | ||
- | + | \\ | |
- | ===== 3.6 Automatische Verlinkung | + | === Automatische Verlinkung === |
Bilder werden automatisch mit einer Verlinkung zur Ihren [[wp> | Bilder werden automatisch mit einer Verlinkung zur Ihren [[wp> | ||
Zeile 156: | Zeile 263: | ||
%%{{wiki: | %%{{wiki: | ||
+ | \\ | ||
==== Listen ==== | ==== Listen ==== | ||
Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein " | Um einen Listeneintrag zu erzeugen, beginne eine Zeile mit 2 Leerzeichen. Diesen Leerzeichen folgt dann ein " | ||
Zeile 182: | Zeile 290: | ||
- Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | - Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen | ||
+ | \\ | ||
==== Tabellen ==== | ==== Tabellen ==== | ||
Zeile 201: | Zeile 309: | ||
Zellen über mehrere Spalten werden erzeugt, wenn man am Ende einer solchen Spalte soviele " | 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 " |
Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich. | Hervorgehobene Felder in Vertikaler Ausrichtung sind auch möglich. | ||
Zeile 210: | Zeile 318: | ||
^ hervorgehoben 5 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 | | ^ hervorgehoben 5 | Zeile 3 Spalte 2 | Zeile 3 Spalte 3 | | ||
- | Wie wir sehen, entscheidet der Feldtrenner (" | ||
| ^ hervorgehoben 1 ^ hervorgehoben 2 ^ | | ^ hervorgehoben 1 ^ hervorgehoben 2 ^ | ||
Zeile 236: | Zeile 343: | ||
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx | | ||
- | |Hinweis zu dem senkrechten | + | <note tip> |
+ | </ | ||
- | ====== 6 sonstige | + | \\ |
+ | ==== Sonstige | ||
- | ===== 6.1 Fußnoten | + | \\ |
+ | === Fußnoten === | ||
- | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt ((eine | + | Fußnoten ((dies ist eine Fußnote)) werden durch eine doppelte runde Klammer dargestellt: %%((dies ist eine 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)) | + | \\ |
- | + | === horizontale Linie === | |
- | ===== 6.2 horizontale Linie ===== | + | |
Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden: | Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden: | ||
- | ---- | + | |
< | < | ||
- | ===== 6.3 Smileys | + | ---- |
+ | |||
+ | \\ | ||
+ | === Smileys === | ||
Dokuwiki verwandelt oft genutzte [[wp> | Dokuwiki verwandelt oft genutzte [[wp> | ||
- | 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 ^ :-( ^ :-) ^ =) ^ :-/ ^ :-\ ^ :-? ^ :-D ^ :-P ^ :-O ^ :-X ^ :-| ^ ;-) ^ :?: ^ :!: ^ '' | ||
| %% 8-) %% | %% 8-O %% | %% :-( %% | %% :-) %% | %% =) | | %% 8-) %% | %% 8-O %% | %% :-( %% | %% :-) %% | %% =) | ||
- | ===== 6.4 Typografie ===== | + | \\ |
- | + | === Typografie === | |
- | [[DokuWiki]] kann einfache | + | Einfache |
- | Hier eine Liste aller Zeichen, die DokuWiki kennt: | + | |
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | -> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) | ||
Zeile 273: | Zeile 383: | ||
</ | </ | ||
- | Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden | + | \\ |
+ | ====Kontroll Makros ==== | ||
- | ===== 6.5 HTML und PHP einbinden | + | Manche Syntax Befehle beeinflussen, wie Dokuwiki eine Seite bei jedem Aufruf ausgibt. Die folgenden Kontroll Makros sind verfügbar: |
- | + | ||
- | In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden : | + | |
- | + | ||
- | < | + | |
- | This is some <font color=" | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | < | + | |
- | This is some <font color=" | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | Oder hier PHP: | + | |
- | + | ||
- | < | + | |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | </ | + | |
- | + | ||
- | < | + | |
- | < | + | |
- | echo 'A logo generated by PHP:'; | + | |
- | echo '< | + | |
- | </ | + | |
- | </ | + | |
- | + | ||
- | **Achtung**: | + | |
- | + | ||
- | **Achtung**: | + | |
- | + | ||
- | ====== 8 Kontroll Makros ====== | + | |
- | + | ||
- | Manche Syntax Befehle beeinflussen wie Dokuwiki eine Seite bei jedem Aufruf ausgibt. Die folgenden Kontroll Makros sind verfügbar: | + | |
^Macro^ Description^ | ^Macro^ Description^ | ||
|%%~~NOTOC~~%%|Wenn dieses Makro im in eine Seite eingebunden ist, wird das [[: | |%%~~NOTOC~~%%|Wenn dieses Makro im in eine Seite eingebunden ist, wird das [[: | ||
|%%~~NOCACHE~~%%|Dokuwiki Seiten werden standardgemäß in einen Zwischenspeicher gesichert. Manchmal ist das aber nicht gewollt ( z.B. bei <php> Syntax Befehlen). Beim einfügen dieses Makros wird Dokuwiki gezwungen bei jedem Aufruf die Seite neu einzulesen.| | |%%~~NOCACHE~~%%|Dokuwiki Seiten werden standardgemäß in einen Zwischenspeicher gesichert. Manchmal ist das aber nicht gewollt ( z.B. bei <php> Syntax Befehlen). Beim einfügen dieses Makros wird Dokuwiki gezwungen bei jedem Aufruf die Seite neu einzulesen.| | ||
- | ====== 7 Syntax-Plugins ====== | ||
- | DokuWikis Syntax kann durch [[doku> | ||
- | |||
- | ~~INFO: | ||
+ | \\ | ||
====== Backgroundinfos zu dieser Seite====== | ====== Backgroundinfos zu dieser Seite====== | ||
- | Diese Seite ist eine Übersetzung der [[http:// | + | Grundlage für diese Seite war die [[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.\\ | + | Für das RZ-Wiki wurde sie grundlegend überarbeitet von --- //[[wiki: |
- | Ä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 | + | |
- | * Anregungen, Bemerkungen oder Hinweise auf Fehler sind willkommen. | + | |
- | * euer Sebastian Koch => mr_snede *at* web ~dot~ de | + | |
- | + | ||
- | Seite grundlegend überarbeitet von --- //[[dokuwiki.20.baucki@spamgourmet.com|Konrad Bauckmeier]] 2005-12-02 09:05// | + | |
{{tag> | {{tag> |