Aktuelle Version vom 17. März 2026, 05:42 Uhr

Xinux MediaWiki Format-Regeln

Grundprinzip

Der gesamte Inhalt wird im MediaWiki-Rohformat erstellt
Der komplette Artikel steht in einem einzigen Codeblock
Kein Text außerhalb des Codeblocks
Keine Verwendung von Markdown
Kein HTML außer
```
 für Dateiinhalte und Befehle
```

* Ziel ist eine 1:1 Kopierbarkeit in MediaWiki ohne Anpassungen == Überschriften == * Überschriften werden mit Gleichheitszeichen dargestellt * = Titel = * == Abschnitt == * === Unterabschnitt === == Listen == * Listen werden ausschließlich für beschreibende Inhalte verwendet * Jeder Listeneintrag beginnt mit * * Es werden keine anderen Listentypen verwendet == Befehle == * Befehle werden nicht als Liste dargestellt * Befehle stehen immer in einem <pre>-Block * Befehle werden exakt wie im Terminal geschrieben * Keine Prompt-Zeichen wie $ oder # Beispiel: <pre> apt update apt install nginx

Konfigurationsdateien

Konfigurationsdateien werden in
```
-Blöcken dargestellt
```
Inhalte bleiben unverändert und roh
Keine Syntaxhervorhebung

Beispiel: <pre> key=value option=true

Wichtige Regel

Der gesamte Artikel muss in einem einzigen Codeblock stehen
Es darf kein Text außerhalb existieren

Tabellen

Aufbau

Tabellen beginnen mit {|
Tabellen enden mit |}
Tabellen verwenden immer class="wikitable"

Beispiel:

{| class="wikitable"
|+ Titel der Tabelle
! Spalte 1 !! Spalte 2 !! Spalte 3
|-
| Inhalt 1 || Inhalt 2 || Inhalt 3
|-
| Inhalt 4 || Inhalt 5 || Inhalt 6
|}

= Erklärung

{| → Start der Tabelle
|} → Ende der Tabelle
|+ → Tabellenüberschrift
! → Kopfzeile
|- → Neue Zeile
| → Zelle
|| → nächste Zelle

Stilregeln

Immer class="wikitable" verwenden
Erste Zeile als Kopfzeile mit !
Inhalte kurz und präzise halten
Keine unnötigen Formatierungen

Ziel

Einheitliche, klare und reproduzierbare Dokumentation
Direkte Verwendbarkeit im xinux-Wiki ohne Nachbearbeitung

@@ Zeile 1: / Zeile 1: @@
-= Stilvorgabe für technische Anleitungen auf xinux.net =
+= Xinux MediaWiki Format-Regeln =
-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.
+== Grundprinzip ==
+* Der gesamte Inhalt wird im MediaWiki-Rohformat erstellt
+* Der komplette Artikel steht in einem einzigen Codeblock
+* Kein Text außerhalb des Codeblocks
+* Keine Verwendung von Markdown
+* Kein HTML außer <pre> für Dateiinhalte und Befehle
+* Ziel ist eine 1:1 Kopierbarkeit in MediaWiki ohne Anpassungen
-= Allgemeines Format =
+== Überschriften ==
+* Überschriften werden mit Gleichheitszeichen dargestellt
+* = Titel =
+* == Abschnitt ==
+* === Unterabschnitt ===
-Alle Inhalte werden vollständig als MediaWiki-Codeblock dargestellt.
+== Listen ==
-Der Artikel ist vollständig und eigenständig lesbar.
+* Listen werden ausschließlich für beschreibende Inhalte verwendet
-Kein Markdown, kein Prompt-Zeichen ($ oder #), keine Nummerierungen.
+* Jeder Listeneintrag beginnt mit *
+* Es werden keine anderen Listentypen verwendet
-= Überschriften =
+== Befehle ==
+* Befehle werden nicht als Liste dargestellt
+* Befehle stehen immer in einem <pre>-Block
+* Befehle werden exakt wie im Terminal geschrieben
+* Keine Prompt-Zeichen wie $ oder #
-Überschriften beginnen mit einem Gleichheitszeichen (=).
+Beispiel:
-Unterüberschriften dürfen mit mehr Gleichheitszeichen gegliedert werden.
+<pre>
-Keine Nummern oder Formatierungen in den Überschriften.
+apt update
+apt install nginx
+</pre>
-= Struktur =
+== Konfigurationsdateien ==
+* Konfigurationsdateien werden in <pre>-Blöcken dargestellt
-Text folgt direkt nach der Überschrift ohne Leerzeile.
+* Inhalte bleiben unverändert und roh
-Absätze werden nur durch Leerzeilen getrennt.
+* Keine Syntaxhervorhebung
-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
+<pre>
- Erstellt das Verzeichnis zur Ablage des Zertifikats
+key=value
+option=true
+</pre>
-= Konfigurationsdateien =
+== Wichtige Regel ==
+* Der gesamte Artikel muss in einem einzigen Codeblock stehen
+* Es darf kein Text außerhalb existieren
-Die Datei wird mit einem einleitenden Kommentar geöffnet:
+== Tabellen ==
-*vi /pfad/zur/datei
-Der Inhalt folgt in einem <pre>-Block:
+=== Aufbau ===
+* Tabellen beginnen mit {|
+* Tabellen enden mit |}
+* Tabellen verwenden immer class="wikitable"
+Beispiel:
 <pre>
-parameter_a = wert1
+{| class="wikitable"
-parameter_b = wert2
+|+ Titel der Tabelle
+! Spalte 1 !! Spalte 2 !! Spalte 3
+|-
+| Inhalt 1 || Inhalt 2 || Inhalt 3
+|-
+| Inhalt 4 || Inhalt 5 || Inhalt 6
+|}
 </pre>
-Innerhalb von <pre> keine Sternchen, keine Formatierung, nur Klartext.
+=== Erklärung ==
+* {| → Start der Tabelle
-= Ausgaben von Befehlen =
+* |} → Ende der Tabelle
+* |+ → Tabellenüberschrift
-Wenn relevante Befehle Ausgaben erzeugen, dürfen diese darunter eingerückt erscheinen:
+* ! → Kopfzeile
+* |- → Neue Zeile
-Beispiel:
+* | → Zelle
-*update-ca-certificates
+* || → nächste Zelle
- Updating certificates in /etc/ssl/certs...
-added, 0 removed; done.
-= Zielsetzung =
+=== Stilregeln ===
+* Immer class="wikitable" verwenden
+* Erste Zeile als Kopfzeile mit !
+* Inhalte kurz und präzise halten
+* Keine unnötigen Formatierungen
-Die Anleitung soll sofort umsetzbar sein, ohne Interpretation.
+== Ziel ==
-Alle Schritte werden vollständig angegeben.
+* Einheitliche, klare und reproduzierbare Dokumentation
-Der Fokus liegt auf Praxis, nicht auf Theorie.
+* Direkte Verwendbarkeit im xinux-Wiki ohne Nachbearbeitung
-Antworten folgen immer dieser Struktur und werden als kompletter Codeblock geliefert.

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