Konventionen

Aus de-musix-wiki

Wechseln zu: Navigation, Suche
Werken Werken: Diese Seite befindet sich noch im Aufbau.

Hier eine Sammlung an Dingen, an die man sich beim Schreiben von Artikeln halten sollte, um das Wiki übersichtlich und konsistent zu halten. Diese Konventionen gelten nicht für ein HowTo oder Erfahrungsberichte.

Wenn Du die Konventionen oder Vorlagen nicht direkt in Deinem Werkststatt-Artikel ausprobieren willst, kannst Du zum Testen die Übungsseite verwenden.

Inhaltsverzeichnis

Textformatierung

Überschriften

Man sollte sich Gedanken machen, mit welchen Überschriften man seinen Artikel versehen will. Überschriften sind wichtig, um den Artikel übersichtlich und leicht verständlich zu halten. In diesem Wiki haben die Überschriften (wie in jedem MediaWiki) eine klare Hierarchie, die durch die Anzahl an Gleichheitszeichen gesetzt ist. Je mehr Gleichheitszeichen, desto tiefer die Unterteilung.

Mehr zu diesem Thema findet man auf der entsprechenden Hilfeseite der Wikimedia.

Code im Text

Will man einen einzelnen Befehl (nicht Paket!) fließend im Text unterbringen, so sollte man den tag
<code></code>
verwenden. Die Syntax lautet:
<code>Befehl</code>

Dadurch kennzeichnet man den Befehl im Text durch eine andere, vordefinierte Schriftart, die sich vom normalen Text abhebt.

Beispiel:

Nun gehe man mittels <code>cd ~/tonstudio/src/build</code> in das Verzeichnis zum Kompilieren.

sieht dann so aus:

Nun gehe man mittels cd ~/tonstudio/src/build in das Verzeichnis zum Kompilieren.

Pfade & Reiter

Pfade und Reiter sollte man immer in Kursivschrift angeben. Will man z.B. erklären, wie man das Programm Qjackctl grafisch aufrufen kann, sieht das so aus:

Gnome-Menü -> Multimedia -> Jack Control

Kursivschrift erhält man im Text durch zwei
''
am Anfang und am Ende des Kursiv-Textes oder über markieren des Textes und klicken auf das schräge K oben über dem Eingabefeld.

Struktur der Artikel

Software

Wenn Du einen Artikel zum Thema Software schreibst, so sollte er folgendermaßen gegliedert sein:

  • Beschreibe die Software kurz & bündig ohne Überschrift
  • Inhaltsverzeichnis (ab 4 Überschriften automatisch generiert). Es wird über der ersten Überschrift automatisch eingefügt.
  • Nenne die wichtigsten Features des Programms. Liste diese in einer Liste auf, die Du mit Sternchen erstellst. Dies sollte die erste Überschrift sein, bitte mit zwei Gleichheitszeichen.
  • Installation (bitte zwei Gleichheitszeichen für diese Überschrift)
    • Füge hinter das Wort Installation immer ein kleines Logo des Betriebssystems ein, auf das sich die Installation bezieht. Wenn Du nur über eine einzige Plattform, z.B. Debian, schreibst, dann sieht das ungefähr so aus: Installation Datei:deb.png. Wenn Du über mehrere Plattformen schreibst, dann füge unter der Überschrift Installation (ohne Logo), weitere Unter-Überschriften (mit Logo: Installation Datei:win_12px.png) ein.
    • Bitte gebe immer die Versionsnummer der Software an.
  • wenn nötig: Konfiguration
    • Bitte mache auch hier immer eine Angabe zur Versionsnummer der Software.
  • Benutzung
    • bitte möglichst ohne Bildchen
    • unterscheide auch hier wieder die Versionsnummern der Software. Neuere Software kann manchmal eine komplett neue Obefläche oder neue Menüpunkte haben, von daher macht das sehr viel Sinn.
  • wenn möglich: Erfahrungsberichte
    • Bitte zu den Erfahrungsberichten hier im Musix-Wiki nur verlinken. Schreibe dann die Texte im Erfahrungsberichte-Bereich und nicht direkt in den Artikel. Findest Du einen Erfahrungsbericht oder HowTo zur Software im Netz, dann setze einen Link dort hin. Besser ist jedoch, den Text ins Musix-Wiki einzupflegen. Beachte dabei immer die Lizenzen und das Urheberrecht!
  • Links in der Form: Link, Linux/Windows/Mac-Logo (wenn es sich um Software handelt), Minuszeichen, Kurzbeschreibung des Links - wenn Link auf englisch, dann englische Flagge an die Kurzbeschreibung hängen.
    • Projektseite der Software
    • wenn möglich: Tutorials verlinken oder ins Musix-Wiki migrieren
    • wenn möglich: ähnliche Software wie die vorgestellte; auch ähnliche Software für ein anderes Betriebssystem wie Windows.

Weiterhin ist folgendes zu bedenken:

  • Die obersten Überschriften sollten immer zwei Gleichheitszeichen haben:
    • == Features ==
  • Weise bei Debian immer darauf hin, auf welche Debian-Distribution Du Dich sich beziehst (squeeze, wheezy, sid).

Hardware

Formate

Sounds

System

Persönliche Werkzeuge