Inhaltsverzeichnis
Schnelleinstieg
Informationen suchen
Mit der Suchfunktion oben rechts können Seiten im Wiki durchsucht werden.
Seiten editieren
Mit einem Klick auf das Stiftsymbol oben in der rechten Navigationsleiste kann der Inhalt jeder Seite geändert werden. Der Editor erlaubt mit der oberen Menüleiste eine einfache Formatierung von Text. In der Editoransicht wird der Text lediglich mit unterschiedlichen Steuerzeichen angezeigt und erst in der Vorschau oder nach dem speichern wie gewünscht formatiert. Alle Änderungen werden in einer Historie („Uhr-Icon“ in der rechten Navigationsleiste) abgespeichert, so dass ältere Versionen immer wieder hergestellt werden können. Klicken Sie auf die Editoransicht um die Struktur dieser Seite zu sehen. Durch die Schaltfläche Abbrechen
unterhalb des Editorfensters verlassen Sie die Editoransicht.
Ausführliche Informationen zur Dokuwiki Syntax finden sich unter dem folgenden Link: https://www.dokuwiki.org/de:wiki:syntax.
Vorbermerkungen
Bei der Textformatierung handelt es sich eigentlich um eine logische Strukturierung von Inhalten (Texte, Bilder, Tabellen, Verlinkungen); die eigentliche Formatierung übernimmt das Wiki. Durch diese logische Strukturierung von Inhalten können Wissensammlungen erstellt werden, die von Menschen aber auch Maschinen gut verarbeitet werden können. Es sollten daher nur die vorgegebenen Formatierungen des DokuWiki verwendet werden und auf „Hacks“ zur schöneren Gestaltung verzichtet werden.
Textauszeichnung
Fett
Ein mit zwei Sternchen (*) eingefasste Wort wird fett dargestellt.
Ein mit zwei Sternchen (*) eingefasste Wort wird **fett** dargestellt.
Kursiv
Ein mit zwei Schrägstrichen (/) eingefasste Wort wird kursiv dargestellt.
Ein mit zwei Schrägstrichen (/) eingefasste Wort wird //kursiv// dargestellt.
Unterstreichen
Ein mit zwei Unterstrichen (_) eingefasste Wort wird unterstrichen dargestellt.
Ein mit zwei Unterstrichen (_) eingefasste Wort wird __unterstrichen__ dargestellt.
Hochgestellter Text / Tiefgestellter Text
Text kann hochgestellt und tiefgestellt werden.
Text kann <sup>hochgestellt</sup> und <sub>tiefgestellt</sub> werden.
Keine Formatierung
Wenn ein Textabschnitt nicht formatiert werden soll und alle Zeichen genau so dargestellt werden sollen wie sein eigegeben wurden so kann der Text entweder in die Tags '' und ''
, oder mit doppelten Prozentzeichen %% eingefasst werden. Steuerzeichen werden innehalb dieser Auszeichnungen nicht interpretiert.
Textstrukturierung
Überschriften
Es gibt 5 Ebenen von Überschriften, die mit einer entsprechenden Anzahl von Gleichheitszeichen eingefasst werden:
Überschrift Ebene 5
Überschrift Ebene 4
Überschrift Ebene 3
Überschrift Ebene 2
Überschrift Ebene 1
====== Überschrift Ebene 5 ====== ===== Überschrift Ebene 4 ===== ==== Überschrift Ebene 3 ==== === Überschrift Ebene 2 === == Überschrift Ebene 1 ==
Listen
Geordnete Liste werden mit einem eingerücktem Minuszeichen (-) erstellt:
- Punkt 1
- Punkt 2
- Punkt 3
- Punkt 1 - Punkt 2 - Punkt 3
Ungeordnete Listen werden mit einem eingerücktem Stern (*) erstellt:
- erster Punkt
- zweiter Punkt
- dritter Punkt
* erster Punkt * zweiter Punkt * dritter Punkt
Horizontale Linien
Horizontale Listen werden durch 4 Minuszeichen (—-) oder durch eine Klick auf die entsporechende Schaltfläche in der Menüleiste erstellt.
Code-Darstellung
Die Code-Darstellung ist dazu gedacht Programmcode darzustellen, sie kann aber auch dazu genutzt werden, um Textbausteine hervorzuheben. Innerhalb der Code-Darstellung werden Steuerzeichen nicht interpretiert. Programmcode kann auch für unterschiedliche Programmiersprachen formatiert werden (Details siehe DokuWiki Dokumentation).
Es gibt verschiedene Möglichkeiten die Code-Darstellung zu formatieren:
Doppelte Apostrophe
Doppelte Apostrophe dienen dazu einen Codeblock
in einem Textabsatz einzufügen.
Text einrücken
Wenn ein Text mit zwei Leerzeichen eingerückt wird, wird dieser eingerückte Absatz in einen Code-Block dargestellt.
<code> Tag
Wenn ein Text innerhalb der <code>-Tags eingefasst wird, wird dieser Absatz in einen Code-Block dargestellt.
Links & Fußnoten
Links werden mit jeweils zwei eckigen Klammern ([ / ]) eingefasst
interner Link
[[start:allgemeines:schnellanleitung|Schnelleinstieg]]
externer Link
[[http://example.com|Externer Link]]
Fußnoten
Mit zwei Klammmern werden im Fließtext Fußnoten1) erstellt.
Mit zwei Klammmern werden im Fließtext Fußnoten((das ist eine Fußnote)) erstellt.
Tabellen
Für die Verwendung von Tabellen empfiehlt es sich den Tabelleneditor zu verwenden, der sich bei Auswahl der entsprechenden Schaltfläche in der oberen Menüleiste öffnet. In diesem Editor können Zeilen und Spalten durch Rechtsklick auf die Tabelle einfach modifiziert werden.
Der folgende Tabelle
Spalte 1 | Spalte 2 | Spalte 3 | |
---|---|---|---|
Zeile 1 | Inhalt 1/1 | Inhalt 1/2 | Inhalt 1/3 |
Zeile 2 | Inhalt 2/1 | Inhalt 2/2 | Inhalt 2/3 |
Zeile 3 | Inhalt 3/1 | Inhalt 3/2 | Inhalt 3/3 |
entsteht aus diesen Code
^ ^ Spalte 1 ^ Spalte 2 ^ Spalte 3 ^ ^ Zeile 1 | Inhalt 1/1 | Inhalt 1/2 | Inhalt 1/3 | ^ Zeile 2 | Inhalt 2/1 | Inhalt 2/2 | Inhalt 2/3 | ^ Zeile 3 | Inhalt 3/1 | Inhalt 3/2 | Inhalt 3/3 |
Bilder
Bilder müssen vor der Verwendung hochgeladen werden. Dies kann direkt durch Auswahl des Icons für das Bild-Einfügen geschehen, oder im „Medien Manager“ (Link unterhalb der Suchleiste oben rechts). Hierbei bietet es sich an die Bilder im gleichen Namespace abzuspeichern. Die Größe, Ausrichtung oder auch die Verlikung des Bildes kann entsprechend ausgewählt werden und der ensprechnde Code wird im Editor eingefügt.
Videos
Videos können von externen Plattformen eingebunden werden. So wird das Video mit der URL https://www.youtube.com/watch?v=wUIjTt6EeYY mit dem folgenden Befehl eingebunden (einfacher über einen Klick auf die entsprechende Schaltfläche in der oberen Menüleiste).
{{youtube>wUIjTt6EeYY?}}
Annotationen
Durchgestrichener Text
Vorläufige Textänderungen können als durchgestrichener Text formatiert werden.
Vorläufige Textänderungen können als <del>durchgestrichener Text</del> formatiert werden.
Todo
Es können auch noch zu erledigende Aufgaben (To-do-Liste) für andere Moderatoren mit Hilfe von Checkboxen dargestellt werden.
Markierten Text als Aufgabe
<todo>Markierten Text als Aufgabe</todo>
Emoticons
Auf die Verwendung von Emoticons sollte verzichtet werden. Die Hinweise oder können für die Revision von Artikeln verwendet werden.
Wrap-Plugin
Das Wrap-Plugin (Box-Icon in der oberen Menüleiste) bietet eine Vielzahl von weiteren Formatierungsmöglichkeiten an. So kann Text zusätzlich hervorgehoben (wichtig), in Spalten gesetzt (Spalten) oder diverse Textfelder/Textboxen (einfache zentrierte Box, Info-Box, Tip-Box, Wichtig-Box, warn-Box, Hilfe-Box, Download-Box, etc.) eingefügt werden.
Diese können auch bei der gemeinsamen Erstellung von Seiten genutzt werden, um auf notwendige Änderungen oder noch fehlende Informationen hinzuweisen (u.a. Zu-Erledigen-Box, markieren, weniger-wichtig).
einfache zentrierte Box
Info-Box
Tip-Box
Wichtig-Box
Warn-Box
Hilfe-Box
Download-Box
Zu-Erledigen-Box
Sonderzeichen
Sonderzeichen können durch die Schaltfläche Sonderzeichen
einfach eingefügt werden. Sonderzeichen sollten nur eingesetzt werden wenn deren Einsatz unerlässlich ist.
Seite speichern
Die Änderungen an einer Seite können erst in der Vorschu betrachtet werden. Hierzu kann die Schaltfläche Vorschau
unterhalt des Editorfensters genutzt werden.
Die Änderungen an einer Seite werden nach Auswahl der Schaltfläche Speichern
übernommen und die Editoransicht wird automatisch verlassen. Alle Änderungen werden in einer Historie („Uhr-Icon“ in der rechten Navigationsleiste) abgespeichert, so dass ältere Versionen immer wieder aufgerufen und wieder hergestellt werden können.
WICHTIG: Bevor die Seite abgespeichert wird, hinter Zusammenfassung
kurz angeben welche Änderungen an der datei vorgenommen wurden, um die Dateihistorie besser nachvollziehen zu können. Bei kleineren Änderungen (z. B. Verbesserung von Rechtschreibfehlern, Grammatik, Formatierung, etc.) die Checkbox kleine Änderung
wählen.
Neue Seiten anlegen
Rot hervorgehobene Links kennzeichnen Seiten die bereits angelegt wurden, jedoch noch keinen Inhalt haben. Dies ist der perfekte Einstiegspunkt für die ersten eigenen Seiten. Es können allerdings auch neue Seiten angelegt werden indem auf einer bestehennden Siete ein interner Link gesetzt wird. Diese Links sollten nur innerhalb der bestehenden Namenräume (Namespaces) erstellt werden. Wenn zusätzliche Namenräume (Namespaces) benötigt werden bitte eine Nachricht an wiki-nachhaltigkeit@uni-koeln.de senden.
Die Autor:innen sollten die Option Unterschrift
im Texteditor nutzen (obere Menüleiste) um sich als Autor:in dieser neuen Inhalte zu kennzeichnen.
Seite löschen
Wir den komplette Inhalt einer Seite entfernt, wird auch die dazugehörige Seite gelöscht. Alle auf diese Seite verweisenden Links werden dann wieder rot dargestellt.