Syntaxempfehlung

Aus wiki.archlinux.de
Version vom 27. Januar 2013, 10:40 Uhr von Dirk (Diskussion | Beiträge) (kategorisiert)

(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche

Zu diesem Wiki-Artikel existieren ein Alternativvorschlag, und auch ein Foren-Thread. Die Artikel stehen nicht in Konkurrenz zueinander, es soll vielmehr eine gemeinsame Lösung durch einen optimalen Artikel gefunden werden.


Diese Seite soll eine Empfehlung für alle Artikelschreiber im Wiki darstellen, um das Wiki einheitlich und gut lesbar zu gestalten.

Inhaltliches

Die Struktur der einzelnen Artikel kann natürlich nicht einfach starr vorgeschrieben werden, da jedes Programm individuell ist. Es sollten aber einige Dinge beachtet werden, um die Artikel nicht ausufern zu lassen, aber auch nicht zu kurz zu fassen.

  • Zur Installation ist nur etwas zu sagen, wenn sie nicht normal abläuft. Bei den KDE-Paketen z.B. sollte mit angegeben werden, welche Teilkomponenten enthalten sind, da diese oft nicht sofort über ein beherztes pacman -Ss der Paketname herausgefunden werden kann. Auch bei Programmen, die nur im AUR oder nicht einmal dort verfügbar sind, ist ein Abschnitt zur Installation oft hilfreich.
  • Die Beschreibung der Konfiguration ist meist hilfreich, aber nicht immer nötig.
  • Spezielle Dinge (zum Beispiel xmonad in KDE einbetten) sind in Unterseiten (xmonad/in_KDE) besser untergebracht.

Mikrotypographisches

Beim Verfassen von Artikeln sollte beachtet werden, dass das Einhalten gewisser Konventionen das Lesen und Verstehen der Artikel erleichtert. Die [Bearbeitungshilfe] gibt Auskunft darüber, was man alles machen kann, aber gibt keinerlei Empfehlungen, wie man in bestimmten Fällen vorgehen sollte. Dieser Abschnitt soll solche Empfehlungen geben. In Einzelfällen kann auch ein anderes Vorgehen einen Sinn ergeben,

Am wichtigsten ist wohl, bestimmte Dinge im Artikel auf eine geeignete Weise hervorzuheben. Solche Dinge sind z.B.

  • Datei- oder Kommandonamen pacman oder ls. Hier kann man das code-Tag verwenden
  • komplette Kommandozeilen (Erläuterung: pacman ist ein Kommandoname, aber kein komplette Kommandozeile): Das folgende aber schon:
sudo pacman -Syu

Hier reicht eine Einrückung, um ein abgesetztes Layout zu erreichen.

  • Betonungen (in sprachlicher Hinsicht). Zum Beispiel, um den Unterschied zwischen "Diesen Haufen hat ein Hund gemacht." (keine Katze) und "Diesen Haufen hat ein Hund gemacht." (nicht mehrere) zu verdeutlichen.
  • Hervorhebungen (in inhaltlicher Hinsicht): Wenn man will, dass einzelne Worte schon beim Drüberlesen auffallen. Meiner Meinung nach sparsam einzusetzen.

Ich habe in diesem Text schon einige Formatierungen vorgenommen, die ich für sinnvoll erachte. Zum Teil ist es aber browserabhängig, wie die Formatierungen am Ende aussehen.