Template:Documentazione
 |
Questo template nel suo codice interno impiega alcune caratteristiche relativamente complesse come parametri opzionali o funzioni del parser.
Per favore, non provate a modificarlo se non siete certi di capirne la funzione e se non siete preparati a riparare ogni conseguente danno collaterale nel caso in cui i risultati fossero diversi da quanto avevate in mente. Tutti gli esperimenti devono essere prima condotti nella Sandbox dedicata. |
|
|
Questo template nel suo codice interno impiega alcune caratteristiche relativamente complesse come parametri opzionali o funzioni del parser.
Per favore, non provate a modificarlo se non siete certi di capirne la funzione e se non siete preparati a riparare ogni conseguente danno collaterale nel caso in cui i risultati fossero diversi da quanto avevate in mente. Tutti gli esperimenti devono essere prima condotti nella Sandbox dedicata. |
 |
Template protetto – Le modifiche possono essere proposte nella pagina delle prove di questo template. |
Descrizione
Il template visualizza il riquadro contenente la documentazione, esattamente come quella che stai vedendo ora.
Può essere utilizzato sia per i template, così da fornire le informazioni sul suo uso in uno spazio dedicato, sia per le altre pagine (utente, progetto, portale, etc.) ovunque sia comoda una sezione svincolata dai diritti di protezione della pagina in cui è inserito.
Il testo viene inserito in una sottopagina "/doc". Se manca, il template aggiunge automaticamente il colllegamento per crearla con il parametro preload. In questo modo la pagina in creazione avrà già all'interno la struttura da seguire per facilitare il lavoro.
Uso
Normale
- <noinclude>{{Documentazione}}</noinclude>
Avanzato
Per inserire nella pagina la documentazione di un altra pagina:
- <noinclude>{{Documentazione|Template:Nome template/doc}}</noinclude>
Per inserire nel riquadro un testo definito dall'utente senza creare la sottopagina:
- <noinclude>{{Documentazione
- | contenuto = Testo che si vuole inserire nel riquadro
- }}</noinclude>
Per personalizzare il titolo del riquadro (al posto dello standard Documentazione):
- <noinclude>{{Documentazione
- | intestazione = Titolo personalizzato
- }}</noinclude>
Per non visualizzare il titolo del riquadro e i collegamenti verso la sottopagina:
- <noinclude>{{Documentazione
- | intestazione =
- }}</noinclude>
Perchè usarlo
- L'uso di questo template permette di bloccare i template in cui è inserito senza impedire agli utenti di modificare la documentazione.
- Il testo inserito dentro ad un template lo rende pesante per il sistema. Infatti vi è un limite di massimo di 2,048,000 bytes (qui un approfondimento) che è superabile ricorrendo all'inclusione del testo attraverso questo template.