WikiText Basics

WikiText-Grundlagen

Diese Seite zeigt die wichtigsten Grundlagen von WikiText. WikiText ist die Schreibweise, mit der Seiten in MediaWiki formatiert werden.

Ziel ist nicht, alles zu kennen. Für normale Dokumentation reichen meistens Überschriften, Listen, Links und einfache Formatierungen.

1. Überschriften

Überschriften strukturieren eine Seite.

== Hauptüberschrift ==
=== Unterüberschrift ===
==== Kleine Unterüberschrift ====

Beispiel:

== Zweck ==
=== Voraussetzungen ===
=== Vorgehen ===

Wichtig: Die Hauptüberschrift der Seite steht normalerweise schon im Seitentitel. Deshalb beginnt man im Inhalt meistens mit == Überschrift ==.

2. Absätze

Ein normaler Absatz wird einfach als Text geschrieben.

Dies ist ein normaler Absatz.

Dies ist ein zweiter Absatz.

Zwischen zwei Absätzen lässt man eine Leerzeile.

3. Fett und kursiv

Fett verwendet man für wichtige Begriffe.

'''Dieser Text ist fett.'''

Dieser Text ist fett.

Kursiv verwendet man eher selten.

''Dieser Text ist kursiv.''

Dieser Text ist kursiv.

Fett und kursiv zusammen:

'''''Dieser Text ist fett und kursiv.'''''

Dieser Text ist fett und kursiv.

Beispiel:

'''Wichtig:''' Passwörter dürfen nicht im Wiki dokumentiert werden.

4. Aufzählungen

Für einfache Listen verwendet man Sternchen.

* Erster Punkt
* Zweiter Punkt
* Dritter Punkt

• Erster Punkt
• Zweiter Punkt
• Dritter Punkt

---

Unterpunkte schreibt man mit mehreren Sternchen:

* Hauptpunkt
** Unterpunkt
** Noch ein Unterpunkt
* Nächster Hauptpunkt

• Hauptpunkt
  • Unterpunkt
  • Noch ein Unterpunkt
• Nächster Hauptpunkt

5. Nummerierte Listen

Für Schritt-für-Schritt-Anleitungen verwendet man Rautezeichen.

# Erster Schritt
# Zweiter Schritt
# Dritter Schritt

1. Erster Schritt
2. Zweiter Schritt
3. Dritter Schritt

---

Unterpunkte bei nummerierten Listen:

# Erster Schritt
## Unterpunkt zu Schritt eins
## Weiterer Unterpunkt
# Zweiter Schritt

1. Erster Schritt
   1. Unterpunkt zu Schritt eins
   2. Weiterer Unterpunkt
2. Zweiter Schritt

6. Interne Links

Interne Links führen auf andere Seiten im Wiki.

[[Name der Seite]]

Hauptseite

Wenn die Seite existiert, ist der Link normal sichtbar. Wenn sie noch nicht existiert, erscheint er meist rot. Über einen roten Link kann die neue Seite erstellt werden.

7. Interne Links mit anderem Text

Manchmal soll der sichtbare Text anders heißen als die Zielseite.

[[Name der Zielseite|sichtbarer Text]]

Beispiel:

Home

Angezeigt wird dann „VPN-Anleitung“, der Link führt aber zur Seite „VPN-Zugang einrichten“.

8. Links auf Abschnitte

Man kann direkt auf einen bestimmten Abschnitt einer Seite verlinken.

