The wikis are now using the new authentication system.
If you did not migrate your account yet, visit https://idp-portal-info.suse.com/

openSUSE:Style Guidelines

Wechseln zu: Navigation, Suche
Diese Guidelines umfassen die Hauptbestandteile, wie man einen Artikel im openSUSE wiki anlegt oder editiert und stellen sicher, dass ein gleichbleibenendes look and feel eingehalten wird. Sie beruhen hauptsächlich auf Wikipedia guidelines.
Arbeitsskizze

Neutraler Stil

Nutzen Sie einen neutralen Stil. Vermeinden Sie Personapronomen wie "Ich", "Wir" usw.

Halten Sie es kurz und prägnant

Achten Sie beim Schreiben auch auf die Lesbarkeit des Textes. Schlecht geschriebene Artikel mit übermäßig vielen Wörtern werden nicht gelesen. Halten Sie Ihre Texte möglichst kurz.

  • Schreiben Sie keine bedeutungslosen oder überflüssigen Inhalte. Der Leser möchte kurze, klare Artikel, um schnell an die benötigten Informationen zu kommen. Leser werden die Seite aber verlassen, wenn der Artikel mit zu viel bedeutungslosen Inhalten aufgebläht ist.
  • Benutzen Sie einen einheitliches, aufgeräumtes Format vom Anfang bis zum Schluss. Niemand möchte einen Artikel lesen, der in etliche schlecht formatierte (Layouts und Farben) Absätze gegliedert ist. Dies hätte zur Folge, dass der Leser langsamer lesen muss und wahrscheinlich dazu neigt, den Artikel zu verlassen.
  • Damit Ihre Wiki-Artikel hilfreich und beliebt werden, Halten Sie sie kurz und prägnant!

See Article development on Wikipedia.


Aufbau

Überschrift

  • Die Überschrift sollte klar und kurz gehalten werden.
  • Nutzen Sie nichts Kryptisches en:Akronyms, solange Sie nicht wissen, dass dies einer Großzahl der Zielgruppe bekannt ist.
  • Nutzen Sie keine Binnenmajuskel [[1]], stattdessen trennen Sie die Worte. z.B. Wiki-Seite anstatt WikiSeite.
  • Nutzen Sie keinen Doppelpunkt als Trenner in Überschriften. Siehe Colon in title.
  • Vermeinden Sie Sonderzeichen. Für die deutschen Umlaute nutzen Sie die HTML-Kodierung [[2]].

Abschnittsüberschrift

  • Alles was für die Überschriften gilt, gilt natürlich genauso für die Abschnittsüberschriften.
  • Da die Abschnittsüberschriften das Inhaltsverzeichnis ergeben, ist eine kurze und klare Wortwahl erwünscht, da dies die Lesbarkeit fördert und bei der Seitennavigation hilft.
  • Wiederholen Sie die Überschrift nicht im ersten Absatz. Wiederholungen animieren nicht zum Weiterlesen.
  • Nutzen Sie nicht ´´Einleitung´´ als Name des ersten Absatzes. Der erste Absatz ist logischerweise eine Einleitung, so dass die Deklaration ´´Einleitung´´ nichts Neues bringt.

