Template:Parametro/man
Questa è la pagina di documentazione per Template:Parametro
Il template {{Parametro}} serve per compilare le liste di parametri nelle pagine di istruzioni dei template. (vedere Template:TabellaTemplate/man)
Completato col nome del parametro:
{{Parametro|Nomeparametro}}
Genera:
|Nomeparametro =
È possibile indicare anche un secondo parametro:
- aggiungendo come secondo parametro il testo "opzionale", "O", "facoltativo" oppure "F" si ottiene il testo in verde;
- aggiungendo come secondo parametro il testo "consigliato" oppure "C" si ottiene il testo in blu;
- aggiungendo come secondo parametro il testo "attenzione" oppure "A" si ottiene il testo in rosso;
Ad esempio con
{{Parametro|Esempioparametro_obbligatorio}}
{{Parametro|Esempioparametro_opzionale|opzionale}}
{{Parametro|Esempioparametro_consigliato|consigliato}}
{{Parametro|Esempioparametro_attenzione|attenzione}}
si ottiene:
|Esempioparametro_obbligatorio =
|Esempioparametro_opzionale =
|Esempioparametro_consigliato =
|Esempioparametro_attenzione =
Il template contiene nel codice le interruzioni di riga necessarie, che non devono essere inserite manualmente.
Funzioni avanzate
[modifica]Tramite il campo facoltativo "commento" è possibile specificare un breve commento direttamente accanto al parametro, ad esempio:
{{Parametro|Data|consigliato|commento=solo l'anno}}
genera:
|Data = <!-- solo l'anno -->
Tramite il campo facoltativo "valore" è possibile specificare un valore accanto al parametro, come se fosse già compilato. Questo è utile per mostrare esempi e per parametri che hanno un contenuto fisso o in parte fisso. Usare <nowiki> per eventuale formattazione. Ad esempio:
{{Parametro|Paese|consigliato|valore=<nowiki>{{ITA}}</nowiki>}}
genera:
|Paese = {{ITA}}
Legenda colori
[modifica]- I parametri scritti in nero sono obbligatori, la loro valorizzazione è determinante per il corretto funzionamento del template.
- I parametri scritti in verde sono facoltativi. Questo vuol dire che se non vengono inseriti, non compaiono all'interno del template.
- I parametri scritti in blu sono facoltativi, ma il loro uso è fortemente consigliato. Questo vuol dire che se non vengono inseriti, non compaiono all'interno del template.
- I parametri scritti in rosso richiedono particolare attenzione per la loro compilazione. Si raccomanda di leggere attentamente la sezione istruzione per dettagli in proposito.
Se hai problemi a visualizzare i colori, passa col mouse sopra i nomi dei parametri per far apparire una breve descrizione.
Nel caso di campi facoltativi che non vengono utilizzati, le relative righe possono venir lasciate col solo nome campo seguito da = e senza nessun valore. Se si è sicuri che un parametro facoltativo non verrà mai utilizzato (per esempio perché non pertinente alla voce in oggetto) lo stesso può essere eliminato dalla tabella inserita nella voce.