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

Hilfe:Aussehen

(Weitergeleitet von Hilfe:Style)
Wechseln zu: Navigation, Suche
Diese Richtlinien umfassen hauptsächlich, wie man Artikel im openSUSE Wiki anlegt, bearbeitet und wie ein gleich bleibendes Design eingehalten wird. Diese Richtlinien beruhen hauptsächlich auf Wikipedia: Wie gute Artikel aussehen.
Arbeitsskizze

Neutraler Stil

Es sollte immer ein neutraler Stil verwendet werden. Es gilt die Anwendung von 'Personalpronomen' wie "Ich", "Du", "Wir" und weiteren Benennungen zu vermeiden!

Halten Sie es kurz und prägnant

Beim Schreiben von Artikeln sollte auf die Lesbarkeit des Textes geachtet werden. Schlecht geschriebene Artikel mit übermäßig vielen Wörtern werden nicht gelesen. Deshalb gilt es, die Texte möglichst kurz und aussagekräftig zu verfassen.

  • Keine bedeutungslosen oder überflüssigen Inhalte, denn der Leser möchte kurze, klare Artikel um schnell an die benötigten Informationen zu kommen. Leser werden die Seite aber verlassen, wenn Artikel mit zu viel bedeutungslosen Inhalten künstlich aufgebläht sind.
  • Einheitliches, aufgeräumtes Format vom Anfang bis zum Schluss anwenden, denn 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 'Wiki-Artikel' hilfreich und beliebt werden, gilt folgende Regel: Kurz fassen und prägnant gestalten!

Siehe Wikipedia:Wikipedia:Wie_schreibe_ich_einen_guten_Artikel.


Aufbau

Überschrift

  • Die Überschrift sollte klar und kurz gehalten werden.
  • Es sollte nichts Kryptisches genutzt werden, solange nicht klar ist, dass dies einer Großzahl der Zielgruppe bekannt ist.
  • Auch sollten keine Binnenmajuskel verwendet werden, die Worte. z.B. Wiki-Seite anstatt WikiSeite getrennt werden können.
  • Bitte keinen Doppelpunkt als Trenner in Überschriften verwenden! Der Doppelpunkt dient in der 'Media-Wiki' als Trenner für Namensraum und Artikeltitel. Alles vor dem Doppelpunkt wird als Namensraum interpretiert. Sofern es den Namensraum aktuell gibt oder künftig (an die Zukunft denken!) geben soll.

Abschnittsüberschrift

  • Alles was für die Überschriften gilt, ist natürlich genauso für die Abschnittsüberschriften anzuwenden.
  • Weil die Abschnittsüberschriften das Inhaltsverzeichnis ergeben, ist eine kurze und klare Wortwahl erwünscht. Zum einen um die Lesbarkeit zu fördern, zum anderen um die Seitennavigation zu erleichtern.
  • Wiederholungen in der Überschrift und im ersten Absatz, sind Wiederholungen die nicht gerade zum Weiterlesen animieren.
  • Bitte keinen Absatz mit: "Einleitung" als Name anwenden. Der erste Absatz ist logischerweise eine Einleitung, so dass die Deklaration "Einleitung" nichts Neues bringt.

Überschriften

  • Bitte nur = 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 von Interesse ist.
  • Beginnen sollten Autoren mit einem doppelten Gleichheitszeichen == und nicht mit einem einfachen =!
einfache Gleichheitszeichen (=) bewirken die gleiche Textgröße, die auch der Artikeltitel hat. Dies wird im gewöhnlichen Schreibstil nicht genutzt.
  • Auch keine Links in Überschriften verwenden. Stattdessen besser das Wort oder den Satz im Abschnitt verlinken wenn dieser das erste Mal auftaucht.
  • Unterteilen Sie sehr lange Abschnitte in ein paar Unterabschnitte, indem Sie Abschnittsüberschriften nutzen.
  • Bitte nur ---- um eine horizontale Trennlinie zu erstellen, bevor irgendeine Level 2 Überschrift (==) erstellt wird. 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!
  • Bitte keine Copyright- oder Trademark-Zeichen (wie © oder ®) verwenden, denn dies behindert den Lesefluss.
  • Zudem gilt es zu beachten, dass die Schreibweisen "SuSE Linux" und "SUSE Linux" abgelehnt werden solange nicht aus geschichtlichen Gründen explizit auf eine ältere Version von openSUSE (10.1 oder eine frühere Version) SUSE Linux Enterprise Server (SLES) oder SUSE Linux Enterprise Desktop (SLED) hingewiesen wird.