Überschriften

  • Nutzen Sie = um eine Überschrift zu erstellen. Auf diese Weise ergibt sich das Inhaltsverzeichnis automatisch aus den Überschriften und hilft dem Leser, direkt auf den Abschnitt zu springen, der ihn interessiert.
  • Beginnen Sie mit einem doppelten Gleichheitszeichen == keinem einfachen =.
{{Bemerkung|einfache Gleichheitszeichen (=) bewirken die gleiche Textgröße wie in den Artikeln. Dies wird im gewöhnlichen Schreibstil genutzt.
  • Erstellen Sie keine Links in Überschriften. Stattdessen verlinken Sie das Wort oder den Satz im Abschnitt, wenn er das erste Mal auftaucht.
  • Unterteilen Sie sehr lange Abschnitte in ein paar Unterabschnitte, indem Sie Abschnittsüberschriften nutzen.
  • Nutzen Sie ---- um eine horizontale Trennlinie zu erstellen, bevor Sie irgendeine Level 2 Überschrift (==) erstellen. Dies hilft den Artikel einfacher zu lesen.
Beispiel:
 ==Überschrift 1==
 ===Abschnittsüberschrift 1.1===
 ===Abschnittsüberschrift 1.2===
 
 ----
 ==Überschrift 2==
 ===Abschnittsüberschrift 2.2===
 ====Abschnittsüberschrift 2.2.1====
 =====Abschnittsüberschrift 2.2.1.1=====

 ----
 ==Überschrift 3==

Der Inhalt

Schreibweise von openSUSE

  • openSUSE ist die einzig korrekte Schreibweise von openSUSE. "OpenSUSE", "openSuSE", OpenSuse" und jede andere Schreibweise sind alle falsch formatiert.
  • Nutzen Sie keine Copyright- oder Trademark-Zeichen (wie © oder ®). Dies behindert den Lesefluß.
  • Beachten Sie das die Schreibweisen "SuSE Linux" und "SUSE Linux" abgelehnt werden. Solange nicht explizit auf eine ältere Version von openSUSE (10.1 oder eine frühere Version), aus geschichtlichen Gründen, SUSE Linux Enterprise Server (SLES) oder SUSE Linux Enterprise Desktop (SLED) hingewiesen wird. Nutzen Sie "openSUSE".

Verdoppelung

Verdoppeln Sie nicht den Aufwand.

  • Überprüfen Sie die Liste der en:HOWTOs. Dort gibt es bereits eine große Anzahl von Artikeln. Wenn dort bereits ein Artikel vorhanden ist, der dem Thema des Artikels entspricht den Sie schreiben wollen, dann nehmen Sie sich die Zeit diesen zu lesen um zu überprüfen ob sie diesen erweitern können.
  • Im openSUSE Forum befindet sich eine Reihe von HOWTOs im Advanced How To/FAQ (read only), forum und ein weiteres weniger ausgereiftes Unterforum Unreviewed How To and FAQ
  • Hier finden Sie auch eine große Auswahl von HOWTO-Artikeln: The Linux Documentation Project.

Akronyme und Abkürzungen

  • Bei ersten Auftreten eines Akronyms in einem Artikel, nutzen Sie den vollen Namen gefolgt von der abgekürzten Form in Klammern. Zum Beispiel: Section titles automatically form the table of contents (TOC).
  • Vermeiden Sie komplexe Abkürzungen. Diese erschweren es den Artikel zu lesen.
  • Nutzen Sie immer Standard- und leicht verständliche Abkürzungen. Selbsterstellte Abkürzungen würden möglicherweise falsch interpretiert werden.

Variablen

Sometimes, a command input is specific to the user's system, such as system devices or username. Following conventions are to be used: Manche Kommando-Eingaben hängen vom jeweiligen Benutzer-System ab. Wie zum Beispiel System-Geräte oder Usernamen. Folgende Schreibweisen sollten benutzt werden:

  • <benutzername, zum Beispiel in einem Pfad-Befehl /home/<benutzername
  • sdX für Geräte

Bitte beachten Sie dass:

  • wenn Sie diese Schreibweise benutzen, Sie einen Kommentar brauchen, wie: "Ersetzen Sie den aktuellen Geräte-/Benutername (sda, sdb, hda, etc) anstatt sdX".
  • Wenn mehrere Geräte angesprochen werden nutzen Sie die Schreibweise sdX, sdY, sdZ. Wenn mehr als drei Geräte eine Bezeichnung benötigen, fangen Sie mit Geräte sdN an. Wobei N der letzte Buchstabe vom Alphabet ist.

Sicherheit für Erstanwender

Warnung: Seien Sie besonders vorsichtig bei Anweisungen die mit Root-Rechten ausgeführt werden. Befehle wie dd, rm, fdisk können sehr viel Schaden anrichten, wenn sie benutzt werden ohne den Hintergrund zu kennen. Oft verstehen Erstnutzer nicht die Befehle aber kopieren und fügen solche Befehle wieder ein.

  • Verwenden Sie niemals einen Beispielcode wenn das Resultat bei kopieren und wiedereinfügen in die Kommandozeile als Desaster enden würde. Als Beispiel, dieses Kommando:
dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda

Wenn dieses Kommando direkt in die Kommandozeile kopiert würde, würde es die erste Festplatte überschreiben. /dev/sda ist die erste Festplatte und ist in jedem Computer vorhanden. Wobei dieses Kommando:

dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX

sicher ist. Es ist extrem unwahrscheinlich, dass /dev/sdX existiert. Folglich würde nur eine Fehlermeldung zurückgegeben (anstatt das sda überschrieben wird).

Bilder

Plazierung

Schauen Sie auf Image markup. Dort finden Sie Empfehlungen wie Sie Bilder am besten platzieren. Für Beispiele und Ideen wie Sie Bilder plazieren, schauen Sie auf Picture tutorial.

Format

  • Zeichnungen, Piktogramme und andere Bilder (im Regelfall solche mit langer, einfacher und durchgängiger Anzahl von Farben) sollte im PNG-Format sein.
  • Fotos sollten im JPEG-Format sein.
  • Animationen sollen im animiertem GIF-Format sein.
Bitte beachten Sie dass alte Versionen von Artikeln nicht die dementsprechende alte Version des Bildes anzeigen. Aber die Neueste, solange nicht der Dateiname des Bildes geändert wurde.

Kommentare

  • Zerstückeln Sie Artikeltext nicht mit Kommentare und Fragen. Benutzen Sie stattdessen die Diskusionsseite des Artikels.
  • If you want to communicate with other editors, make comments invisible to the ordinary article reader by using comment tags.
  • Wenn Sie mit anderen Wiki-Autoren kommunizieren möchten, nutzen Sie unsichtbare Kommentare in Ihrem Artikel indem Sie Kommentar-Tags verwenden.
 <!-- Dies ist ein unsichtbarer Kommentar  --> 

Benötigt Seiten

Um auf einen benötigten Artikel hinzuweisen, der bislang noch nicht existiert, erstellen Sie im Text eines bestehenden Artikel einen Link zu den benögtigten Artikel. Wenn mindestens zwei Links zu demselben Atikel vorhanden sind, wird dieser unter Wanted Pages angezeigt. Dies ist auch die Quelle für Anregungen der vielen neuen Wiki-Autoren. Nicht alles dort ist ist wirklich notwendig oder sinnvoll. Welchen Artikel Sie wählen entscheiden Sie durch Ihr Fachwissen.


Elemente

Wenn Sie einen Artikel schreiben, vergewissen Sie sich, dass Sie folgende Regelungen einhalten.

Wiki markup

Solange es möglich ist HTML tags zum formatieren einer Seite zu nutzen, nutzen Sie die MediaWiki markup. Dies erleichtert die Lesbarkeit des Quelltextes und ist einfacher zu editieren.

Schauen Sie auch auf Wiki Reference card und in die Quelltexte einiger Artikel.

Kommando Tasten

F5 und Tab

  • Code: <code>Die Taste die gedrückt werden soll</code>
  • Beschreibung: Die Taste die gedrückt werden soll.
  • Wo: Überall

Kommando Pfad

/usr/src/linux und /etc/SuSE-release

  • Code: <tt>/pfad/zu/einem/verzeichnis/oder/einer/datei</tt>
  • Beschreibung: Beschreibung eines Verzeichnis- oder Datei-Pfads.
  • Wo: Überall

Kommando Eingabe

$ user command
# root command
  • Code: {{Shell|$ user command}}<nowiki></code> oder <code><nowiki>{{Shell|# root command}}
  • Beschreibung: Kommando das eingegeben werden soll.
  • Wo: Überall

Kommando Ausgabe

Ausgabetext

  • Code: (Leerzeichen)kurzer Ausgabetext oder <pre>langer Ausgabetext</pre>
  • Beschreibung: Beschreibung von dem Ergebnis eines eingegebenen Kommandos.
  • Wo: Überall

Meeting Mitschriften

... Content ...
  • Code: <div class="minutes"> ... Content ... </div>
  • Beschreibung: Display of meeting transcripts.
  • Wo: Überall

Tables

Heading 1 Heading 2 Heading 3 Heading 4 Heading 5 Heading 6
Highlighted text Highlighted text Highlighted text Text Text Highlighted text
Text Text Text Text Text Highlighted text
Text Text Text Text Text Highlighted text
  • Code: See page source.
  • Beschreibung: Display a table with optionally highlighted text.
  • Wo: Überall

Vorlagen

Siehe Wiki Vorlagen Richtlinien.


Siehe auch


Externe Links