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

Aus Xinux Wiki
Zur Navigation springen Zur Suche springen
 
(15 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
−
= Stilvorgabe für technische MediaWiki-Anleitungen auf xinux.net =
+
= Stilvorgabe für technische Anleitungen auf xinux.net =
  
−
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.
+
Diese Vorlage beschreibt den verbindlichen Stil für Anleitungen im MediaWiki von xinux.net.  
  
−
= Grundprinzipien =
+
Der Fokus liegt auf Klarheit, direkter Umsetzbarkeit und sauberen Strukturen ohne ablenkende Formatierungen.
  
−
;Alle Inhalte werden vollständig innerhalb eines MediaWiki-Codeblocks geliefert  
+
= Allgemeines Format =
−
;Die Formatierung folgt strikt dem MediaWiki-Syntaxstandard 
+
 
−
;Der Stil ist nüchtern, technisch, übersichtlich und ohne ablenkende Formatierungen gehalten
+
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 =
  
−
;Hauptüberschriften beginnen mit einem Gleichheitszeichen (=)   
+
Überschriften beginnen mit einem Gleichheitszeichen (=).  
−
;Unterüberschriften können mit mehreren Gleichheitszeichen erstellt werden (==, === usw.)  
+
Unterüberschriften dürfen mit mehr Gleichheitszeichen gegliedert werden.   
−
;Keine Nummerierung in Überschriften
+
Keine Nummern oder Formatierungen in den Überschriften.
−
;Jede Überschrift wird direkt darunter ohne Leerzeile fortgesetzt
 
  
−
= Aufzählungen und Befehle =
+
= Struktur =
  
−
;Jeder Befehl beginnt mit einem Stern (*), ohne zusätzliche Zeichen oder Erklärungen davor  
+
Text folgt direkt nach der Überschrift ohne Leerzeile. 
−
;Kommentare, Ausgaben oder Erklärungen können eingerückt in der nächsten Zeile folgen 
+
Absätze werden nur durch Leerzeilen getrennt. 
−
;Shell-Prompts (z. B. $, #) werden nicht verwendet 
+
Kommentare oder Erklärungen stehen immer eingerückt unter den Befehlen.
−
;Die drei einfachen Apostrophe (''') dienen ausschließlich der Formatierung von Befehlen in erklärendem Kontext – nicht innerhalb von <pre>-Blöcken
+
 
 +
= 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:
 
Beispiel:
−
*mkdir -p /etc/ssl/mail.int
+
;Erstellt das Verzeichnis zur Ablage des Zertifikats
−
*cp ca.crt /usr/local/share/ca-certificates/
+
*mkdir -p /etc/ssl/mail.int
  
 
= Konfigurationsdateien =
 
= Konfigurationsdateien =
  
−
;Wenn Konfigurationen ergänzt werden, beginnt die Anweisung mit:
+
Die Datei wird mit einem einleitenden Kommentar geöffnet:
 
*vi /pfad/zur/datei
 
*vi /pfad/zur/datei
−
;Darunter folgt ein <pre>-Block mit dem tatsächlichen Inhalt 
 
−
;Innerhalb von <pre> keine Sternchen, keine Hochkommas, kein Prompt – nur Klartext 
 
  
−
Beispiel:
+
Der Inhalt folgt in einem <nowiki><pre></nowiki>-Block:
−
*vi /etc/postfix/main.cf
+
 
−
<pre>
+
<nowiki><pre></nowiki>
−
smtpd_tls_cert_file = /etc/ssl/mail.int/server.crt
+
 
−
smtpd_tls_key_file = /etc/ssl/mail.int/server.key
+
parameter_a = wert1
−
</pre>
+
 
 +
parameter_b = wert2
 +
 
 +
<nowiki></pre></nowiki>
 +
 
 +
Innerhalb von <nowiki><pre></nowiki> keine Sternchen, keine Formatierung, nur Klartext.
  
−
= Systemausgaben =
+
= Ausgaben von Befehlen =
  
−
;Ausgaben von Befehlen (z. B. bei update-ca-certificates) können direkt unter dem Befehl angegeben werden 
+
Wenn relevante Befehle Ausgaben erzeugen, dürfen diese darunter eingerückt erscheinen:
−
;Sie werden nicht hervorgehoben, nur eingerückt als Plaintext 
 
  
 
Beispiel:
 
Beispiel:
Zeile 51: Zeile 61:
 
  1 added, 0 removed; done.
 
  1 added, 0 removed; done.
  
−
= Ziel =
+
= Zielsetzung =
 +
 
 +
Die Anleitung soll sofort umsetzbar sein, ohne Interpretation. 
 +
 
 +
Alle Schritte werden vollständig angegeben. 
 +
 
 +
Der Fokus liegt auf Praxis, nicht auf Theorie. 
  
−
;Der Stil dient der maximalen Klarheit, Kopierbarkeit und Praxistauglichkeit 
+
Antworten folgen immer dieser Struktur und werden als kompletter Codeblock geliefert.
−
;Er soll es ermöglichen, dass Leser die Schritte ohne jede Interpretation 1:1 umsetzen können 
 
−
;Alle Anleitungen sollen in sich geschlossen und vollständig sein 
 
−
;Jede Antwort zu einem Artikel wird ausschließlich in einem vollständigen Codeblock geliefert
 

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.

Abgerufen von „http://wiki.ixheim.de/index.php?title=Vorgabe_für_MediaWiki-Artikel_bei_xinux.net&oldid=61949“