Wiki-Guide

short cut: Hinweise zur Textformatierung

Videoaufzeichnung von Marco Glaubitz (Rechenzentrum) zur Arbeit mit Wikis an der Universität Freiburg

Reglen für die Arbeit im Wiki

Seite erstellen

Falls es zum gewünschten Thema noch keinen Artikel gibt (dies bitte zunächst über die „Suche“ überprüfen), könnt ihr eine neue Seite anlegen. Es gibt mehrere Möglichkeiten:

Gebt den gewünschten Seitennamen in das Suchfeld ein. Sofern es keine Seite zu dem Thema gibt, klickt auf den Reiter „Seite anlegen“

Verlinkt auf einer bestehenden Seite ein Wort mit doppelten eckigen Klammern [[neuerSeitenname]]. Ihr könnt den Link mit einem horizontalen Strich (str+Alt+<>Taste) hinter einer Beschreibung „verstecken“: [[neuerSeitenname|das ist der neue Seitenname]] → das ist der neue Seitenname. Sofern noch keine Seite mit diesem Namen besteht, erscheint der Link rot im Text. Folgt nach dem Abspeichern dem Link und klickt auf der sich neu öffnenden Seite auf „Seite anlegen“.

Seite bearbeiten

Um eine Seite zu bearbeiten, klickt auf den Reiter „Seite bearbeiten“ und editiert den Text im Textfeld. Bitte beachtet beim Erstellen und Editieren von Artikeln die Wiki-Syntax (s. unten).

Nutzt beim Bearbeiten der Seite den „Vorschau“-Button, um sich den Artikel anzusehen, und verzichtet möglichst auf häufiges Zwischenspeichern. Denn bei jedem Speichern wird eine neue Version des Artikels angelegt, was die Auflistung der „Älteren Versionen“ sehr unübersichtlich macht.

Gestaltung / Layout der Seiten

Wählt 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, bunt, blinkend und so)

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: "Links")

Änderungen an bestehenden Artikeln

sofern ihr nur kleine Änderungen in einem Artikel vornehmt (sprich: ein Komma ergänzt, Tippfehler rausgenommen), klickt bitte „Kleine Änderung“ unter dem Artikel an.

Bei allen anderen Änderungen bitte unter dem Artikel unter „Zusammenfassung“ kurz die Änderung vermerken, z. B. Struktur geändert, Teile hinzugefügt, Teile gelöscht. Die Kommentare erscheinen dann unter "Ältere Versionen" mit Datum und Autor.

Macht gravierende Änderungen bitte auf den jeweiligen Diskussionseiten deutlich, z. B. „habe Teil xy gelöscht, weil …“ und unterschreibt den Beitrag mit eurer Signatur (Klick auf den Stift im Editor-Menü).

Diskussionsseiten

jedem Artikel ist eine Diskussionsseite zugeordnet. Auf dieser können Änderungen, Änderungswünsche, fachliche (!) Differenzen, Unklarheiten diskutiert werden.

Jeden Diskussionsbeitrag bitte „unterzeichnen“ (Klick auf den Stift im Editor-Menü).

Antworten / Reaktionen auf Beiträge einrücken

Ältere Versionen

Über den Reiter „Ältere Versionen“ erhaltet einen Überblick, wer was wann zuletzt an dem Artikel geändert hat. Hier erscheinen die unter „Zusammenfassung“ eingegebenen Kommentare. Es lässt sich hierüber jede Änderung nachverfolgen und jede Version des Wiki-Artikels wiederherstellen

Wiki-Syntax

Textformatierung

Schrift

Syntax	Ergebnis
**fett**	fett
//kursiv//	kursiv
__unterstrichen__	unterstrichen
''dicktengleich''	dicktengleich
<sub>tief</sub>gestellt	tiefgestellt
<sup>hoch</sup>gestellt	hochgestellt
<del>gelöscht</del>	deleted

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, nehmen Sie den Befehl: ~~NOTOC~~ in die Seite auf.

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 %%.

Zitat / Kommentar

Zitate oder Kommentar werden mit dem „größer als“ - Zeichen gekennzeichnet

> Zitat 1

>> Antwort auf Zitat 1

>>> Antwort auf Antwort

ergibt:

Zitat 1
Antwort auf Zitat 1
Antwort auf Antwort

Links

Mit DokuWiki können 5 unterschiedliche Arten von Links benutzt werden:

