Wiki-Guide


Hinweis: Alle Mitglieder der Uni Freiburg sind herzlich eingeladen, an diesem Wiki mitzuarbeiten. Beachten Sie hierbei bitte den Wiki-Guide. Die Inhalte werden von den Mitarbeiter/innen des Rechenzentrums der Uni Freiburg regelmäßig geprüft, eine Gewähr für die Richtigkeit kann trotzdem nicht übernommen werden.


Regeln fürs Mitmachen

  1. Bitte regen Sie größere Veränderungsvorschläge / Korrekturen - wie z. B. in der Wikipedia üblich - zunächst auf den jeweiligen Diskussionsseiten, die jedem Artikel zugeordnet sind, an. Kleinere Änderungen oder Rechtschreibprüfungen können natürlich direkt vorgenommen werden.
    • Auf den Diskussionsseiten können zudem fachliche (!) Differenzen und Unklarheiten sachlich diskutiert werden.
    • Jeden Diskussionsbeitrag bitte „unterzeichnen“ (Klick auf den Stift im Editor-Menü).
    • Antworten / Reaktionen auf Beiträge einrücken
  2. Machen Sie die von Ihnen vorgenommenen Änderungen deutlich:
    • Sofern Sie nur kleine Änderungen in einem Artikel vornehmen (sprich: Komma ergänzt, Tippfehler korrigiert), klicken Sie 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.
  3. Artikel bitte sachlich formulieren und sparsam formatieren. Hierzu bitte die Formatierungshinweise beachten


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.

Neue Seiten können Sie alternativ auf folgende Weise anlegen:

Verlinken Sie auf einer bestehenden Seite ein Wort mit doppelten eckigen Klammern [[neuerSeitenname]]. Sie können 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. Folgen Sie nach dem Abspeichern dem Link und klicken Sie auf der sich neu öffnenden Seite auf „Seite anlegen“.


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).
  • Nutzen Sie beim Bearbeiten der Seite den „Vorschau“-Button, um sich den Artikel anzusehen, und verzichten Sie 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.


Formatierungshinweise

Bitte orientieren Sie sich an den bestehenden Seiten.

  • 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, bunt, blinkend und so)
  • Bilder möglichst in einen Rahmen setzen und mit einer Bildbeschriftung versehen (s.u. Bilderahmen, Beispielseite)
    • 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")
  • Fügen Sie in den Artikel nicht manuell ein Änderungsdatum („zuletzt geändert…“) ein. Über "Ältere Versionen" erhalten Sie einen Überblick, wer wann was zuletzt geändert hat.
  • Ordnen Sie jedem Artikel die passenden Schlagwörter zu. 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 „Ältere Versionen“ erhalten Sie 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

SyntaxErgebnis
**fett**fett
//kursiv//kursiv
__unterstrichen__unterstrichen
''dicktengleich''nichtproportional
<sub>tiefgestellt</sub>tiefgestellt
<sup>hochgestellt</sup>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, 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 

<file></file> kann man verwenden, um den Text in einer Box etwas kleiner erscheinen zu lassen (z. B. für Zitate)

"Der Text erscheint in kleinerer Schrift, z.B. für Zitate"

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


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

Externe LinksExterne Links (Verweise auf andere Webseiten oder Dateien) werden automatisch erkannt: http://www.google.com oder einfach www.google.comhttp://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[[syntax]] Namen für neue Seiten werden automatisch in Kleinbuchstaben umgewandelt. Umlaute sind genauso wie Sonderzeichen nicht erlaubt!Wiki-Guide
Interne Links können ebenfalls hinter Beschreibungen versteckt werden [[syntax|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


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, muss man zur html-Konstruktion greifen.

Hier zwei Beispiele:

[[#anker|Verweis zum Anker]]

[[#anker2|Verweis zum Anker2]]

bla bla bla bla bla
...
bla bla bla bla bla

Das ist ein **unsichtbarer Anker**:
<html>
<a name="anker"></a>
</html>

<html>
<a name="anker2">Dieser Anker ist **mit Text** verknüpft</a>
</html>

Ü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:

  1. Alles wird in Kleinbuchstaben übersetzt
  2. Die Leerzeichen werden durch ein '_' (underscore) ersetzt
  3. Die Umlaute/nationalen Sonderzeichen werden umschrieben (ä → ae, ß → ss, á → a usw.)

Um z.B. den aktuellen Abschnitt zu adressieren, gibt man folgendes an:

[[#benannte_anker|Benannte Anker]]

Übrigens können solche Ankerpunkte auch von anderen Wiki-Seiten… Benannte Anker

[[syntax#benannte_anker|Benannte Anker]]

… oder von außerhalb adressiert werden:

[[http://www.wiki.uni-freiburg.de/rz/doku.php?id=wiki:syntax#benannte_anker|Benannte Anker]]


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.

Bilder werden mit geschweiften Klammern in Texte eingebunden werden. 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 }}
Hinweis
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:
<html>
<br clear="all">
</html>


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 |Dies ist ein Titel}}] →

Dies ist ein Titel


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) 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
  1. Dies ist ein Eintrag einer nummerierte Liste
  2. Ein zweiter Eintrag
    1. 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) 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
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'..."


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.


Backgroundinfos zu dieser Seite

Grundlage für diese Seite war die Syntax-Seite aus DokuWiki (2005-07-13).
Für das RZ-Wiki wurde sie grundlegend überarbeitet von — Claudia Gayer 2009/08/31 12:30

1)
ggf. mit einem „&“ mit anderen Optionen wie der Größenangabe kombinieren
2)
dies ist eine Fußnote
QR-Code
QR-Code Wiki-Guide (erstellt für aktuelle Seite)