Dies ist eine alte Version des Dokuments!
Inhaltsverzeichnis
Wiki-Hilfe
Seite erstellen
Um einen neuen Artikel zu erstellen, klicken Sie im Navigationskasten links auf „neue Seite anlegen“, wählen Sie die Kategorie „Allgemein“ (für alle lesbar) oder „intern“ (nur für RZ-Mitglieder einsehbar) und geben Sie in das Textfeld den Namen des neuen Artikels ein.
Seite bearbeiten
Um eine Seite zu bearbeiten, klicken an der oberen Leiste auf „Seite bearbeiten“ und editieren Sie den Text im Textfeld. Bitte beachten Sie beim Erstellen und Editieren von Artikeln die Wiki-Syntax (s. unten).
- Wählen Sie eine aussagekräftige Überschrift.
- Mit Hervorhebungen aller Art (fett, kursiv, bunt etc.) bitte sparsam umgehen.
Schlagwörter / Tags
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.
Wiki-Syntax
Textformatierung
Schrift
Syntax | Ergebnis |
---|---|
**fett** | fett |
//kursiv// | kursiv |
__unterstrichen__ | unterstrichen |
''dicktengleich'' | dicktengleich |
<sub>tiefgestellt</sub> | tiefgestellt |
<sup>hochgestellt</sup> | hochgestellt |
<del>gelöscht</del> |
Absätze
Ein Absatz wird erzeugt durch
- eine leere Zeile oder
- \\ am Ende einer Zeile oder
- \\ plus ein Leerzeichen
Überschriften
Überschriften werden mit maximal sechs „=“ eingerahmt. Es gibt fünf unterschiedliche Ebenen.
====== Überschrift Ebene 1 ====== ===== Überschrift Ebene 2 ===== ==== Überschrift Ebene 3 ==== === Überschrift Ebene 4 === == Überschrift Ebene 5 ==
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: ~~NOTOC~~
mit in die Seite aufgenommen werden.
unformatierte Abschnitte
Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen oder verwendet <code></code>:
Um Text unformatiert in einer Box erscheinen zu lassen, beginnt man jede Zeile mit zwei Leerzeichen
oder <file></file>
mit file sieht es etwas anders aus ..
Um jegliche Umwandlung durch DokuWiki abzustellen, umschließe den entsprechenden Bereich mit <nowiki></nowiki> oder mit doppelten Prozentzeichen %%
.
1.5 Syntax-Hervorhebung
DokuWiki kennt Syntax highlighting für Quellcode, um dessen Lesbarkeit zu erhöhen. Dafür wird GeSHi „Generic Syntax Highlighter“ benutzt. Somit wird jede Programmiersprache unterstützt, die GeSHi kennt.
Es wird der gleiche Bezeichner wie im vorherigen Abschnitt benutzt, nur dass er nun auch den Namen der Sprache enthält:
<code java> Quelltext </code>
Zitat / Kommentar
Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das „größer als“ - Zeichen folgendermaßen verwendet:
Ich denke wir sollten es tun. > Nein, sollten wir nicht. >> Doch! > Wirklich? >> Ja! >>> Dann lass es uns tun! >>> Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das "größer als" - Zeichen folgendermaßen verwendet
Ich denke wir sollten es tun
Nein, sollten wir nicht.
Doch!
Wirklich?
Ja!
Dann lass es uns tun
Kommentare oder Zitate können auch über mehrere Zeilen gehen, wie dieser völlig unsinnige Text zeigt. Um einen Text als Zitat oder Kommentar zu kennzeichen, wird das „größer als“ - Zeichen folgendermaßen verwendet
2 Links
Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden:
2.1 Extern
Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com
Verweise können auch hinter eigenen Begriffen versteckt werden: hier ist google
E-mail Adressen werden in spitze Klammern gesetzt: andi@splitbrain.org
Externe Links werden automatisch erkannt: http://www.google.com oder einfach www.google.com\\ Verweise können auch hinter eigenen Begriffen versteckt werden: [[http://www.google.com|hier ist google]] \\ E-mail Adressen werden in spitze Klammern gesetzt: <andi@splitbrain.org>
2.2 Intern
Interne Links, also Verweise auf Seiten innerhalb von DokuWiki, werden in doppelten eckigen Klammern gesetzt(„altgr+8“ bzw. altgr+9 auf einer win-tastatur bzw Wahltaste+5 und Wahltaste+6 bei Apple) auf:
pagename
Ein Link kann auch hinter einem Begriff oder einer Beschreibung versteckt werden:
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: namespaces
Durch einen Doppelpunkt werden Namensbereiche im Wiki aufgelöst:[[de:namespaces]]
Weitere Informationen zu Namensbereichen: de:namespaces.
Anmerkungen:
- Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
2.3 Interwiki
DokuWiki unterstützt auch Links in andere Wikis, sogenannte de:interwiki Links.
Ein Link zur Wikipedia Seite über Wikis:Wiki
DokuWiki unterstützt auch Links in andere Wikis, sogenannte [[doku>de:interwiki]] Links. \\ Ein Link zur Wikipedia Seite über Wikis:[[wp>Wiki]]
2.4 Windows-Freigaben
DokuWiki kennt auch Links auf Windows-Freigaben: freigegebener-Ordner.
Dies ist allerdings nur in einer homogenen Benutzergruppe sinnvoll (siehe Intranet).
DokuWiki kennt auch Links auf Windows-Freigaben: [[\\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 „lokalen Zone“)!
- Für Mozilla und Firefox kann es durch die Option security.checkloaduri eingeschaltet werden, was aber nicht empfohlen wird!
- Opera ingnoriert als Sicherheitsfeature seit Version 7.54 alle Links auf file: in Webseiten.
- Für weitere Informationen siehe: 151
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://www.php.net|{{wiki:dokuwiki-128.png}}]]
Bitte beachte: Bildformatierungen sind die einzigen Formatierungen, die in Linknamen benutzt werden können!
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 beschränken. Zum Hochladen ist mindestens die Berechtigung „Hochladen“ (engl. „Upload“), zum Löschen „Entfernen“ (engl. „Delete“) für den entsprechenden Namensraum erforderlich.
3.2 Größe von Bildern
Mit geschweiften Klammern können sowohl externe als auch interne Bilder eingebunden werden. Optional kann deren Größe angegeben werden:
Größe für externe Bilder vorgeben:
Original Größe: {{wiki:dokuwiki-128.png}} Eine Breite vorgeben: {{wiki:dokuwiki-128.png?50}} Breite und Höhe vorgeben: {{wiki:dokuwiki-128.png?200x50}} Größe für externe Bilder vorgeben: {{http://de3.php.net/images/php.gif?200x50}}
3.3 Ausrichten von Bildern
Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, mitte, rechts).
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
bei Ausrichtung und der Verwendung eines Titels sollte man drauf achten dass der Titel nach dem Leerzeichen kommt
{{ wiki:dokuwiki-128.png|Rechtsbündig}} {{wiki:dokuwiki-128.png |Linksbündig}} {{ wiki:dokuwiki-128.png |Zentriert}}
3.4 Tooltips
Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.
{{ wiki:dokuwiki-128.png |Dies ist ein Titel}}
3.5 Dateidownload
Wenn eine Datei angegeben wird, die kein Bild (gif,jpeg,png
) ist, so wird sie als Link angezeigt und so zum Download angeboten.
3.6 Automatische Verlinkung
Bilder werden automatisch mit einer Verlinkung zur Ihren Metadaten erstellt - Bsp.:
Dieses Verhalten kann über die Option ?nolink1) unterbunden werden2):
{{wiki:dokuwiki-128.png?15&nolink}}
Ausserdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:
{{wiki:dokuwiki-128.png?15&direct}}
4 Listen
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 „-“ für nummerierte Listen.
- Dies ist ein Eintrag einer unsortierten Liste
- 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 * 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
5 Tabellen
Mit DokuWiki können Tabellen ganz einfach erstellt werden:
hervorgehoben | zum Beispiel für | eine Titelzeile |
---|---|---|
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 |
Felder einer Tabelle starten mit „|“ für ein normales Feld oder mit einem „^“ für hervorgehobenes Feld.
^ hervorgehoben ^ zum Beispiel für ^ Titelzeile ^ | 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, wie oben gezeigt, am Ende einer solchen Spalte soviele „|“ oder „^“ ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden.
Kurz gesagt: Alle Zeilen einer Tabelle müssen die gleiche Anzahl an Feldtrennern „|“ oder „^“ haben.
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 („|“ oder „^“) vor einer Zelle über ihr Aussehen:
| ^ 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 |
Anmerkung: Felder über mehrere Zeilen werden nicht unterstützt.
- Der Inhalt einer Zelle kann horizontal ausgerichtet werden. Füge 2 Leerzeichen hinzu:
- 2 Leerzeichen Links vom Text: rechtsbündig
- 2 Leerzeichen Rechts vom Text: linksbündig
- 2 Leerzeichen Links und Rechts vom Text: zentriert
Tabelle mit Ausrichtung | ||
---|---|---|
Rechts | Mitte | Links |
Links | Rechts | Mitte |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
So sieht die Formatierung aus:
^ Tabelle mit Ausrichtung ^^^ | Rechts| Mitte |Links | |Links | Rechts| Mitte | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Hinweis zu dem senkrechten Balken-Zeichen: dieses Zeichen ist auf einer PC-Tastatur erreichbar über die Taste „<“ bei zusätzlich gedrückter „AltGr“-Taste. Ist dort auch aufgedruckt. Apple-Nutzer erreichen das Zeichen mit der Wahltaste („Alt“) und der „7“. |
6 sonstige Formatierungen
6.1 Fußnoten
Fußnoten 3) werden durch eine doppelte runde Klammer dargestellt 4). 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))
6.2 horizontale Linie
Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:
----
6.3 Smileys
Dokuwiki verwandelt oft genutzte emoticons zu kleinen Smily-Grafiken.
Weitere Smiley-Grafiken können im Ordner „smily“ abgelegt und dann in der Datei conf/smileys.conf
eingetragen werden.
Hier ist nun eine Übersicht der standardmäßig in DokuWiki enthaltenen Smileys:
| |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
8-) | 8-O | :-( | :-) | =) | :-/ | :-\ | :-? | :-D | :-P | :-O | :-X | :-| | ;-) | :?: | :!: | ^_^ | LOL | FIXME | DELETEME |
6.4 Typografie
DokuWiki kann einfache Textzeichen in ihre typografischen Entsprechungen umwandeln.
Hier eine Liste aller Zeichen, die DokuWiki kennt:
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
Bitte beachtet: Diese Umwandlungen können in der Konfigurationsdatei abgestellt werden
6.5 HTML und PHP einbinden
In einer Seite kann sowohl HTML als auch PHP direkt benutzt werden :
This is some HTML-Code
<html> This is some <font color="red" size="+1">HTML-Code</font> </html>
Oder hier PHP:
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
<php> echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; </php>
Achtung: Das Einbinden von HTML und PHP in einer Seite kann in der Konfigurationsdatei ausgeschaltet werden5). Ist dieses geschehen, wird der Quellcode dieser Abschnitte als Text angezeigt und nicht ausgeführt.
Achtung: Das Einbinden von HTML und PHP auf einer Seite im Internet ist gewöhnlich ein schweres Sicherheitsrisiko! Diese Funktion ist nur für das Intranet gedacht!
8 Kontroll Makros
Manche Syntax Befehle beeinflussen wie Dokuwiki eine Seite bei jedem Aufruf ausgibt. Die folgenden Kontroll Makros sind verfügbar:
Macro | Description |
---|---|
~~NOTOC~~ | Wenn dieses Makro im in eine Seite eingebunden ist, wird das Table of Content nicht erstellt. |
~~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 Plugins erweitert werden. Wie die einzelnen Plugins benutzt werden, steht auf deren Beschreibungsseiten. Die folgenden Plugins sind auf dieser DokuWiki Installation verfügbar:
- Add New Page 2015-11-02 von Benjamin Santalucia, Sam Wilson, Michael Braun, Gerrit Uitslag, Albert Chern
Adds a "new page form" to any wiki page. - alphaindex plugin 2008-10-18 von Hubert Moli�re
Allows you to insert the alphabetical index of a namespace in a page - Blockquote Plugin 2017-08-25 von Anika Henke (previous author: Gina Haeussge)
Write quotations in a semantically correct way - Box Plugin 2016-02-17 von Christopher Smith
Boxes with titles, colour and rounded corners. Syntax: <box width class colours|title> ... </box|caption> width, class, colours title & caption are optional. The title can include some wiki markup, the box contents can include almost any wiki markup. - Cloud Plugin 2020-09-27 von Michael Hamann, Michael Klier, Gina Haeussge
Displays the most used words in a word cloud. - comment 2016-04-26 von Gina Häußge, Michael Klier
Add comments/notes to your wiki source that won't be shown on the page. - discussion plugin 2020-09-24 von Michael Hamann, Gerrit Uitslag, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner, Matthias Schulte
Provides discussion funtionality for wiki pages - Gallery Plugin 2019-01-05 von Andreas Gohr
Creates a gallery of images from a namespace or RSS/ATOM feed - ifauthex plugin 2020-04-13 von Pietro Saccardi
Toggle DokuWiki page content based on users and groups with arbitrary boolean expressions. - Plugin imagebox 2019-10-13 von Lukas Rademacher, CvH, Dr-Yukon, FFTiger & myst6re
Syntax for display an image with a caption, like Wikipedia.org - include plugin 2021-03-06 von Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page - Note Plugin 2020-06-28 von Olivier Cortès, Eric Hameleers, Christopher Smith, Aurélien Bompard, LarsDW223
Add Note/Important/Tip/Warning Capability (DIV+CSS box) - nsindex plugin 2017-07-28 von Oliver Geisen
Creates an dynamic list of namespace pages/subns to be used inside a page - nspages plugin 2021-03-19 von Guillaume Turri
Presents a toc of the selected namespace using <nspages> - Numbered Headings 2020-06-14 von Satoshi Sahara
Prepend tiered numbers as indexes for hierarchical headings - Open Document Plugin 2019-07-27 von Andreas Gohr, Aurelien Bompard, Florian Lamml, LarsDW223
Export the current Wiki page to a OpenOffice ODT file - Pagelist Plugin 2020-09-27 von Matthias Schulte, Michael Hamann, Michael Klier, Gina Haeussge
Lists pages in a nice formatted way - Tag Plugin 2020-09-26 von Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
tag wiki pages - ToDo 2020-06-17 von Leo Eibler, Christian Marg, Markus Gschwendt
Create a checkbox based todo list with optional user assignment (by using <todo>This is a ToDo</todo>). In combination with dokuwiki searchpattern plugin it is a lightweight task list management system. - Video Sharing Site Plugin 2020-03-18 von Andreas Gohr
Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}} - Wrap Plugin 2018-04-22 von Anika Henke
Universal plugin which combines functionalities 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.
Backgroundinfos zu dieser Seite
Diese Seite ist eine Übersetzung der Syntax-Seite aus DokuWiki (2005-07-13).
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, für manche gibt es keine direkte Übersetzungen. Oder sie sind schon so bekannt, dass eine Übersetzung unsinnig ist.
Der Übersetzer ist sich selbst nicht sicher, ob er lieber den Begriff „Link“ oder „Verweis“ benutzen soll.
An einigen Stellen befindet sich ein - 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 — Konrad Bauckmeier 2005-12-02 09:05