Externe Links	Externe Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.com	http://www.google.com bzw. www.google.com
Links können auch hinter Begriffen versteckt werden: [[http://www.google.com|hier ist google]]	hier ist google
E-Mail-Adressen	<andi@splitbrain.org>	andi@splitbrain.org
oder ebenfalls hinter Begriffen versteckt [[andi@splitbrain.org|Mail an Andi]]	Mail an Andi
Interne Links	[[wikiguide]] Namen für neue Seiten werden automatisch in Kleinbuchstaben umgewandelt.	wikiguide
Interne Links können ebenfalls hinter Beschreibungen versteckt werden [[wikiguide|Hilfe zur Wiki-Syntax]]	Hilfe zur Wiki-Syntax
Links zu existierenden Seiten werden anders angezeigt als Links zu nicht-existierenden Seiten.
Links zu anderen Wikis	[[doku>de:interwiki]] oder [[wp>Wiki]]	de:interwiki oder Wiki

Bilder und andere Dateien

Große Bilder vor dem Hochladen verkleinern.

Bilder werden über das Bilderrahmensymbol in der Werkzeugleiste mit geschweiften Klammern in Texte eingebunden. Optional kann deren Größe angegeben werden:

Original Größe	{{wiki:dokuwiki-128.png}}
Breite vorgeben	{{wiki:dokuwiki-128.png?50}}
Breite und Höhe vorgeben	{{wiki:dokuwiki-128.png?200x50}}

Ausrichten von Bildern

Mit Leerzeichen zur Rechten und/oder Linken innerhalb der Klammern kann ein Bild horizontal ausgerichtet werden(links, mitte, rechts).

Rechts

Links

Zentriert

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Tooltipps

Auch Titel, in den meisten Browsern als Tooltip angezeigt, können angegeben werden.

{{wiki:dokuwiki-128.png|Dies ist ein Titel}} → Dies ist ein Titel

Bilderrahmen

Mit einfachen eckigen Klammern wird ein Bilderrahmen erzeugt. Hier wird der Titel nicht als Tooltipp, sondern im Rahmen als Bilduntertitel angezeigt: [{{ wiki:dokuwiki-128.png|Bildtitel}}]

Dateidownload

Alle Dateien außer Bilder (gif,jpeg,png) werden als Link angezeigt und so zum Download angeboten.

{{ wiki:dokuwiki-128.txt |Beispiel}} → Beispiel

Automatische Verlinkung

Bilder werden automatisch mit einer Verlinkung zur ihren Metadaten erstellt {{wiki:dokuwiki-128.png?50}} →

Dieses Verhalten kann über die Option ?nolink1) ggf. mit einem „&“ mit anderen Optionen wie der Größenangabe kombinieren unterbunden werden.

{{wiki:dokuwiki-128.png?50&nolink}} →

Außerdem kann mit ?direct das Bild, z.Bsp. als Vollansicht, direkt verlinkt werden:

{{wiki:dokuwiki-128.png?50&direct}} →

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

Dies ist ein Eintrag einer unsortierten Liste

Ein zweiter Eintrag

Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen

- Dies ist ein Eintrag einer nummerierte Liste
- Ein zweiter Eintrag
- Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen

Dies ist ein Eintrag einer nummerierte Liste

Ein zweiter Eintrag

Unterschiedliche Ebenen einer Liste durch Hinzufügen von weiteren 2 Leerzeichen

Tabellen

Tabellenfelder werden mit senkrechten Stricken erzeugt. 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 |

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

Zellen über mehrere Spalten werden erzeugt, wenn man am Ende einer solchen Spalte soviele „|“ oder „^“ ohne Leerzeichen dazwischen hintereinander setzt, wie Spalten überbrückt werden.
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

| ^ 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 |

Den senkrechten Strich erhält man folgendermaßen: AltGr (oder Strg + Alt) + „<“-Taste. Apple-Nutzer erreichen das Zeichen mit der Wahltaste („Alt“) und der „7“.

sonstige Formatierungen

Fußnoten

Fußnoten 2) 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.

horizontale Linie

Mit 4 aufeinander folgenden Minuszeichen (alleine in einer Zeile) kann eine horizontale Linie erzeugt werden:

----

Smileys

Dokuwiki verwandelt oft genutzte emoticons zu kleinen Smily-Grafiken.

8-)	8-O	:-(	:-)	=)	:-/	:-\	:-?	:-D	:-P	:-O	:-X	:-|	;-)	:?:	:!:	^_^	LOL	FIXME	DELETEME

Typografie

Einfache Textzeichen werdem in ihre typografischen Entsprechungen umgewandelt.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „He thought 'It's a man's world'…“

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

Backgroundinfos zu dieser Seite

Grundlage für diese Seite war die Syntax-Seite aus DokuWiki (2005-07-13).
Für das Workshop-Wiki wurde sie grundlegend überarbeitet von — Claudia Gayer 2010/10/25 14:59