[[Name der Seite#Abschnittsname]]

WikiText_Basics#1._Überschriften

Mit anderem sichtbaren Text:

[[VPN-Zugang einrichten#Fehlerbehebung|Probleme mit VPN beheben]]

Überschriften

9. Externe Links

Externe Links führen auf Webseiten außerhalb des Wikis.

[https://example.com Linktext]

Beispiel:

[https://www.mediawiki.org MediaWiki-Dokumentation]

Wichtig:

Interner Link: [[Name der Seite]]
Externer Link: [https://example.com Linktext]

Interne Links haben doppelte eckige Klammern. Externe Links haben einfache eckige Klammern.

10. Code im Text

Kurze Befehle oder Dateinamen schreibt man mit <code>.

Der Befehl lautet <code>ipconfig /all</code>.

Beispiel:

Der Befehl lautet ipconfig /all.

11. Codeblöcke oder Beispiele

Für längere Befehle oder Beispiele verwendet man <pre>.

<pre>
sudo systemctl restart apache2
sudo systemctl status apache2
</pre>

Das sorgt dafür, dass der Text unverändert dargestellt wird.

12. Einrückungen

Mit einem Doppelpunkt kann man Text einrücken.

Normaler Text
: Eingerückter Text
:: Noch stärker eingerückter Text

Normaler Text

Eingerückter Text

Noch stärker eingerückter Text

Das wird oft für kurze Hinweise oder Antworten verwendet.

13. Definitionslisten

Für Problem-Lösung-Abschnitte sind Definitionslisten praktisch.

; Problem
: Lösung

; Benutzer kann sich nicht anmelden
: Prüfen, ob das Konto aktiv ist und die richtigen Rechte gesetzt sind.

Problem

Lösung

Benutzer kann sich nicht anmelden

Prüfen, ob das Konto aktiv ist und die richtigen Rechte gesetzt sind.

14. Kategorien

Kategorien helfen dabei, Seiten zu ordnen.

[[Kategorie:IT-Dokumentation]]

Kategorien stehen meistens ganz unten auf der Seite.

Beispiel:

[[Kategorie:Anleitungen]]
[[Kategorie:IT-Dokumentation]]

Wichtig: Eine Kategorie ist nicht einfach ein sichtbarer Link im Text. Sie ordnet die Seite einer Kategorie zu.

Wenn man sichtbar auf eine Kategorie verlinken will, schreibt man einen Doppelpunkt davor:

[[:Kategorie:IT-Dokumentation|Alle IT-Dokumentationsseiten]]

15. Inhaltsverzeichnis

MediaWiki erstellt automatisch ein Inhaltsverzeichnis, wenn eine Seite mehrere Überschriften hat.

Wenn man ein Inhaltsverzeichnis erzwingen möchte:

__TOC__

Wenn man kein Inhaltsverzeichnis anzeigen möchte:

__NOTOC__

Für normale Seiten muss man das meistens nicht verwenden.

16. Kommentare im WikiText

Kommentare sind im Bearbeitungsmodus sichtbar, aber nicht auf der fertigen Seite.

<!-- Dieser Hinweis ist nur im WikiText sichtbar. -->

Beispiel:

<!-- Diesen Abschnitt bitte nach dem nächsten Serverwechsel aktualisieren. -->

17. Einfache Seitenvorlage für Dokumentation

Diese Vorlage kann für neue interne Doku-Seiten verwendet werden.

== Zweck ==
Kurze Erklärung, wofür diese Seite da ist.

== Voraussetzungen ==
* Voraussetzung 1
* Voraussetzung 2
* Voraussetzung 3

== Vorgehen ==
# Erster Schritt
# Zweiter Schritt
# Dritter Schritt

== Häufige Probleme ==

; Problem 1
: Lösung oder Hinweis.

; Problem 2
: Lösung oder Hinweis.

== Siehe auch ==
* [[Verwandte Seite 1]]
* [[Verwandte Seite 2]]

[[Kategorie:IT-Dokumentation]]

18. Gute Regeln für WikiText

• Verwende klare Überschriften.
• Schreibe Arbeitsschritte als nummerierte Liste.
• Verwende interne Links auf passende Seiten.
• Schreibe keine langen unstrukturierten Textblöcke.
• Dokumentiere keine Passwörter, Tokens oder geheimen Zugangsdaten.
• Nutze Kategorien oder Übersichtsseiten, damit Inhalte auffindbar bleiben.
• Speichere Änderungen mit einer kurzen Zusammenfassung.

19. Häufige Fehler

Falsch:

[VPN-Zugang einrichten]

Richtig:

[[VPN-Zugang einrichten]]

Falsch:

[[https://example.com]]

Richtig:

[https://example.com Linktext]

Falsch:

[[sichtbarer Text|Name der Zielseite]]

Richtig:

[[Name der Zielseite|sichtbarer Text]]

20. Kurzfassung

Die wichtigsten WikiText-Zeichen:

== Überschrift ==

'''fett'''
''kursiv''

* Aufzählung
# Nummerierte Liste

[[Interne Seite]]
[[Interne Seite|sichtbarer Text]]

[https://example.com externer Link]

<code>kurzer Befehl</code>

<pre>
längerer Codeblock