Syntaxempfehlung

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

Struktur

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 (xmonad in KDE einbetten zum Beispiel (kann ich sehr empfehlen)) sind in Unterseiten (xmonad/in_KDE) besser untergebracht.