openSUSE:Stilleitfaden

aus openSUSE, der freien Wissensdatenbank

Halten Sie sich bitte an den folgenden Leitfaden, wenn Sie Artikel in diesem Wiki bearbeiten oder erstellen.

Artikeltitel

Der Name eines Artikels ist gleichzeitig auch seine Überschrift. Gestalten Sie ihn möglichst klar und aussagekräftig, benutzen Sie keine kryptischen Abkürzungen und keine Binnenmajuskeln (Höckerschreibweise). Wiederholen Sie den Titel nicht im Text als Überschrift. Kreieren Sie nicht ihre eigenen Namensräume.

Überschriften

• Benutzen Sie die = (Überschrift) Textauszeichnung, nicht die ''' (fett) Textauszeichnung, um eine Überschrift zu erstellen. Auf diese Weise wird aus den Überschriften automatisch ein Inhaltsverzeichnis erstellt.
• Beginnen Sie mit nur einer = und nicht mit der doppelten ==. Zum Beispiel:

=Überschrift 1=
==Unterkapitel 1.1==
==Unterkapitel 1.2==
=Überschrift 2=
==Unterkapitel 2.2==
===Unterkapitel 2.2.1===
====Unterkapitel 2.2.1.1===

• Überschriften erleichtern es Lesern, schneller die Informationen zu erreichen, die sie suchen und das, was sie nicht interessiert, auszulassen.
• Wenn ihr Text sehr lang wird, überlegen Sie, ob es möglich ist, ihn in Unterkapitel zu gliedern.

Zeichnen Sie ihren Text aus

Benutzen Sie die Möglichkeiten der MediaWiki-Software zur Textauszeichnung um ihren Text lesbarer zu gestalten. Stellen Sie Dateinamen und Konsolenbefehle in einer festen Schriftart dar:

<tt>feste Schriftart</tt>

Nutzen Sie die Möglichkeiten von MediaWiki

Benutzen Sie HTML-Formatierungen nur, wenn Sie unbedingt müssen. Die Verwendung von MediaWiki Formatierungen verleiht Artikeln ein einheitliches Aussehen und Handhabung, außerdem ist der Quellcode einfacher zu schreiben, zu lesen und zu bearbeiten. Werfen Sie auch einen Blick auf die MediaWiki Bearbeitungshilfe um herauszufinden, welche Formatierungen und Werkzeuge sie benutzen können. Es schadet auch nie, sich den Quellcode einiger Wikipediaartikel anzuschauen.

Kommentare

Benutzen Sie als Leser die Diskussionsseite eines Artikels, verstopfen Sie nicht den Artikeltext.

Sehen Sie als Autor davon ab, innerhalb des Artikels auf bestimmte Dinge hinzuweisen. Wenn ihnen ein Artikel bspw. als zu kurz erscheint und ausgebaut werden sollte, dann benutzen Sie dafür am besten die {{Erweitern}} Vorlage.

Wenn Sie mit potentiellen Autoren kommunizieren wollen, verwenden Sie für Leser nicht sichtbare Kommentare im Quelltext. Dazu umschließen Sie den Kommentartext einfach mit <!-- und -->.

Zum Beispiel wird dann folgendes:

Hallo <!--Dies ist ein Kommentar.--> Welt

so dargestellt:

Hallo Welt

Der Kommentar kann dann nur gesehen werden, wenn man sich die HTML- oder Wiki-Quellen anschaut.

Kein künstliches Aufblähen

Erstellen Sie Bitte nur Artikel, die wenigstens ein Minimum an relevanten Informationen enthalten. Der Weg im Wiki, mitzuteilen, dass man einen Artikel vermisst, besteht darin, einen Link zu ihm zu erstellen. Sobald zwei Verknüpfungen auf diesen Artikel verweisen, wird er unter den gewünschten Seiten aufgelistet.