Skip to content

formatting_guide

Jump to bottom
JBBgameich edited this page May 1, 2018 · 4 revisions

Inhaltsverzeichnis

  1. Wiki Bearbeitung - Tipps und Tricks
    1. Erste Schritte
    2. Weitere Lektüre
  2. Wiki Goodies
    1. Smileys
    2. Symbols
    3. Entities
  3. Formatierungs-Guidelines
    1. Beispiel-Artikel
    2. Inhaltsverzeichnis
    3. Überschriften
    4. Artikeltext
    5. Screenshots
    6. Besondere Formatierungen
    7. Weiterführende Links
    8. Tags
  4. Tabellen
    1. Überblick der verschiedenen Formate
      1. Standard
      2. RST
      3. MediaWiki
    2. Anwendung: Wie erstelle ich eine Tabelle?
      1. Standard
      2. RST
      3. MediaWiki
        1. Einfaches Beispiel
        2. komplexeres Beispiel
  5. Inhaltsverzeichnis erstellen (lassen)
    1. Unterseiten einbeziehen
    2. Ebenentiefe einschränken
    3. Mehrere TOC Blöcke
    4. Weitere Möglichkeiten
  6. Tagging
    1. Was und wozu sind Tags?
    2. Wie vergibt man Tags?
    3. Welche Tags sollte man vergeben?
    4. Was ist noch zu beachten?
  7. Screenshots
    1. Screenhots hochladen
    2. Screenhots finden
      1. Screenshot Matrix
      2. Screenshots Liste
    3. Screenshots referenzieren

Formatierungs-Guidelines

Damit ein Wiki "wie aus einem Guss" wirken kann, sind einheitliche Formatierungen vonnöten. Daher soll an dieser Stelle einmal kurz aufgezeigt werden, nach welchen "Richtlinien" bislang vorgegangen wurde

  • was natürlich als Anhaltspunkt bei der Erstellung neuer sowie der Bearbeitung existierender Artikel gut geeignet sein sollte.

Beispiel-Artikel

Die Zusammenfassung einmal vorab: So könnte der Artikel für ein fiktives Paket namens dummy aussehen:

[[TOC(heading=Inhaltsverzeichnis)]]

= dummy =

'''dummy''' ist ein Paket, das es nicht wirklich gibt.
Wirklich geben tut es hingegen Pakete wie [wiki:packages/callmonitor CallMonitor]
und [wiki:packages/dtmfbox DTMFBox].

== Installation ==
Die Installation erfolgt wie bei den meisten Paketen direkt bei der
[wiki:help/howtos/common/installation Erstellung des Freetz-Images], indem das Paket
einfach in der
[wiki:help/howtos/common/installation/menuconfig menuconfig] mit ausgewählt wird.

== Einrichtung ==
''dummy'' verfügt über eine Konfigurations-Oberfläche, in der sich alle notwendigen
Einstellungen tätigen lassen:
[[Screenshot(123)]]
 * '''Starttyp''': "Automatisch", wenn ''dummy'' nach jedem Reboot automatisch
gestartet werden soll.
 * '''Punkt1''': Hier trägt man was ein
 * '''Punkt2''': blabla...

== Besonderheiten ==
''dummy'' kann auch zu Debugging-Zwecken mit {{{dummy -D}}} direkt von der Kommandozeile
gestartet werden. Ein Skript für Trallalla könnte so aussehen:
{{{
#!sh
# Irgendwas machen
echo "Trallala!"
# Tschüß sagen
echo "Warnurspaß!"
exit 0
}}}

== Weiterführende Links ==
 * [http://de.wikipedia.org/wiki/Lillibullero Wikipedia Artikel zu Trallala]
 * [http://www.wehavemorefun.de/ More fun to come] (Englisch)

Inhaltsverzeichnis

[[TOC(heading=Inhaltsverzeichnis)]]
Die erste Zeile unseres Beispiel-Artikels enthält den Aufruf eines Makros, das ein automatisches Inhaltsverzeichnis erstellt. Das macht natürlich nur dann Sinn, wenn der Artikel auch mehrere (mindestens 3) Überschriften enthält. In userem Beispiel haben wir dem Makro genau einen Parameter mitgegeben: Die Überschrift (engl.: heading) des Inhaltverzeichnisses soll natürlich bei einem deutschsprachigen Artikel auch Deutsch sein. Default wäre hier Englisch, und zwar "Table of Contents".

Ausführlichere Hilfe zum Inhaltsverzeichnis gibt es hier.

Überschriften

= dummy =
Wir beginnen unseren Artikel mit einer Überschrift "Ebene 1" - nennen wir sie der Einfachheit halber "Hauptüberschrift". In der Regel ist dies die einzige Hauptüberschrift eines Artikels. Nach "unten" stufen wir schrittweise ab - Sprünge machen wenig Sinn.

Artikeltext

'''dummy''' ist ein Paket...
Es ist meist sinnvoll, die erste Erwähnung des Paketnamens mit Fettdruck zu versehen - insbesondere, wenn man eine davon abweichende Hauptüberschrift gewählt hat. Hat das Projekt eine Homepage, so macht es auch Sinn, diese hier zu verlinken. In diesem Falle sähe der Anfang dann etwa so aus:

'''[http://www.dummy.dom/ dummy]''' ist ein Paket...

Anschließend geht es nach gesundem Menschenverstand mit dem passenden Fließtext weiter, es folgen Aufzählungen, oder was auch sonst in diesem Zusammenhang benötigt wird.

Screenshots

[[Screenshot(123)]]
Screenshots und andere Bilder verwalten wir hier mit dem ScreenshotsPlugin. Näheres zum Umgang damit findet sich an dieser Stelle ausführlich beschrieben.

Besondere Formatierungen

Gesondert hervorgehoben werden sollten:

  • Dateinamen, Pfade, Kommandozeilen-Befehle: eingeschlossen in dreifache geschweifte Klammern ({{{Befehl}}})
  • Bezüge (wie in unserem Beispiel die Beschreibung der einzelnen Konfigurationspunkte) in Fettdruck
  • weitere Erwähnungen des Paketnamens (oder auch andere Eigennamen) kursiv
  • mehrzeilige Skript-Fragmente (oder auch vollständige Skripte) in Code-Blöcken (siehe Beispiel). Für das Syntax-Highlighting gibt es verschiedene WikiProcessors - das Beispiel benutzt den für Shell-Skript zuständigen.

Weiterführende Links

Eine gute Sache ist es auch, interessante Links zum Artikel am Ende (nochmals) zusammenfassend aufzuzählen - auch wenn sie bereits im Artikeltext selbst benutzt (verlinkt) wurden. Dann muss man nicht ewig nach ihnen suchen :)

Tags

Nach dem Speichern des Artikels klicken wir nun nochmals auf den Edit Button, um den Artikel mit den passenden Tags zu versehen. Gleichzeitig klappt das leider nicht (Bug im TagsPlugin: Es werden dann zwar die Tags aktualisiert, aber der ganze Artikeltext, bzw. die gemachten Änderungen, gehen verloren). Wozu Tags nun wiederum wichtig sind, und wie man sie verwendet, findet sich im gerade dazu verlinkten Artikel.

Clone this wiki locally