Avvio rapido: creare e inserire uno snippet

Il percorso più breve da «il plugin è installato» a «lo stesso blocco HTML compare su due pagine e si manutiene in un unico punto». Tre passi, circa cinque minuti.

• wksnippet è installato e attivato nel gestore delle estensioni.
• Siete autenticati come superuser — la schermata di modifica è riservata agli amministratori.
• La directory dei dati del wiki è scrivibile. Lo snippet viene salvato come file in <savedir>/wksnippet/, non nella cartella del plugin: per questo sopravvive a ogni reinstallazione.

Amministrazione → WvdS Snippets, direttamente /doku.php?do=admin&page=wksnippet.

Aggiungere una voce. Servono due cose.

Chiave — lettere, cifre, trattino basso e trattino:

contact_box

Contenuto:

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

Il salvataggio scrive il file <savedir>/wksnippet/contact_box.html.

Modificare una pagina wiki qualsiasi e scrivere:

{{wk:snippet>contact_box}}

Il riquadro compare sulla pagina — e ciò avviene indipendentemente dal fatto che l'impostazione htmlok di DokuWiki sia attiva. È proprio questo lo scopo: HTML da un file gestito invece di HTML nel testo della pagina.

Due controprove:

• Collocare la stessa riga su una seconda pagina, modificare lo snippet nella schermata e ricaricare entrambe. Sono cambiate entrambe.
• Scrivere {{wk:snippet>chiave_inesistente}} su una pagina. La pagina continua a generarsi; nel sorgente HTML compare un commento con la chiave mancante. Una chiave errata non rompe nulla e nemmeno sparisce senza traccia.

• wki18n — se lo snippet deve mostrare testo diverso per lingua.
• wksnippet (in tedesco) — la pagina del pacchetto: tutte le forme del tag, l'helper per la chiamata dal proprio codice e il motivo per cui allowPhp richiede due interruttori indipendenti.