Documentazione/doc

Questa pagina di documentazione contiene istruzioni, categorie o altre informazioni tecniche.
Per vedere la pagina template stessa, andare su Template:Documentazione.

Descrizione

Questo template viene usato per mostrare la documentazione nelle pagine dei template, evitando di appesantire il codice della pagina dei template stessi.

Dipendenze

Questo template usa {{Tocright}}, mentre la documentazione di {{T}} e {{Sottopagina di documentazione}}.

Sintassi

Aggiungere {{Documentazione}} dove si vuole inserire la documentazione.

Vedere anche

• {{Sottopagina di documentazione}}.
• Template:Documentazione/preload.

Uso

Nella pagina del template

Questo è il formato usato nella pagina del template:

CODICE DEL TEMPLATE<noinclude>
{{Documentazione}}
CATEGORIE DEL TEMPLATE
</noinclude>

Note:

• Ricordarsi che la documentazione del template va inclusa dentro i tag <noinclude></noinclude>, proprio come le categorie del template.
• Con certi template, specialmente tabelle o profili, andare a capo prima del tag <noinclude> aggiungerà una riga vuota alle pagine su cui si utilizzerà il template. Questo perché "l'a capo" precedente viene incluso nel codice del template. Se capitasse ciò, basta mettere <noinclude> subito dopo la fine del codice del template e non su una nuova riga (come nell'esempio sopra).
• Il template {{Documentazione}} è meglio metterlo su una nuova riga e non sulla stessa di <noinclude> per evitare errori di visualizzazione.

Sulla pagina della documentazione

Vedere Template:Documentazione/preload per il codice precaricato.

Ecco un esempio di documentazione, puoi seguire un formato come il seguente per scrivere la documentazione del template:

{{Sottopagina di documentazione}}

;Descrizione
Questo template serve per fare ''questo''.

;Dipendenze
Questo template usa le immagini [[:File:Nessuna immagine.svg]]...; i template {{T|Template1}}...; i CSS Style/Java scripts contenuti su [[MediaWiki:Common.js]] (o nome della pagina).

;Sintassi
Sintassi del template, esempio {{T|Nometemplate|2=parametro 1=|3=parametro 2=}} oppure
<pre>
{{Nometemplate
 | parametro 1   = 
 | parametro 2   = 
}}

;Parametri
* '''parametro 1=''' parametro 1 - default: 1.
* '''parametro 2=''' valore di altro - opzionale.

;Esempi
* Esempio.

;Vedere anche
* Collegamenti a cose correlate o utili.