Schnelleinstieg: Einen Schnipsel anlegen und einbinden

Der kürzeste Weg von „Plugin ist installiert“ zu „derselbe HTML-Baustein 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. Der Schnipsel wird als Datei unter <savedir>/wksnippet/ abgelegt, nicht im Plugin-Ordner; deshalb überlebt er jede Neuinstallation des Plugins.

Schritt 1: Den Bildschirm öffnen

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

Schritt 2: Den Schnipsel anlegen

Legen Sie einen neuen Eintrag an. Er braucht zwei Angaben.

Schlüssel — erlaubt sind Buchstaben, Ziffern, Unterstrich und Bindestrich:

contact_box

Inhalt:

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

Speichern schreibt die Datei <savedir>/wksnippet/contact_box.html.

Schritt 3: Ihn 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 den Schnipsel 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 dem fehlenden Schlüssel. Ein falscher Schlüssel 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 der Schnipsel je Sprache anderen Text zeigen soll.