Vorgabe für MediaWiki-Artikel bei xinux.net

Stilvorgabe für technische MediaWiki-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.

Grundprinzipien

Alle Inhalte werden vollständig innerhalb eines MediaWiki-Codeblocks geliefert

Die Formatierung folgt strikt dem MediaWiki-Syntaxstandard

Der Stil ist nüchtern, technisch, übersichtlich und ohne ablenkende Formatierungen gehalten

Überschriften

Hauptüberschriften beginnen mit einem Gleichheitszeichen (=)

Unterüberschriften können mit mehreren Gleichheitszeichen erstellt werden (==, === usw.)

Keine Nummerierung in Überschriften

Jede Überschrift wird direkt darunter ohne Leerzeile fortgesetzt

Aufzählungen und Befehle

Jeder Befehl beginnt mit einem Stern (*), ohne zusätzliche Zeichen oder Erklärungen davor

Kommentare, Ausgaben oder Erklärungen können eingerückt in der nächsten Zeile folgen

Shell-Prompts (z. B. $, #) werden nicht verwendet

Die drei einfachen Apostrophe () dienen ausschließlich der Formatierung von Befehlen in erklärendem Kontext – nicht innerhalb von

-Blöcken

Beispiel: *mkdir -p /etc/ssl/mail.int *cp ca.crt /usr/local/share/ca-certificates/ = Konfigurationsdateien = ;Wenn Konfigurationen ergänzt werden, beginnt die Anweisung mit: *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: *vi /etc/postfix/main.cf <pre> smtpd_tls_cert_file = /etc/ssl/mail.int/server.crt smtpd_tls_key_file = /etc/ssl/mail.int/server.key

Systemausgaben

Ausgaben von Befehlen (z. B. bei update-ca-certificates) können direkt unter dem Befehl angegeben werden

Sie werden nicht hervorgehoben, nur eingerückt als Plaintext

Beispiel:

• update-ca-certificates

Updating certificates in /etc/ssl/certs...
1 added, 0 removed; done.

Ziel

Der Stil dient der maximalen Klarheit, Kopierbarkeit und Praxistauglichkeit

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