Vorgabe für MediaWiki-Artikel bei xinux.net: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
| (18 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
| − | = | + | = 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 <pre> 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 | ||
| + | </pre> | ||
| − | + | == Konfigurationsdateien == | |
| + | * Konfigurationsdateien werden in <pre>-Blöcken dargestellt | ||
| + | * Inhalte bleiben unverändert und roh | ||
| + | * Keine Syntaxhervorhebung | ||
| − | + | Beispiel: | |
| − | + | <pre> | |
| − | + | key=value | |
| − | + | option=true | |
| − | + | </pre> | |
| − | |||
| − | |||
| − | + | == 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: | Beispiel: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
<pre> | <pre> | ||
| − | + | {| class="wikitable" | |
| − | + | |+ Titel der Tabelle | |
| + | ! Spalte 1 !! Spalte 2 !! Spalte 3 | ||
| + | |- | ||
| + | | Inhalt 1 || Inhalt 2 || Inhalt 3 | ||
| + | |- | ||
| + | | Inhalt 4 || Inhalt 5 || Inhalt 6 | ||
| + | |} | ||
</pre> | </pre> | ||
| − | + | === 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 | |
| − | |||
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