Da es bisher nur eine englische Anleitung zum Wiki vorhanden ist, wird hier nun eine deutsche Zusammenfassung angeboten.

Allgemeines zum Wiki-Prinzip

Damit Informationen im Internet (genauer WWW) dargestellt werden können, müssen diese entsprechend formatiert sein. Dazu wird unter anderem die "Sprache" HTML verwendet, die jedoch für viele Leute zu umständlich ist.

Damit es aber "einfacher" wird, damit jeder sein Wissen beitragen kann, wurde eine Syntax erfunden, die "wiki wiki" (=hawaiianisch für schnell) eingegeben werden kann und damit viel einfacher sein soll als HTML. Die meisten kennen es wohl zumindest vom Hörensagen von der Wikipedia her. Dort wird allerdings eine andere Software eingesetzt, namens "Mediawiki".

Auf unserem Wiki wird hingegen die Software ikiwiki verwendet. Die Unterschiede zu Mediawiki sind allerdings nicht sehr gross.

Grundsätzlich kann eine Seite auch mit Inhalt gefüllt werden, ohne dass eine Formatierung eingehalten wird. Die eigentliche Formatierung kann dann später jederzeit ergänzt werden.

(!) Das Grundprinzip sollte sein: Keine Sorge wegen der Formatierung! Hauptsache die Informationen sind erst einmal online. Später kann dann immer noch die Formatierung verbessert werden.

Schrift-Hervorhebung

Formatierter Text Wiki-Syntax Hinweise
Es gibt Kursivdruck oder Es gibt *Kursivdruck* oder Einfach den Text von je einem
Fett-Kursivdruck. **Fett-Kursivdruck**. oder je zwei Sternen umgeben.

Auflistungen

Mit einem Stern am Anfang der Zeile, gefolgt von einem Leerzeichen kann eine solche Auflistung (mit Bullet) erzeugt werden. Eine zweite Ebene wird durch Einrücken (2 Leerzeigen) der entsprechenden Zeile erreicht. Aber Vorsicht: Wenn der Text vorne UND hinten mit Stern umrandet wird, dann wird er hervorgehoben.

  • Erste Zeile| |* Erste Zeile| |
    • Zweite Zeile| |    * Zweite Zeile| |hervorgehoben.

Wird erzeugt durch diese Syntax:

* Erste Zeile
  * Zweite Zeile

Aufzählungen (nummerierte Listen)

Für eine nummerierte Aufzählung wird am Beginn der Zeile eine beliebige Zahl gefolgt von einem Punkt aufgeführt. (aus 1. wird automatisch 2., 3., 4., ...ausser innerhalb von Tabellen)

  1. Erste Zeile
  2. Zweite Zeile

Wird erzeugt durch diese Syntax:

1. Erste Zeile
  1. Zweite Zeile

Überschriften

Überschriften sollen helfen, etwas Struktur in den Text zu bekommen. Praktischer Nebeneffekt ist, dass ganz oben im Dokument automatisch ein Inhaltsverzeichnis aus allen Überschriften erzeugt wird, zu denen dann per Mausklick gesprungen werden kann.

Beim Verfassen von Wiki-Seiten sollten nur Überschriften ab Ebene 2 benutzt werden, weil die Ebene 1 bereits für den automatisch generierten Seitentitel in Verwendung ist.

Einfach an den Zeilenanfang ein bis sechs Rautesymbole # gefolgt von der Überschrift anführen.

#Überschrift Ebene 1

##Überschrift Ebene 2

###Überschrift Ebene 3

####Überschrift Ebene 4

#####Überschrift Ebene 5
######Überschrift Ebene 6

Zudem gibt es noch eine weitere Schreibweise für Überschriften, indem diese einfach mit Gleichheitszeichen (Ebene 1) oder Bindestrichen (Ebene 2) «graphisch unterstrichen» werden:

Überschrift Ebene 1

Überschrift Ebene 2

Mit dieser Schreibweise wird dasselbe erreicht wie oben, aber der Wikitext ist für manche Leute selbsterklärender. Es steht jedoch nur eine einzige Ebene Überschriften zur verfügung wenn die o.g. Regel "Nur Überschriften ab Ebene 2" befolgt wird. Deshalb wird empfohlen, auf diese Schreibweise zu verzichten.

Inhaltsverzeichnis

[[!toc startlevel=2 levels=2]]

Mit der Direktive !toc wird ein Inhaltsverzeichnis aus den in der Seite vorhandenen Überschriften erzeugt.

  • startlevel=2: Fang bei Überschrift Ebene 2 an
  • levels=2: Das Verzeichnis soll zwei Ebenen beinhalten.

Damit wird ein Inhaltsverzeichnis erzeugt, dass die Ebenen 2 und 3 anzeigt.

Um von einem Dokument eine Verbindung zu einem anderen zu erstellen, werden sog. Hyperlinks eingesetzt. Links werden durch Umklammerung eines Textes durch doppelte eckige Klammern erstellt:[[Dokumentname]]. Dabei können interne Links im Wiki oder auch Links zu externen Webseiten oder Emailadressen verwendet werden (siehe Beispiele).

Soll einen anderer Text, als der Linktext angezeigt werden, dann kann man dies durch [[Linktext|Dokumentname]] erreichen.

Beispiele für Links:

Die folgenden Beispiele stellen den Mediawiki-Stil dar, werden aber auch unterstützt:

Vorsicht: Wenn doppelte eckige Klammern im Text verwendet werden sollen, müssen diese mit dem Backslash \ eingeleitet werden, sonst wird es als Link verarbeitet.

Wird der Markdown-Stil innerhalb von HTML verwendet, werden die Links nicht korrekt übersetzt: Es muss der Mediawiki-Stil verwendet werden.

Unformatierte Blöcke

Durch Einrücken um 4 Leerzeichen wird ein unformatierte Block erzeugt, in welchem zB. Code angezeigt werden kann.

<html>
  <head></head>
  <body></body>
</html>

Code Segmente

Mit Backticks ` eingefasster Text wird als Code-Segment dargestellt.

print("hello world")

Bilder und Grafiken

  • [[!img logo_44px.png]] ->

  • [[!img logo_44px.png size="50x50" alt="SF-Logo"]] -> SF-Logo

  • [[!img logo_44px.png size="x100" alt="SF-Logo"]] -> SF-Logo (maximale Breite 100 Pixel)

  • Größenanpassung bei Grafiken auf fremden Servern geht aber nur per HTML-Syntax, genauso, wenn verzerrt werden soll: < img src="https://wiki.starship-factory.ch/logo_44px.png" width="30" height="30" alt="SF-Logo" > -> SF-Logo

Spezialseiten

Umlautprobleme

Auf dern Besucherlaptops mit schweizer Tastatur funktioniert die Compose-Taste nicht. Daher kann man keine grossgeschriebenen Umlaute schreiben.

Daher hier eine Copy-Paste-Zusammenfassung der Umlaute und anderer wichtiger Zeichen:

ÖÄÜöäü

Praktische Symbole

{OK} thumbs-up.png {X} icon-error.png

{i} icon-info.png (?) question.png (./) checkmark.png

(!) idea.png [!] attention.png /!\ alert.png

{*} star on.png {o} star off.png

{1} prio1.png {2} prio2.png {3} prio3.png

Wenn es denn Smileys sein müssen, dafür gibt es eine ganze Seite: smileys