Template:Parametro/man
Il template {{Parametro}} serve per compilare le liste di parametri nelle pagine di istruzioni dei template. (vedere {{TabellaTemplate/man}} )
Completato col nome del parametro:
{{Parametro|Nomeparametro|valoresuggerito|nota=}}
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;
- aggiungendo come secondo parametro il testo "sconsigliato" oppure "S" si ottiene il testo in grigio;
- aggiungendo come secondo parametro il testo "particolare" oppure "P" si ottiene il testo in arancio;
- aggiungendo come secondo parametro il testo "deprecato" oppure "D" si ottiene il testo in giallo.
- nota = nota da inserire nel tag <ref>...</ref>.
Ad esempio con
{{Parametro|Esempioparametro_obbligatorio}}
{{Parametro|Esempioparametro_opzionale|opzionale}}
{{Parametro|Esempioparametro_consigliato|consigliato}}
{{Parametro|Esempioparametro_attenzione|attenzione}}
{{Parametro|Esempioparametro_sconsigliato|sconsigliato}}
{{Parametro|Esempioparametro_particolare|particolare}}
{{Parametro|Esempioparametro_deprecato|deprecato}}
si ottiene:
|Esempioparametro_obbligatorio =
|Esempioparametro_opzionale =
|Esempioparametro_consigliato =
|Esempioparametro_attenzione =
|Esempioparametro_sconsigliato =
|Esempioparametro_particolare =
|Esempioparametro_deprecato = DEPRECATO
Seguono alcuni consigli d'uso dei parametri secondo il colore, utilizzabili nel manuale del template:
- I parametri scritti in rosso devono essere obbligatoriamente compilati. Questo vuol dire che deve essere presente il nome campo seguito da = e un valore.
- Quando esistono e sono noti, i parametri scritti in blu sono fortemente consigliati. Nel caso di campi blu che non vengono utilizzati, le relative righe vanno lasciate col solo nome campo seguito da = e senza nessun valore. Questi campi non vanno comunque mai rimossi, per futuri possibili inserimenti di informazioni.
- I parametri scritti in verde sono facoltativi. 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, nel caso si sia sicuri che tali parametri non vangano compilati successivamente (per esempio perch* non pertinenti alla voce) è possibile cancellarli.
- I parametri scritti in grigio sono sconsigliati. Sono inseriti per supportare casi particolari, ma esistono altri parametri sostitutivi che sarebbe meglio utilizzare.
- I parametri scritti in arancio sono particolari. Sono inseriti per dei parametri che sono caratteristici solo per determinati template come {{UNESCO}}.
Il template contiene nel codice le interruzioni di riga necessarie, che non devono essere inserite manualmente.
Come terzo parametro si può suggerire un valore probabile o certo (per esempio, il valore suggerito del parametro appellativo di un vescovo sarebbe monsignor). Il parametro suggerito comparirà dopo il segno di uguale (=). In tal caso, per evitare malfunzionamenti del template, occorre obbligatoriamente specificare anche il secondo parametro (si usi N per ottenere il colore nero).
Legenda colori
- 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.
- I parametri scritti in grigio sono sconsigliati. Esistono altri parametri sostitutivi che sarebbe meglio utilizzare.
- I parametri scritti in arancio sono particolari. Utilizzati solo con particolari condizioni.
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.