Vorgabe für MediaWiki-Artikel bei xinux.net

Stilvorgabe für technische Anleitungen auf xinux.net

Diese Vorlage beschreibt den verbindlichen Stil für Anleitungen im MediaWiki von xinux.net.

Der Fokus liegt auf Klarheit, direkter Umsetzbarkeit und sauberen Strukturen ohne ablenkende Formatierungen.

Allgemeines Format

Alle Inhalte werden vollständig als MediaWiki-Codeblock dargestellt.

Der Artikel ist vollständig und eigenständig lesbar.

Kein Markdown, kein Prompt-Zeichen ($ oder #), keine Nummerierungen.

Überschriften

Überschriften beginnen mit einem Gleichheitszeichen (=). Unterüberschriften dürfen mit mehr Gleichheitszeichen gegliedert werden. Keine Nummern oder Formatierungen in den Überschriften.

Struktur

Text folgt direkt nach der Überschrift ohne Leerzeile. Absätze werden nur durch Leerzeilen getrennt. Kommentare oder Erklärungen stehen immer eingerückt unter den Befehlen.

Befehle

Befehle werden mit einem Stern (*) eingeleitet. Es folgen keine Hochkommas, keine Symbole, keine Einrahmungen. Kommentare oder Ausgaben können in der nächsten Zeile eingerückt stehen.

Beispiel:

• mkdir -p /etc/ssl/mail.int

Erstellt das Verzeichnis zur Ablage des Zertifikats

Konfigurationsdateien

Die Datei wird mit einem einleitenden Kommentar geöffnet:

• vi /pfad/zur/datei

Der Inhalt folgt in einem

-Block:

<nowiki>
<pre>
parameter_a = wert1
parameter_b = wert2

</nowiki>

Innerhalb von </owiki>

</nowiki> keine Sternchen, keine Formatierung, nur Klartext.

Ausgaben von Befehlen
Wenn relevante Befehle Ausgaben erzeugen, dürfen diese darunter eingerückt erscheinen:

Beispiel:
*update-ca-certificates
 Updating certificates in /etc/ssl/certs...
 1 added, 0 removed; done.

Zielsetzung
Die Anleitung soll sofort umsetzbar sein, ohne Interpretation.  
Alle Schritte werden vollständig angegeben.  
Der Fokus liegt auf Praxis, nicht auf Theorie.  
Antworten folgen immer dieser Struktur und werden als kompletter Codeblock geliefert.