Aktuelle Version vom 18. April 2025, 08:44 Uhr

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:

Erstellt das Verzeichnis zur Ablage des Zertifikats

mkdir -p /etc/ssl/mail.int

Konfigurationsdateien

Die Datei wird mit einem einleitenden Kommentar geöffnet:

vi /pfad/zur/datei

Der Inhalt folgt in einem <pre>-Block:

<pre>

parameter_a = wert1

parameter_b = wert2

</pre>

Innerhalb von <pre> 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.

@@ Zeile 1: / Zeile 1: @@
-== Vorgabe für MediaWiki-Artikel bei xinux.de ==
+= Stilvorgabe für technische Anleitungen auf xinux.net =
-Ein MediaWiki-Artikel muss immer als ein einziger, vollständiger Codeblock dargestellt werden.
+Diese Vorlage beschreibt den verbindlichen Stil für Anleitungen im MediaWiki von xinux.net.
-Es darf niemals Text oder Erklärung außerhalb des Codeblocks erscheinen.
+Der Fokus liegt auf Klarheit, direkter Umsetzbarkeit und sauberen Strukturen ohne ablenkende Formatierungen.
-Der gesamte Artikel – einschließlich Überschriften, Erklärungen, Befehlen, Dateiinhalten – gehört ausschließlich in diesen Block.
-== Formatierung ==
+= Allgemeines Format =
-* Keine Überschrift mit = ganz oben – der Titel wird vom Wiki gesetzt
+Alle Inhalte werden vollständig als MediaWiki-Codeblock dargestellt.
-* Unterüberschriften:
-** == Ebene 1
-** === Ebene 2
-** ==== Ebene 3
-== Erklärungen ==
+Der Artikel ist vollständig und eigenständig lesbar.
-* Einzeilige Erklärung: beginnt mit einem Semikolon (;)
+Kein Markdown, kein Prompt-Zeichen ($ oder #), keine Nummerierungen.
-* Mehrzeilige Erklärung: im normalen Textfluss, ohne Sternchen, mit Leerzeile vor dem nächsten Block
-== Befehle ==
+= Überschriften =
-* Jeder auszuführende Befehl beginnt mit einem *
+Überschriften beginnen mit einem Gleichheitszeichen (=).
-* Befehle dürfen nicht mit Text vermischt werden
+Unterüberschriften dürfen mit mehr Gleichheitszeichen gegliedert werden.
-* Kein <pre>, kein Markdown, keine Backquotes
+Keine Nummern oder Formatierungen in den Überschriften.
-== Inhalte von Dateien ==
+= Struktur =
-* Inhalte werden ohne Sternchen eingerückt
+Text folgt direkt nach der Überschrift ohne Leerzeile.
-* Zwischen dem Befehl zum Öffnen (z. B. nano) und dem Inhalt steht eine Leerzeile
+Absätze werden nur durch Leerzeilen getrennt.
-* Nach dem Inhalt ebenfalls eine Leerzeile
+Kommentare oder Erklärungen stehen immer eingerückt unter den Befehlen.
-== Listen ==
+= Befehle =
-* Aufzählung: *
+Befehle werden mit einem Stern (*) eingeleitet.
-* Nummerierung: #
+Es folgen keine Hochkommas, keine Symbole, keine Einrahmungen.
-* Verschachtelung durch Wiederholung: ** oder ## usw.
+Kommentare oder Ausgaben können in der nächsten Zeile eingerückt stehen.
-== Zusammenfassung ==
+Beispiel:
+;Erstellt das Verzeichnis zur Ablage des Zertifikats
+*mkdir -p /etc/ssl/mail.int
-Ein Artikel besteht ausschließlich aus einem einzigen Codeblock.
+= Konfigurationsdateien =
-Es gibt niemals Text außerhalb.
-Alle Inhalte sind MediaWiki-kompatibel, ohne Markdown, ohne Formatierungsfehler.
+Die Datei wird mit einem einleitenden Kommentar geöffnet:
-Der Stil ist einheitlich, maschinenlesbar und direkt übertragbar in das Wiki ohne Anpassung.
+*vi /pfad/zur/datei
+Der Inhalt folgt in einem <nowiki><pre></nowiki>-Block:
+<nowiki><pre></nowiki>
+parameter_a = wert1
+parameter_b = wert2
+<nowiki></pre></nowiki>
+Innerhalb von <nowiki><pre></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...
+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.

Vorgabe für MediaWiki-Artikel bei xinux.net: Unterschied zwischen den Versionen