Schnelleinstieg: Eine Quelltextdatei auf einer Seite anzeigen

Der kürzeste Weg von „Plugin ist installiert“ zu „eine Datei steht mit Syntaxhervorhebung und Zeilennummern auf einer Wiki-Seite“. Drei Schritte, etwa fünf Minuten.

• wksourceview ist installiert und im Erweiterungsmanager aktiviert.
• Sie dürfen die Datei lesen. Das Plugin prüft die Leseberechtigung bei jedem Aufruf: Was Sie im Medienmanager nicht öffnen können, rendert hier auch nicht.
• Sie dürfen eine Seite bearbeiten.

Öffnen Sie den Medienmanager (/doku.php?do=media), legen Sie den Namensraum dev an und laden Sie eine Quelltextdatei hoch, zum Beispiel beispiel.php.

Die Medien-Kennung lautet damit dev:beispiel.php.

Bearbeiten Sie eine Seite und schreiben Sie:

{{source>media:dev:beispiel.php}}

media: ist der Name der Quelle, die den Rest der Angabe auflöst. Eingebaut sind media: (Medienarchiv) und page: (Quelltext einer Wiki-Seite); git: und ado: kommen mit den Plugins wkdogit beziehungsweise wkdoadogit dazu.

Eine ganze Datei ist selten der Punkt. Hängen Sie einen Zeilenbereich an:

{{source>media:dev:beispiel.php#L10-L40}}

Ein Bereich über das Dateiende hinaus wird auf die letzte Zeile begrenzt — er liefert also den Rest und keinen Fehler.

• Der Block steht auf der Seite, hervorgehoben und nummeriert. Die Sprache wurde aus der Dateiendung erkannt.
• Die Überschrift des Blocks nennt die Datei und verweist auf sie.
• Jede Zeile trägt einen Anker: Klicken Sie eine Zeilennummer an und Sie erhalten eine Adresse, die genau auf diese Zeile zeigt.

Sehen Sie stattdessen einen kurzen Hinweis nicht verfügbar, einen Download-Verweis oder unhervorgehobenen Text, dann wurde die Datei gefunden, aber etwas hat die Darstellung als Quelltext abgelehnt — Ursachen und Abhilfen stehen auf der Paketseite.

• wksourceview — Referenz: die vollständige Grammatik einer Referenz, die Darstellungsarten inline, block, preview und drawer sowie die Grenzwerte max_bytes und max_lines.
• wkdoadogit — dieselbe Anzeige für Dateien aus einem Azure-DevOps-Repository.
• wkdogit — dasselbe für ein lokales Repository auf dem Server.