Verdoppelung

Doppelte Aufwand ist immer nachteilig.

  • Bitte erst die Wiki auf 'Anleitungen/HowTos' überprüfen, bevor ein Artikel erstellt werden soll. Es gibt bereits eine große Anzahl von Artikeln. Wenn dort bereits ein Artikel vorhanden ist der dem Thema des zu erstellenden Artikels entspricht der geschrieben werden soll, ist es besser und hilfreichen den vorhandenen erst zu lesen und zu überprüfen ob dieser nicht erweitert werden könnte.
  • 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 findet sich auch eine große Auswahl von HOWTO-Artikeln: The Linux Documentation Project.

Akronyme und Abkürzungen

  • Bei der ersten Verwendung eines Akronyms in einem Artikel, sollte die ausgeschriebene Version, gefolgt von der abgekürzten Form in Klammern verwendet werden. Zum Beispiel: Section titles automatically form the table of contents (TOC).
  • Bitte komplexe Abkürzungen vermeiden, denn diese erschweren es den Artikel zu lesen.
  • Stattdessen immer Standard- und leicht verständliche Abkürzungen verwenden. Erst recht gilt es selbsterstellte Abkürzungen zu vermeiden, denn würden möglicherweise falsch interpretiert.

Variablen

Manche Kommando-Eingaben hängen vom jeweiligen Benutzer-System ab, wie zum Beispiel System-Geräte oder Anwendernamen. Folgende Schreibweisen sollten benutzt werden:

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

Bitte zu beachten dass:

  • wenn diese Schreibweise benutzt wird, ein Kommentar nötig wird wie: "Ersetzen Sie den aktuellen Geräte-/Benutername (sda, sdb, hda, etc) anstatt sdX".
  • Wenn mehrere Geräte angesprochen werden, sollte die Schreibweise sdX, sdY, sdZ bevorzugt werden. Wenn mehr als drei Geräte eine Bezeichnung benötigen, fängt dies mit Geräte sdN an. Wobei N der letzte Buchstabe vom Alphabet ist.

Sicherheit für Erstanwender

Warnung!
Ganz besondere Vorsicht gilt bei Anweisungen, die mit Root-Rechten ausgeführt werden.
Befehle wie dd, rm, fdisk können sehr viel Schaden anrichten, wenn diese benutzt werden ohne den Hintergrund zu kennen.
Oft verstehen Erstnutzer derartige Befehle nicht, kopieren und fügen aber solche Befehle wieder ein ohne sich darüber Gedanken zu machen!
Verwenden Sie niemals einen Beispielcode/-Befehl, wenn das Resultat beim kopieren und wieder einfügen in die Kommandozeile als Desaster enden würde!

Als Beispiel, dieses Kommando:

# dd if=openSUSE-11.x-KDEx-LiveCD-i686.iso of=/dev/sda


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

# dd if=openSUSE-11.x-KDEx-LiveCD-i686.iso of=/dev/sdX


sicher ist. Denn es wurden die openSUSE-Ausgaben neutralisiert, ebenso die KDE-Version. Damit ist es extrem unwahrscheinlich, dass zum einen /dev/sdX existiert und zum weiteren müssten die openSUSE-/KDE-Ausgaben präzisiert werden. Folglich wird nur eine Fehlermeldung zurückgegeben (anstatt das sda überschrieben wird).

Bilder

Platzierung

