Hilfe:SDB-Howto Leitfaden
Inhaltsverzeichnis
Anliegen
Dieser SDB (Support DatenBank) Artikel soll erklären, wie SDB Artikel geschrieben werden.
Vorgehen
SDB Artikel wurden gemacht, um Lösungen für Probleme zu geben, aber auch um bestimmte Themengebiete weiter zu erklären. Die SDB sollte immer die erste Anlaufstelle bei Problemen mit SUSE Linux sein.
Ein SDB Artikel sollte in folgende Abschnitte aufgeteilt werden:
- Anliegen
- Vorgehen
- Linkliste
oder
- Problem
- Ursache
- Lösung
- Linkliste
Bitte beachten Sie, dass SDB-Artikel - wenn möglich - immer den einfachsten Weg beschreiben sollten. Es ist aber durchaus möglich und gewünscht, auch den schnellen Weg über die Kommandozeile bzw. das Editieren von Konfigurationsdateien zu zeigen. Der Absatz "Lösung" sollte dann in mehrere Abschnitte unterteilt werden. Bevor auf die Syntax weiter eingegangen wird, hier ein Beispiel (in der Mediawiki Syntax, um dieses Beispiel als Artikel zu sehen, schauen Sie bitte hier SDB:NTP Server umstellen - SDB Beispiel.)
Beispiel Artikel
<!-- SDB information SDB:title: NTP Server umstellen - SDB Beispiel SDB:author: mlasars SDB:date: 2005-10-17 --> Version: 9.0 [[Category:SDB:Network|N]] [[Category:SDB:9.0|N]] Dieser Artikel ist ein Beispiel für SDB-Artikel. == Anliegen == Sie möchten ihre Zeit über ntp einstellen, aber der Server, den Sie vorher benutzt haben, funktioniert nicht mehr. == Vorgehen == Der Artikel beschreibt mehrere Lösungswege: === mit YaST2 === Starten Sie YaST2 und rufen Sie unter "Netzwerkdienste" das Modul "NTP-Client" auf. Unter "Wählen" wählen Sie "Öffentlicher Server" aus. Aus der Liste wählen Sie ihr Land oder das, welches am nächsten ist, sowie im zweiten Feld einen anderen Server. Klicken Sie danach auf "Test" - und wenn dieser erfolgreich verlaufen ist schließlich auf "Ok". Schließen Sie die Konfiguration mit "Beenden" ab. === mit der Kommandozeile === Öffnen Sie die Datei <code>/etc/sysconfig/ntp</code> und ändern Sie die Variable <code>NTPD_INITIAL_NTPDATE=""</code> mit dem Server ihrer Wahl. Starten Sie danach ntp mit rcntpd restart neu. == Links == [[SDB:Zeit_über_das_Netz_einstellen_lassen]] <keyword>ntp,xntp,zeit,synchronisieren</keyword> [[en:SDB:ntp_server_change(example)]]
Anlegen eines neuen Artikels
Geben Sie in der Adresszeile des Browsers nach dewiki.opensuse.org/SDB: die Überschrift des neuen Artikels ein. Sollte der Artikel noch nicht vorhanden sein gehen Sie auf "Erstellen", um den Artikel zu erstellen. Bitte überschreiben Sie keine vorhandenen Artikel. Fügen Sie ggf. eine Versionsnummer oder "(neu)" am Ende des Titels an.
Alle SDB-Artikel fangen grundsätzlich mit SDB: an, dies erleichtert eine spätere Suche und stellt einen eigenen Bereich im Wiki dar.
Wenn Sie einen neuen Artikel anlegen, können Sie auch die SDB-Artikel Vorlage benutzten. Dazu öffnen Sie die SDB Seite (dewiki.opensuse.org/SDB:Seitenname), wenn diese Seite noch nicht erstellt wurde, gehen Sie auf "Erstellen", hier können Sie jetzt aus dem Drop-Down Menü die SDB-Vorlage auswählen, klicken Sie dann auf laden. Jetzt können Sie im Bearbeitungsfeld die Vorlage nutzten um Ihren SDB Eintrag noch schneller zu schreiben, da Sie die Struktur ja schon haben.
Abschluss
History/Geschichte
Nach beenden des Artikels fügen Sie diesen bitte zur SDB:History hinzu. Die Syntax ist folgende:
YYYYMMDD [[SDB:<Artikelname>]]
also z.B.:
20051016 [[SDB:Howto]]
Bitte benutzen Sie das Internationale Datumsformat, die Liste ist absteigend, d.h. die neuesten Artikel stehen immer am Anfang der Liste.
Bei grundlegenden Änderungen am Artikel, z.B. das anpassen an eine neue Version, fügen Sie dies bitte auch in die History ein. Kleinere Änderungen oder Erweiterungen sollten nicht in die History eingefügt werden.
Übersetzungen
Derzeit unterstützt das openSUSE-Wiki Englisch, Deutsch, Französisch und Spanisch. Wenn Sie möchten und können, übersetzen Sie bitte den Artikel in andere Sprachen. Wenn Sie dies nicht können, oder es sich nicht zutrauen, schreiben Sie eine E-Mail an die Mailingliste opensuse-wiki@suse.de mit der Bitte, dass jemand diesen Artikel bitte übersetzen möchte.
Sollten Sie einen Artikel übersetzt haben, fügen Sie bitte die "Interwiki"-Links am Ende des Artikels ein. Sie haben z.B. einen Artikel von Deutsch in Englisch übersetzt, so fügen Sie am Ende des deutschen Artikels ein:
[[en:SDB:<Artikelname>]]
Und in den englischen:
[[de:SDB:<Artikelname>]]
Derzeit werden folgende Kürzel unterstützt:
de Deutsch en Englisch fr Französisch es Spanisch
Verändern von bestehenden Artikeln
Durch die Integration der SDB in das openSUSE-Wiki ist es möglich, alle Artikel zu editieren. Bei größeren Änderungen ist es evtl. ratsam dies zuerst mit den Originalautoren abzusprechen. Benutzen Sie dazu den "Diskussion"-Link, der am Anfang des Artikels angezeigt wird. Dies ist aber keine Pflicht, macht aber das Zusammenarbeiten angenehmer. Sollte es zu keiner Einigung kommen, kann eine E-Mail auf der "opensuse-wiki"-Mailingliste dies evtl. klären.
Kleinere Änderungen sollten direkt eingepflegt werden.
SDB tags
Table of Contents (Inhaltsverzeichnis)
Sobald drei oder mehr Sektionen mit === Sektion === im Artikel vorhanden sind, wird automatisch ein Inhaltsverzeichnis angezeigt. Bei verwenden der klassischen SDB-Artikel-Teilung "Anliegen, Vorgehen, Links" geschieht dies also automatisch.
SDB Metainformation
Bitte Fügen sie in die ersten Zeilen des neuen Artikels Metainformationen ein, diese werden nicht angezeigt.
<!-- SDB information SDB:title: NTP Server umstellen - SDB Beispiel SDB:author: mlasars SDB:date: 2005-10-17 -->
Sollten größere Änderungen gemacht werden, fügen Sie ihren Usernamen, durch Komma getrennt, an die Zeile Autor an. Die restlichen Daten, insbesondere SDB:date:, sollten nicht bei Änderungen verändert werden. Änderungen am Artikel können über die Historie des Artikels angesehen werden. Die Metainformationen sollen helfen, bei einer Umstellung des Systems die wichtigsten Daten direkt im Artikel zu haben.
Version
Am Anfang des Artikels sollte die Version bestimmt werden, für die der Artikel gilt. Es gibt mehrere Möglichkeiten:
Version: 8.0 Version: - 8.0 Version: 8.0 - Version: 8.0 - 8.1
Gilt der Artikel für keine bestimmte Version, lassen Sie das Versions-Tag einfach weg. Gilt der Artikel nur für eine bestimmte Architektur, oder eine Bestimmte Version, fügen Sie diese bitte ein, z.B.:
Version: 9.2 x86_64 Version: 9.1 DVD Version: 10.0 ppc
Derzeit unterstützt SUSE Linux folgende Architekturen: i386, x86_64 (64bit, AMD64 und Intel EM64T) sowie ppc (PowerPC (Mac)).
Bei den Versionen kann zusätzlich unterschieden werden zwischen:Box, FTP, CD, DVD und OSS.
Die Erweiterung sollte aber nur benutzt werden, wenn das Problem wirklich nur mit dieser Version auftritt.
Damit ein Rahmen um die Version gezeichnet wird, bitte immer mit einem Leerzeichen beginnen.
Kategorien
Jeder SDB Artikel sollte über die Kategorien auffindbar sein. Eine Übersicht der verfügbaren Kategorien finden Sie unter Kategorie:SDB. Fügen Sie die Kategorien am Anfang des Artikels ein:
[[Category:SDB:8.0|N]] [[Category:SDB:Network|N]]
Hinter der Kategorie wird ein pipe-Zeichen benutzt und danach kommt der erste Buchstabe des Titels. Im Beispiel heißt der Artikel "NTP Server ändern", also kommt ein "N" nach dem pipe-Zeichen.
Keywords (Stichwörter)
Fügen Sie am Ende des Artikels die Stichwörter ein, über die der Artikel mit der Stichwortsuche gefunden werden soll:
<keyword>ntp,zeit,xntp,synchronisation</keyword>
Die Stichworte können frei gewählt werden.
Syntax
MediaWiki unterstützt neben der Wiki-Syntax auch direkte HTML-Tags. Wenn möglich verwenden Sie bitte die Wiki-markups, dass die Artikel übersichtlicher bleiben. Hier werden nur kurz die wichtigsten Elemente gezeigt, eine ausführliche Anleitung finden Sie unter http://de.wikipedia.org/wiki/Wikipedia:Seite_bearbeiten.
Unterteilungen (Sektionen)
- Level 1: == Top Level Überschrift == (für Anliegen, Lösung, Links)
- Level 2: === Unter Überschrift === (z.B. für YaST2, Kommandozeile)
- Level 3: ==== einen Level tiefer ==== (weitere Unterteilungen, z.B. versch. Versionen)
Anliegen und Vorgehen sollten immer mit Top-Level gemacht werden, weitere Unterteilungen einen Level tiefer usw.
Formatierung
Sie brauchen Textblöcke nicht wie in HTML mit <p>Textblock</p> markieren, das geschieht automatisch. Absätze werden durch zwei leere Zeilen voneinander getrennt.
| Wiki Markup | Darstellung |
Dies ist der erste Absatz, der auch über mehrere Zeilen geschrieben werden kann. Dies ist der Zweite Absatz. |
Dies ist der erste Absatz, der auch über mehrere Zeilen geschrieben werden kann.
|
Text (bold, italic, code)
Um Abschnitte oder Wörter hervorzuheben, benutzen Sie bitte die folgende Syntax:
| Stil | Wiki Markup | Darstellung |
| bold | '''Bitte sparsam und nur für wichtige Abschnitte/Wörter benutzen''' | Bitte sparsam und nur für wichtige Abschnitte/Wörter benutzen |
| italic | ''Beispiel für Schrägeschritft'' | Beispiel für Schrägeschritft |
| code | für Befehle oder Variablen verwenden Sie: <code>rcapache2</code> | für Befehle oder Variablen verwenden Sie: rcapache2
|
Aufzählungen/Listen
Beispiele für Aufzählungen:
| Wiki-markup | Darstellung |
* Planeten ** Mars ** Erde *** Mond |
|
#Reisen ## Flugzeug ## Auto ### Taxi |
|
Benutzen Sie für Linklisten am Ende des Artikels bitte * Link ohne weitere Unterteilung.
Befehle, Auszüge
Einzelne Befehle sollten ein Leerzeichen am Anfang der Zeile haben
rcapache2 restart
um diesen hervorzuheben. Befehle im Text selbst sollten <code>Befehl</code> benutzen.
Bei Listings/Dateien benutzen Sie folgende Syntax:
| Wiki-markup | Darstellung |
<pre> ## Path: Network/Remote access/SSH ## Description: SSH server settings ## Type: string ## Default: "" ## ServiceRestart: sshd # # Options for sshd # SSHD_OPTS="" <nowiki></nowiki> </pre> |
## Path: Network/Remote access/SSH ## Description: SSH server settings ## Type: string ## Default: "" ## ServiceRestart: sshd # # Options for sshd # SSHD_OPTS="" |
nowiki
Unter Umständen muß die Wiki-markup-Syntax abgeschaltet werden:
| Wiki-markup | Darstellung | ohne nowiki |
|
<nowiki>nicht '''Bold''', kein ''Italic''</nowiki> |
nicht '''Bold''', kein ''Italic'' |
nicht Bold, kein Italic |
Links
Links auf andere SDB-Artikel starten mit SDB: [[SDB:howto]], eine weitere Linkbeschreibung ist nicht nötig. Es ist auch möglich, an bestimmte Stellen zu springen, z.B.: [[SDB:Howto]], dargestellt als SDB:howto#Stil. Bei SDB Links mit direktem Sprung ist oft eine Linkbeschreibung nützlich: [[SDB:Howto|Stil]] wird zu Stil.
Externe Links sollten eine Linkbeschreibung haben, wenn nicht ersichtlich ist, was sich dahinter verbirgt, oder um den Link kürzer zu machen:
[http://www.suse.de SUSE] wird dargestellt als SUSE, Link und Beschreibung werden einfach durch ein Leerzeichen getrennt.
Beachten Sie bitte, dass externe Links in einigen Ländern evtl. ein Verstoß gegen rechtliche Bestimmungen darstellen können. Verlinken auf Software, die Kopierschutztechniken umgeht, ist z.B. in Deutschland nicht erlaubt. Wenn Sie sich nicht sicher sind, ob ein bestimmter Link benutzt werden darf, fragen Sie auf der Mailingliste opensuse-wiki (siehe Kommunikation) nach.
Tabellen
Siehe http://de.wikipedia.org/wiki/Hilfe:Tabellen
Bilder
Bisher waren die SDB Artikel ohne Bilder. Um das Layout und den Lesefluß nicht zu sehr zu stören, sollten diese sparsam eingesetzt werden, vorzugsweise am rechten Rand in einer Vorschau. Mehr Informationen zum Upload finden Sie unter http://de.wikipedia.org/wiki/Wikipedia:Bilder
Stil
Anrede
Deutsche SDB-Artikel sollten den Benutzer grundätzlich mit "Sie" anreden. So sind die deutschen nun einmal :-)
Fremdwörter
Es ist schwer, auf Fremdwörter im technischen Bereichen zu verzichten, versuchen Sie es aber. Versuchen Sie aber nicht krampfhaft nach Übersetzungen zu suchen. Ein guter Mittelweg ist es, beides zu benutzen, z.B.: "gehen Sie auf die zweite console (Kommandozeile) mit STRG-ALT-F2"
Easy!
Auch wenn der Weg über die shell manchmal, und gerade für Sie, einfacher erscheint, versuchen Sie bitte auch an die Anfänger zu denken und wenn möglich auch den Weg mit YaST2 oder anderen Tools zu beschreiben.
Ein guter SDB Artikel sollte wirklich jeden Schritt erklären, z.B. nicht:
Ändern Sie in /etc/inittab den default runlevel auf 3.
sondern:
Loggen Sie sich als Benutzer root ein, öffnen Sie die Datei /etc/inittab mit einen Editor ihrer Wahl (z.B. vi oder pico) und ändern Sie die Zeile id:5:initdefault: auf id:3:initdefault:, damit der Rechner nicht mehr in die grafische Oberfläche startet.
Dies soll allerdings keine Vorschrift sein! Aber bitte denken Sie daran, dass auch viele Einsteiger SUSE benutzen.
Pflege
Oft ist es notwendig, SDB Artikel auf neuere Versionen anzupassen, oder gar neue zu schreiben, wenn die Änderungen zu groß sind. Versuchen Sie bitte ihre SDB-Artikel zu pflegen. Wenn Sie z.B. merken, dass ihr Artikel nicht mehr mit der neuesten Version SUSE Linux funktioniert, ändern Sie die Versionszeile.
