Ubuntu-Forum Wiki:Konventionen

Aus Ubuntu-Forum Wiki

Version vom 5. Januar 2011, 12:52 Uhr

1 Allgemeines

Dieser Artikel beschreibt die formalen Konventionen im Wiki des Ubuntu-Forum.de. Diese sind für das Verfassen eines Artikels verbindlich.

Durch ihre Einhaltung soll gewährleistet werden, dass:

• Artikel einen einheitlichen Aufbau haben. Das soll dem Leser den Umgang mit dem Wiki erleichtern.
• Artikel ein gewisses Niveau erreichen.
• Autoren einen allgemeingültigen Leitfaden bei der Arbeit haben. Dies soll auch ihnen beim Schreiben helfen.
• der Einstieg zur Wiki-Arbeit möglichst leicht gehalten wird.

2 Aktualität von Artikeln

Artikel sollen sich nach Möglichkeit auf die aktuelle LTS-Version beziehen. Diese hat einen längeren Lebenszyklus, welcher dem Wartungszyklus der Artikel entgegenkommt.

Die Änderungen, die neue Versionen mit sich bringen, können bei Bedarf in entsprechende Unterseiten (s.u.) ausgelagert und der Hauptartikel entsprechend ergänzt werden.

Artikel zu Entwicklerversionen sind, schon wegen der Natur der Sache, im Wiki fehl am Platz. Die Änderungen sind so schnelllebig, dass diese in den dafür vorgesehenen Foren-Bereichen besprochen werden sollen.

3 Grundsätzliche Regelungen

Die nachfolgenden Punkte gelten allgemein beim Verfassen eines Artikel:

1. Die Lesenden werden nicht direkt angeredet.
2. Anglizismen sollen möglichst vermieden werden. Es sollen, wo möglich, verständliche und gebräuchliche deutsche Begriffe verwendet werden.
3. Sätze sollen kurz, prägnant und verständlich verfasst werden.
4. Überwiegend technische Ausprägungen der Artikel und entsprechendes tiefgehendes Wissen soll auf entsprechende Themen oder weiterführende (Experten-) Artikel beschränkt werden.
5. Werden Programme als Mittel zum Zweck genutzt, sollen die Standard-Werkzeuge von Ubuntu im Artikel verwendet werden.

4 Technische Regelungen

Die eingesetzte MediaWiki-Software bedingt auch einige technische Vorgaben:

Längere Anweisungen in Code-Tags sollen manuell umgebrochen werden (ca. zwischen den Spalten 80-100) - an Stellen, wo es Sinn macht und die Anweisung etc. auch beim Kopieren erhalten bleibt. Bei Code-/Befehlsschnippseln sollte die jeweilige Syntax für einen Zeilenumbruch benutzt werden.

Allerdings gilt auch hier, dass die Funktion der eingestellten Texte erhalten bleibt. Im Zweifelsfall steht das Aussehen der Wiki-Seite der Funktion nach.

5 Neue Artikel

Neue Artikel erstellt man am einfachsten über den Link Neuer Artikel in der linken Navigationsleiste. Dieser führt auf eine Seite, die das Erstellen automatisiert. In das Textfeld gibt man einfach den Namen des neuen Artikels ein. Anschließend wird man auf eine Seite weitergeleitet, die direkt in der Baustelle angesiedelt ist. Die Seite enthält ebenfalls schon das rudimentäre Gerüst eines neuen Artikels.

Alternativ zur eben beschriebenen Vorgehensweise kann man auch den Namen des neuen Artikels in die Suchmaske eingeben. Existiert kein entsprechender Artikel, kann man über den angebotenen Link eine neue Seite erstellen.

Es ist außerdem möglich, einen neuen Artikel zu erstellen, indem man dessen Namen an das Ende des URLs setzt. z.B.:

http://wiki.ubuntu-forum.de/index.php/Baustelle/neuer_artikelname

Dabei darf der Zusatz Baustelle/ nicht vergessen werden, um die Wiki-Struktur einzuhalten.

6 Aktualisierung bestehender Artikel

Werden nicht unerhebliche Änderungen an einem Wiki-Artikel durchgeführt, soll dies auch in der Baustelle geschehen.

Diese Vorgehensweise garantiert, dass bereits fertiggestellte Artikel nicht als Bauruine enden. Die grundlegende Änderung eines Artikels kann durch verschiedene Umstände ins Stocken geraten. Dies soll jedoch nicht die Konsistenz des Wiki gefährden.

