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

Aus Xinux Wiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „== Vorgabe für MediaWiki-Artikel bei xinux.de == Ein MediaWiki-Artikel muss immer als ein einziger, vollständiger Codeblock dargestellt werden. Es darf nie…“)
 
 
(23 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
== Vorgabe für MediaWiki-Artikel bei xinux.de ==
+
= Xinux MediaWiki Format-Regeln =
  
Ein MediaWiki-Artikel muss immer als ein einziger, vollständiger Codeblock dargestellt werden.
+
== 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
  
Es darf niemals Text oder Erklärung außerhalb des Codeblocks erscheinen. 
+
== Überschriften ==
Der gesamte Artikel – einschließlich Überschriften, Erklärungen, Befehlen, Dateiinhalten – gehört ausschließlich in diesen Block.
+
* Überschriften werden mit Gleichheitszeichen dargestellt
 +
* = Titel =
 +
* == Abschnitt ==
 +
* === Unterabschnitt ===
  
== Formatierung ==
+
== Listen ==
 +
* Listen werden ausschließlich für beschreibende Inhalte verwendet
 +
* Jeder Listeneintrag beginnt mit *
 +
* Es werden keine anderen Listentypen verwendet
  
* Keine Überschrift mit = ganz oben – der Titel wird vom Wiki gesetzt
+
== Befehle ==
* Unterüberschriften:
+
* Befehle werden nicht als Liste dargestellt
** == Ebene 1
+
* Befehle stehen immer in einem <pre>-Block
** === Ebene 2
+
* Befehle werden exakt wie im Terminal geschrieben
** ==== Ebene 3
+
* Keine Prompt-Zeichen wie $ oder #
  
== Erklärungen ==
+
Beispiel:
 +
<pre>
 +
apt update
 +
apt install nginx
 +
</pre>
  
* Einzeilige Erklärung: beginnt mit einem Semikolon (;)
+
== Konfigurationsdateien ==
* Mehrzeilige Erklärung: im normalen Textfluss, ohne Sternchen, mit Leerzeile vor dem nächsten Block
+
* Konfigurationsdateien werden in <pre>-Blöcken dargestellt
 +
* Inhalte bleiben unverändert und roh
 +
* Keine Syntaxhervorhebung
  
== Befehle ==
+
Beispiel:
 +
<pre>
 +
key=value
 +
option=true
 +
</pre>
  
* Jeder auszuführende Befehl beginnt mit einem *
+
== Wichtige Regel ==
* Befehle dürfen nicht mit Text vermischt werden
+
* Der gesamte Artikel muss in einem einzigen Codeblock stehen
* Kein <pre>, kein Markdown, keine Backquotes
+
* Es darf kein Text außerhalb existieren
  
== Inhalte von Dateien ==
+
== Tabellen ==
  
* Inhalte werden ohne Sternchen eingerückt
+
=== Aufbau ===
* Zwischen dem Befehl zum Öffnen (z. B. nano) und dem Inhalt steht eine Leerzeile
+
* Tabellen beginnen mit {|
* Nach dem Inhalt ebenfalls eine Leerzeile
+
* Tabellen enden mit |}
 +
* Tabellen verwenden immer class="wikitable"
  
== Listen ==
+
Beispiel:
 +
<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>
  
* Aufzählung: *
+
=== Erklärung ==
* Nummerierung: #
+
* {| → Start der Tabelle
* Verschachtelung durch Wiederholung: ** oder ## usw.
+
* |} → Ende der Tabelle
 +
* |+ → Tabellenüberschrift
 +
* ! → Kopfzeile
 +
* |- → Neue Zeile
 +
* | → Zelle
 +
* || → nächste Zelle
  
== Zusammenfassung ==
+
=== Stilregeln ===
 +
* Immer class="wikitable" verwenden
 +
* Erste Zeile als Kopfzeile mit !
 +
* Inhalte kurz und präzise halten
 +
* Keine unnötigen Formatierungen
  
Ein Artikel besteht ausschließlich aus einem einzigen Codeblock. 
+
== Ziel ==
Es gibt niemals Text außerhalb. 
+
* Einheitliche, klare und reproduzierbare Dokumentation
Alle Inhalte sind MediaWiki-kompatibel, ohne Markdown, ohne Formatierungsfehler. 
+
* Direkte Verwendbarkeit im xinux-Wiki ohne Nachbearbeitung
Der Stil ist einheitlich, maschinenlesbar und direkt übertragbar in das Wiki ohne Anpassung.
 

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