Schnelleinstieg: Ein Snippet anlegen und einbinden

Der kürzeste Weg von „Plugin ist installiert“ zu „dasselbe Snippet steht auf zwei Seiten und wird an einer Stelle gepflegt“. Drei Schritte, etwa fünf Minuten.

Voraussetzungen

wksnippet ist installiert und im Erweiterungsmanager aktiviert.
Sie sind als Superuser angemeldet – der Bearbeitungsbildschirm ist Administratoren vorbehalten.
Der Datenordner des Wikis ist beschreibbar. Das Snippet wird als Datei unter <savedir>/wksnippet/ abgelegt, nicht im Plugin-Ordner; deshalb überlebt es jede Neuinstallation des Plugins.

Schritt 1: Den Bildschirm öffnen

Administration → Snippets, direkt /doku.php?do=admin&page=wksnippet.

Schritt 2: Das Snippet anlegen

Wählen Sie in der Befehlsleiste Neues Snippet. In der Schublade tragen Sie unter Kennung den Namen ein und wählen Anlegen. Erlaubt sind Buchstaben, Ziffern, Bindestrich und Unterstrich; die Kennung wird zum Dateinamen.

$Schublade Neues Snippet mit dem Pflichtfeld Kennung, darin contact_box, und dem Knopf Anlegen$

Die Schublade Neues Snippet fragt nur die Kennung ab. Danach öffnet sich der Editor des neuen Snippets. Tragen Sie dort den HTML-Quelltext ein und wählen Sie Speichern:

<div class="contact-box">
  <h3>Kontakt</h3>
  <p>info@example.com</p>
</div>

Speichern schreibt die Datei <savedir>/wksnippet/contact_box.html. Unter dem Editor steht bei Verwendung die Marke, die Sie im nächsten Schritt einsetzen.

Schritt 3: Das Snippet auf eine Seite setzen

Bearbeiten Sie eine beliebige Wiki-Seite und schreiben Sie:

{{wk:snippet>contact_box}}

Ergebnis prüfen

Der Kasten steht auf der Seite – und zwar unabhängig davon, ob DokuWikis eigene Einstellung htmlok eingeschaltet ist. Genau das ist der Zweck: HTML aus einer verwalteten Datei statt HTML aus dem Seitentext.

Zwei Gegenproben:

Setzen Sie dieselbe Zeile auf eine zweite Seite, ändern Sie das Snippet im Bildschirm und laden Sie beide Seiten neu. Beide haben sich geändert.
Schreiben Sie {{wk:snippet>gibtesnicht}} auf eine Seite. Die Seite rendert weiterhin; im HTML-Quelltext steht ein Kommentar mit der fehlenden Kennung. Eine falsche Kennung bricht also nichts und verschwindet auch nicht spurlos.

Nächster Schritt

wksnippet – Referenz: alle Formen der Auszeichnung, der Helfer für den Aufruf aus eigenem Code, und warum allowPhp zwei voneinander unabhängige Schalter braucht.
wki18n – wenn das Snippet je Sprache anderen Text zeigen soll.