Wiki:help/wikiedit

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
    2. Anwendung: Wie erstelle ich eine Tabelle?
  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
    3. Screenshots referenzieren

Wiki Bearbeitung - Tipps und Tricks

"Erste Hilfe" zu Formatierungsfragen findet sich zwar bereits in den zugehörigen Hilfe-Seiten der genutzten Software. Doch dort kann freilich nicht auf alles eingegangen werden: Zum Einen hinken Hilfe-Seiten bekanntlich der Software-Entwicklung hinterher - und zum Anderen können die Entwickler ja nicht wissen, welche Addons/Plugins letztendlich noch zusätzlich installiert werden.

Also bitte einfach alle Links auf dieser Seite ausprobieren, bis das passende gefunden wurde :))

Erste Schritte

Bei Freetz verwenden wir ein hierarchisches Wiki. Bevor man einen neuen Artikel anlegt, sollte man sich daher Gedanken machen, wo er hingehört. Ein paar Beispiele sollen dies veranschaulichen:

  • Dokumentation zu einem Paket gehören nach packages/<paketname>
  • Dokumentation zu einem Patch entsprechend nach patches/<patchname>
  • Howtos sind unter help/howtos/ angesiedelt, und dort auch nochmals in Themengebiete untergliedert:
    • help/howtos/security ist der Startpunkt für sicherheitsrelevante Dinge
    • help/howtos/development für Entwickler-Informationen (und alles, was damit zusammenhängt)
    • help/howtos/troubleshoot für alle möglichen Probleme mit den zugehörigen Lösungen
    • help/howto/common für allgemeine Howtos

Der komplette Artikelpfad ist in Kleinbuchstaben zu halten, die einzelnen Elemente möglichst in Englischer Sprache.

Am besten einfach ein paar Artikel anschauen, die ähnliche Kriterien wie der zu erstellende Artikel aufweisen - und schauen, wo diese abgelegt sind.

Eine gute Idee ist es auch, den Artikel mit passenden Tags zu versehen (dafür gibt es unter der "Textarea" ein Feld Tag under). Verfügbare Tags lassen sich über den Link "view all tags" direkt über diesem Feld anzeigen. Ausführlichere Hilfe hierzu findet sich hier.

Auf diese Weise helft Ihr gleich mit, Ordnung zu halten. Aber keine Panik: Sollte einmal ein Artikel an falscher Stelle eingeordnet worden sein, lässt er sich im Nachhinein immer noch an die richtige Stelle schieben. Besser den Artikel falsch platziert, als gar nicht geschrieben!

Weitere Lektüre

Damit die Artikel immer besser werden, seien die hier verlinkten Hinweise jedem ans Herz gelegt. Nicht unbedingt in der Reihenfolge, wie sie im Inhaltsverzeichnis auf der rechten Seite aufgelistet sind - aber die Formatierungs Guidelines sind ein guter nächster Schritt. Alle anderen Punkte ergeben sich dann je nach Bedarf.