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 MediaWiki-Anleitungen auf xinux.net =
+= Xinux MediaWiki Format-Regeln =
-Diese Vorgabe beschreibt den gewünschten Formatierungsstil für alle technischen Anleitungen im Wiki xinux.net. Sie dient als verbindliche Grundlage für die Ausgabe von Konfigurationsanleitungen, insbesondere im Bereich Linux-Server, Netzwerkinfrastruktur und Security.
+== 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
-= Grundprinzipien =
+== Überschriften ==
+* Überschriften werden mit Gleichheitszeichen dargestellt
+* = Titel =
+* == Abschnitt ==
+* === Unterabschnitt ===
-;Alle Inhalte werden vollständig innerhalb eines MediaWiki-Codeblocks geliefert
+== Listen ==
-;Die Formatierung folgt strikt dem MediaWiki-Syntaxstandard
+* Listen werden ausschließlich für beschreibende Inhalte verwendet
-;Der Stil ist nüchtern, technisch, übersichtlich und ohne ablenkende Formatierungen gehalten
+* 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 #
-;Hauptüberschriften beginnen mit einem Gleichheitszeichen (=)
+Beispiel:
-;Unterüberschriften können mit mehreren Gleichheitszeichen erstellt werden (==, === usw.)
+<pre>
-;Keine Nummerierung in Überschriften
+apt update
-;Jede Überschrift wird direkt darunter ohne Leerzeile fortgesetzt
+apt install nginx
+</pre>
-= Aufzählungen und Befehle =
+== Konfigurationsdateien ==
+* Konfigurationsdateien werden in <pre>-Blöcken dargestellt
+* Inhalte bleiben unverändert und roh
+* Keine Syntaxhervorhebung
-;Jeder Befehl beginnt mit einem Stern (*), ohne zusätzliche Zeichen oder Erklärungen davor
+Beispiel:
-;Kommentare, Ausgaben oder Erklärungen können eingerückt in der nächsten Zeile folgen
+<pre>
-;Shell-Prompts (z. B. $, #) werden nicht verwendet
+key=value
-;Die drei einfachen Apostrophe (''') dienen ausschließlich der Formatierung von Befehlen in erklärendem Kontext – nicht innerhalb von <pre>-Blöcken
+option=true
+</pre>
-Beispiel:
+== Wichtige Regel ==
-*mkdir -p /etc/ssl/mail.int
+* Der gesamte Artikel muss in einem einzigen Codeblock stehen
-*cp ca.crt /usr/local/share/ca-certificates/
+* Es darf kein Text außerhalb existieren
-= Konfigurationsdateien =
+== Tabellen ==
-;Wenn Konfigurationen ergänzt werden, beginnt die Anweisung mit:
+=== Aufbau ===
-*vi /pfad/zur/datei
+* Tabellen beginnen mit {|
-;Darunter folgt ein <pre>-Block mit dem tatsächlichen Inhalt
+* Tabellen enden mit |}
-;Innerhalb von <pre> keine Sternchen, keine Hochkommas, kein Prompt – nur Klartext
+* Tabellen verwenden immer class="wikitable"
 Beispiel:
-*vi /etc/postfix/main.cf
 <pre>
-smtpd_tls_cert_file = /etc/ssl/mail.int/server.crt
+{| class="wikitable"
-smtpd_tls_key_file = /etc/ssl/mail.int/server.key
+|+ Titel der Tabelle
+! Spalte 1 !! Spalte 2 !! Spalte 3
+|-
+| Inhalt 1 || Inhalt 2 || Inhalt 3
+|-
+| Inhalt 4 || Inhalt 5 || Inhalt 6
+|}
 </pre>
-= Systemausgaben =
+=== Erklärung ==
+* {| → Start der Tabelle
-;Ausgaben von Befehlen (z. B. bei update-ca-certificates) können direkt unter dem Befehl angegeben werden
+* |} → Ende der Tabelle
-;Sie werden nicht hervorgehoben, nur eingerückt als Plaintext
+* |+ → Tabellenüberschrift
+* ! → Kopfzeile
-Beispiel:
+* |- → Neue Zeile
-*update-ca-certificates
+* | → Zelle
- Updating certificates in /etc/ssl/certs...
+* || → nächste Zelle
-added, 0 removed; done.
-= Ziel =
+=== Stilregeln ===
+* Immer class="wikitable" verwenden
+* Erste Zeile als Kopfzeile mit !
+* Inhalte kurz und präzise halten
+* Keine unnötigen Formatierungen
-;Der Stil dient der maximalen Klarheit, Kopierbarkeit und Praxistauglichkeit
+== Ziel ==
-;Er soll es ermöglichen, dass Leser die Schritte ohne jede Interpretation 1:1 umsetzen können
+* Einheitliche, klare und reproduzierbare Dokumentation
-;Alle Anleitungen sollen in sich geschlossen und vollständig sein
+* Direkte Verwendbarkeit im xinux-Wiki ohne Nachbearbeitung
-;Jede Antwort zu einem Artikel wird ausschließlich in einem vollständigen Codeblock geliefert

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