Daher ist für solche Fälle folgende Vorgehensweise erarbeitet worden:

1. Der Quell-Artikel wird mit der Vorlage {{Bearbeitung}} versehen. Parallel dazu kann das Wiki-Team über die Aktualisierung informiert werden. Es wird den Quell-Artikel für schreibende Zugriffe sperren.
2. Der Inhalt des ursprünglichen Artikels (=im Quellcode!) wird kopiert und in die Baustelle eingefügt. Dazu fügt man in der Adressleiste des Browser die Kennzeichnung Baustelle vor dem Artikelnamen ein: http://wiki.ubuntu-forum.de/index.php/artikelname wird zu http://wiki.ubuntu-forum.de/index.php/Baustelle/artikelname
3. Nach Abschluss der Änderungen entscheidet das Wiki-Team, je nach Umfang der Änderungen, aktuellen Begebenheiten, Wertigkeit des ursprünglichen Artikels, ob letzterer erhalten und ins Archiv verschoben oder durch die aktuellere Version überschrieben wird.

6.1 Unterseiten

Dort, wo es der Umfang von Artikeln notwendig macht, können und sollen zusammenhängende Themenbereiche in sogenannte Unterseiten ausgegliedert werden. Diese werden technisch und stilistisch durch einen Schrägsstrich (/) im Namen vom Hauptartikel getrennt:

Thema/Unterthema_1

Um nicht den Überblick über die Unterseiten eines Artikels (=Artikelserie) zu verlieren, sollen am Ende des Artikels und von dessen Unterseiten alle Artikel der Serie verlinkt werden. Damit dies Links nicht in jedem einzelnen Artikel gepflegt werden müssen, kommen an dieser Stelle Vorlagen zum Einsatz.

Deren Handhabung beschreibt der folgende Abschnitt.

6.2 Vorlagen für interne Verknüpfungen von Artikelserien

Eine Vorlage ist in diesem Zusammenhang eine Seite, die sämtliche Verknüpfungen einer Artikelserie beinhaltet. Dazu gehören sowohl interne Links als auch Verweise auf externe Quellen.

Sämtliche Vorlagen und so auch diese findet man unter dem Link Vorlagen. Zur einheitlichen Vergabe der Namen der jeweiligen Vorlage gilt folgendes:

Der Name setzt sich aus dem Wort links, gefolgt von einem Unterstrich _ und abgeschlossen vom Namen des Hauptartikels zusammen. Das Ganze stellt sich dann in etwas so dar: links_thema.

Beispielsweise lautet der Name der Serie zur Installation von Ubuntu links_installation. In der Vorlage selber werden die Verweise in ungeordneten Listen erstellt:

* Thema
* Thema/Unterseite1
* Thema/Unterseie2
* usw.

Werden auch externe Verweise angeführt, trennt man beide mit Überschriften der 3. Klasse:

=== Intern ===
* Thema
* Thema/Unterseite1
* Thema/Unterseie2
* usw.
 
=== Extern === 
* Projektseite
* Wikipedia
* sonstige wichtige Referenzen

Abgeschlossen wird die Vorlage dann mit der Kategorie, in der die Artikelserie abgelegt werden soll.

Die Überschrift == Links == ist dabei nicht Bestandteil der Vorlage, da diese unter Umständen auch an anderen Stellen eingebunden werden könnte, etwa auf reinen Übersichtsseiten.

Am Schluss der Vorlage wird die jeweilige Kategorie, in welche der Artikel integriert wird, durch das Wiki-Team gesetzt.

Eine vollständige Vorlage hat somit folgenden Aufbau:

=== Intern ===
* Thema
* Thema/Unterseite1
* Thema/Unterseie2
* usw.
 
=== Extern ===
* Projektseite
* Wikipedia
* sonstige wichtige Referenzen
 
[[Kategorie: _name_der_kategorie_]]

Einbinden einer Vorlage

Eingebunden werden die Vorlagen in die einzelnen Unterseiten wie folgt:

== Links == 
{{links_thema}}

Bei Bedarf können weitergehende Links, die sich lediglich auf den aktuellen Artikel beziehen, unterhalb der Vorlage eingepflegt werden.

7 Links

• Ubuntu-Forum Wiki: Regeln
• Ubuntu-Forum Wiki: Konventionen