Aiuto:I template
| Linee guida su come contribuire al Wiki |
|
Sommario |
Introduzione
Per aiutare nella formattazione della pagina sono disponibili diversi template. I template sono delle scorciatoie per inserire degli elementi standard in una pagina e possono essere liberamente utilizzati per mettere in evidenza messaggi di avvertimento, note e suggerimenti, per contrassegnare la guida secondo il suo stato, per inserire sommari, immagini o tabelle e, in generale, per permettere di ridurre la complessità di inserimento di elementi destinati ad essere utilizzati in più pagine.
Ad esempio, su questo Wiki, abbiamo dei template già pronti che permettono l'inserimento di elementi usati frequentemente nelle guide.
La lista completa dei template disponibili è consultabile qui.
Creare un template
Per la creazione di un template bisogna innanzitutto creare una nuova pagina nel relativo namespace inserendo nella barra degli indirizzi del browser:
http.//guide.debianizzati.org/Template:Nome_template
Quindi si può iniziare la creazione della pagina inserendo il testo tra i tag <includeonly> </includeonly>; tutto ciò che viene incluso all'interno di questi tag sarà parte integrante del template. Ciò che viene incluso invece tra i tag <noinclude> </noinclude> non sarà parte del template ma soltanto della sua pagina.
I template possono essere di due tipi:
- Template statici
- contengono testo che non può essere modificato quando il template viene richiamato da una pagina.
- Template dinamici
- utilizzano parametri che permettono di modificare il contenuto visualizzato dal template.
tipicamente la flessibilità dei template permette loro di risultare dinamici o statici in base al fatto che vengano richiamati con o senza parametri.
Si può fare pratica con i template direttamente sul Wiki, modificando la pagina Template:Sandbox per provare un nuovo template, richiamandolo poi nella stessa pagina con {{Sandbox}} all'interno della sezione <noinclude> </noinclude> oppure nella pagina Sandbox o in una propria bozza.
Utilizzare i template
I template possono essere utilizzati in ciascun punto della pagina salvo diversamente specificato. Alcuni, infatti, necessitano di essere inseriti obbligatoriamente in cima alla guida oppure in fondo alla guida; questo per mantenere quanto più omogeneo possibile lo stile grafico del Wiki.
Per inserire un template in una pagina:
{{Nome_template}}
oppure:
{{Nome_template|valore1|valore2|valore3|...}}
o anche:
{{Nome_template
|parametro1=valore1
|parametro2=valore2
|parametro3=valore3
...
}}
se il template prevede l'utilizzo di parametri.
Si noti che l'inserimento del namespace per richiamare un template, ad esempio:
{{Template:Nome_template}}
produce lo stesso risultato ma è del tutto superfluo poiché il motore Wiki stabilisce che si tratta di un template dalla sola presenza delle parentesi graffe.
Consultare la pagina relativa a ciascun template per tutte le informazioni sul suo utilizzo e seguire la distinzione maiuscole-minuscole per evitare possibili problemi di visualizzazione.
Di seguito sono elencati alcuni template, la lista completa è visibile qui.
Template "Versioni compatibili"
Il template "Versioni compatibili" viene automaticamente allineato in alto a destra: se ciò dovesse causare dei problemi con gli altri elementi della pagina, è possibile inserire, tra il template e gli elementi successivi, delle righe vuote (sempre mediante il tag <br>).
Tra la riga contenente il testo per l'inserimento del template e il testo successivo non inserire righe vuote; questo consentirà l'allineamento del template con l'eventuale indice della pagina.
Si occupa di indicare la compatibilità di una guida per una o più versioni di Debian. Inoltre ne permette il tracciamento automatico.
Per questo l'uso della forma "senza parametri", per segnalare la compatibilità per tutte le versioni, è sconsigliata, se non per guide trattanti argomenti generali o relativi a pacchetti di sistema (priorità: required, important, standard).
Queste guide (come anche le pagine di glossario), che si suppongono molto importanti, possono far uso di template Codename e template APT-mirror per tenere aggiornate informazioni riguardanti gli attuali codename delle suite supportate di Debian e i mirror di default dei repository, in modo da non dover essere modificate a ogni nuovo rilascio di Debian solo per aggiornare tali informazioni.
Box informativi
- Template "Box"
- Il template "Box" andrebbe utilizzato soprattutto quando si desidera inserire delle note o degli aggiornamenti, ma naturalmente è uno strumento estremamente flessibile e può essere utilizzato anche per altre finalità.
- Template "Warningbox"
- Il template "Warningbox" va utilizzato per inserire avvisi importanti. Si consiglia di inserirlo soprattutto nel caso in cui vengano utilizzati comandi o programmi che possono pregiudicare il funzionamento del computer, o che pregiudicano la sicurezza del sistema o di dati riservati.
- Template "Cautionbox"
- Il template "Cautionbox" va utilizzato per inserire avvisi più generici di prestare maggiore cautela, per cui non è necessaria la gravità del precedente.
- Template "Suggerimento"
- Il template ""Suggerimento" è utilizzato per inserire suggerimenti, trucchi o consigli.
- Template "Non-free"
- Il template "Non-free" consente di visualizzare un box di avvertimento per quelle guide che trattano argomenti o software a sorgente chiuso o non aderenti ai principi del Free Software.
Stato di una guida
|
Nota Prima di utilizzare uno di questi template per contrassegnare una guida, si raccomanda la lettura della pagina dedicata a quel template, dove sono presentate più nel dettaglio tutte le linee guida a cui è bene attenersi. |
- Template "Stub"
- Il template "Stub" è da inserire nelle guide o articoli ancora incompleti.
- Template "Guida da adottare"
- Il template "Guida da adottare" contrassegna quelle guide di particolare interesse che dovrebbero essere aggiornate nei contenuti e, quindi, in cerca di adozione da parte di un membro della comunità. Vedere anche la pagina adozione guide per avere più informazioni su come adottare una guida,
- Template "Old"
- Il template "Old" contrassegna quelle guide contenenti informazioni ormai obsolete. Le guide vengono mantenute nel Wiki esclusivamente per interesse storico o didattico.
- Template "Da cancellare"
- Il template "Da cancellare" deve essere utilizzato per contrassegnare quelle guide che si ritiene debbano essere cancellate. A proposito della cancellazione di una pagina, vedere Spostare e cancellare una pagina.
Testo da segnalare
Questo template serve per segnalare parti della guida problematiche o poco chiare. Non segnalare problemi derivanti dall'applicazione della guida o riguardanti argomenti ad essa correlati. Per questo scopo c'è il forum.
Template di sommario
- Sommario verticale
- Il template "Sommario verticale" crea un sommario per quelle guide che necessitano di essere suddivise in più pagine e dovrebbe essere inserito sulle pagine successive ad una pagina iniziale di introduzione alla guida.
Questa è la pagina relativa al sommario verticale e qui sono elencati i template che fanno uso del sommario verticale.
- Sommario orizzontale
- Il seguente template crea un sommario orizzontale comprendente quelle guide che riguardano argomenti strettamente interconnessi.
Questa è la pagina relativa al sommario orizzontale e qui sono elencati i template che fanno uso del sommario orizzontale.
Problemi conosciuti
- Carattere "=" all'interno dei template
- L'inserimento del carattere "=" (uguale) all'interno dei template può portare a problemi di corretta interpretazione dei parametri e, quindi, ad un output indesiderato.
- Per risolvere si può ricorrere ad uno dei seguenti metodi:
- Utilizzare i parametri numerati. Ad esempio {{Template|1=testo}} anziché {{Template|testo}}
- Utilizzare il codice HTML corrispondente (=)
- Utilizzare la codifica URL (%3D) se si sta assegnando un indirizzo attraverso il parametro "link=" e l'inserimento di immagini.
- Utilizzare il template apposito (sintassi: {{=}})
- Carattere "|" all'interno dei template, comandi e tabelle
- Analogamente l'inserimento del carattere "|" (pipe) all'interno del testo dei template, comandi o tabelle può portare a un output indesiderato. È usato infatti per delimitare un argomento dal successivo nei template e nei comandi (per esempio forniti dall'estensione MediaWiki ParserFunctions); e a delimitare celle, righe, colonne e la fine delle tabelle.
- Per risolvere si può ricorrere ad uno dei seguenti metodi, quando si intende utilizzare il carattere pipe come semplice testo:
- Utilizzare il codice HTML corrispondente (|)
- Utilizzare il template apposito (sintassi: {{!}})
- Si noti comunque che è possibile annidare più template/comandi senza problemi, fintanto che il carattere pipe non è usato come testo, e che gli accorgimenti di cui sopra vanno utilizzati unicamente in tale circostanza. I problemi sorgono invece se si annidano template/comandi e tabelle, a prescindere dall'ordine, e sarebbe necessario sostituire sempre tutti i caratteri pipe annidati.