Es empfiehlt sich ein oder mehrere Bilder in einen Rahmen zu setzen. Dies hat mehrere Vorteile, wie beispielsweise die Begrenzung der Auflösung, was eine schnellere Ladezeit einer Seite mit sich bringt und das direkte Beschriften des Bildes im Rahmen des Bildes.


In der Praxis sieht so ein Bild links aus:

{|
|[[Bild:Testbild.png|200px|thumb|Name und Bezeichnung des Bildes]]
|}

So sieht ein Bild aus, welches klein am rechten Bildrand platziert wird.


[[Bild:Testbild.png|100px|thumb|Name und Bezeichning|right]]


Und so für mehrere Bilder:

{|
|[[Bild:Testbild.png|200px|thumb|Name und Bezeichnung des Bildes]]
|[[Bild:Testbild.png|200px|thumb|Name und Bezeichnung des Bildes]]
|[[Bild:Testbild.png|200px|thumb|Name und Bezeichnung des Bildes]]
|}

was je nach Design und Style erweitert werden kann.

In der Praxis ist das jedoch meist mit max. 3 Bildern in 200px Auflösung, als Grenze anzusehen. Ist die Auflösung kleiner, können entsprechend mehr Bilder für eine Strecke eingebaut werden.

Zeichenerklärung:

  • 200px = ist die gewünscht Größe des Bildes im Artikel
  • thumb = ist der Rahmen mit "Klicke hier zum Vergrößern" Symbol

Informationen, Ideen und Empfehlungen wie Bilder am besten zu platzieren sind, finden sich in folgender Wikipedia-Hilfeseite: Wikipedia:Hilfe:Bilder.

Format

  • Zeichnungen, Piktogramme und andere Bilder (im Regelfall solche mit geringer Anzahl von Farben und scharf abgegrenzten Bereichen) sollten im PNG-Format sein.
  • Fotos sollten im PNG- oder können auch im JPEG-Format sein.
  • Animationen sollen im animiertem GIF-Format sein.
Bitte zu beachten, dass alte Artikelversionen nicht die entsprechende, alte Version von Bildern anzeigen. Statt dessen wird die Neueste angezeigt, sofern nicht der Dateiname des Bildes geändert wurde.

Kommentare

  • Zerstückeln des Artikeltextes mit Kommentaren und Fragen ist zu vermeiden. Stattdessen ist dafür die Diskussionsseite des Artikels zu verwenden.
  • Wenn mit anderen Wiki-Autoren kommuniziert werden will oder muss, kann dazu ein unsichtbarer Kommentar im Artikel an entsprechender stelle in Form einer Kommentar-Tags verwenden werden.

Beispiel:

 <!-- Dies ist ein unsichtbarer Kommentar  --> 

Gewünschte Seiten

Um auf einen benötigten Artikel hinzuweisen der bislang noch nicht existiert, kann im Text eines bestehenden Artikels ein Link zu dem benötigten Artikel gesetzt werden. Wenn mindestens zwei Links zum selben Artikel vorhanden sind, wird dieser unter Gewünschte Seiten angezeigt. Dies ist auch die Quelle für Anregungen der vielen neuen Wiki-Autoren. Nicht alles dort ist wirklich notwendig oder sinnvoll. Welcher Artikel auserwählt werden soll, entscheiden Autoren durch das Fachwissen.


Elemente

Wenn Artikel geschrieben werden, gilt es sich zu vergewissern, dass folgende Regelungen einzuhalten sind.

Wiki markup

Soweit es möglich ist, sollte MediaWiki-Markup statt HTML tags zum Formatieren einer Seite genutzt werden. Dies erleichtert die Lesbarkeit des Quelltextes und ist einfacher zu editieren.

Informationen finden sich auf Wiki Reference card und im Quelltext 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}} oder {{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

Tabellen

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: Anzeigen einer Tabelle mit hervorgehobenem Text.
  • Wo: Überall

Vorlagen

Siehe Wiki Standard Vorlagen.


Siehe auch


Externe Links