Uso delle Pagine Web HTML Debian
Questa pagina è ancora una bozza.
- Prefazione
- Alcuni suggerimenti generali
- Abbreviazioni ed acronimi
- Citazioni
- Nomi dei programmi e codice
- Esempi di output
- Input da tastiera
- Variabili
- Contenuti preformattati
- Immagini
- Collegamenti
Prefazione
Questa pagina è stata creata per aiutare autori e traduttori a comporre pagine con i corretti tag. Contiene suggerimenti circa l'uso dei tag e su come creare nuove pagine e renderle più facili da tradurre.
Alcuni suggerimenti generali
Ecco un elenco di consigli generali per nuove pagine o traduzioni
- non utilizzare righe lunghe
- I file wml e altri file dovrebbero essere costituiti da righe che entrano in una normale finestra di terminale, in modo tale da essere più facilmente modificabili in vi nonché più semplici da cercare e da tradurre. Questo è un aspetto importante anche perché è più difficile risolvere conflitti in righe lunghe.
- mantenere i tag in linee separate, ove possibile
- La maggior parte dei tag HTML può essere tenuta in righe separate. Tra questi, ad esempio, vi sono: <div>, <p>, <table>, <ul>. Per rendere il lavoro più facile ai traduttori si possono mantenere questi tag in righe a parte. Altrimenti alcuni tag potrebbero essere fortuitamente cancellati dai traduttori e non ripristinati dopo la traduzione.
- non usare spazi o interruzioni di riga nei tag inline
- Alcuni tag producono uno spazio, se sono tenuti in linee separate. Uno di questi è il tag <q> per piccole citazioni o virgolette. Vanno quindi mantenuti in una sola riga, insieme al relativo contenuto. Altrimenti risulterebbe uno spazio tra il contenuto e il tag, nella pagina HTML che verrà creata. Il testo racchiuso tra questi tag può contenere spazi e interruzioni di riga senza problemi.
Abbreviazioni ed acronimi
Per le abbreviazioni e gli acronimi si deve utilizzare il tag HTML <acronym>. Ci sono due motivi per cui l'uso del tag <abbr> non è raccomandabile: innanzitutto, non tutti i browser supportano questo tag e inoltre vi sono differenti definizioni, non uguali tra loro, riguardo cosa sia un acronimo e cosa sia un'abbreviazione.
Per aggiungere un acronimo alla pagina si usa la seguente sintassi:
<acronym lang="language code" title="Definizione completa
dell'acronimo">ACRONIMO</acronym>
. Il titolo contiene il testo
dell'acronimo scritto per esteso. Se l'acronimo è formato dalle iniziali di alcune parole,
queste lettere devono essere in maiuscolo nel titolo. L'attributo lang è necessario solo
se l'acronimo o l'abbreviazione è in una lingua straniera.
Esiste un insieme di acronimi di uso comune già inclusi nei template wml.
Per usarli nella propria pagina, si deve aggiungere una riga acronyms
nel file wml. Per esempio il tag wml per DD è <acronym_DD />.
Citazioni
Esistono regole molto variegate per definire cosa sia una citazione nelle diverse lingue. Se la citazione è breve si deve utilizzare i tag <q>. La resa visiva del contenuto è gestita dal linguaggio CSS. I tag <q> non devono presentare spazi o interruzioni di linea tra i tag di apertura e chiusura ed il contenuto.
Per citazioni più lunghe va utilizzato il tag <blockquote>. <blockquote> racchiude uno o più paragrafi di testo, che sono segnalati con <p>. Si prega di non utilizzare i tag <blockquote> per centrare qualsiasi blocco di testo che non sia una citazione. I blocchi di citazione sono esclusivamente riservati per le citazioni ed in futuro saranno resi visivamente tramite codice CSS specifico per linguaggio.
Esiste, nel codice HTML, anche un tag <cite>. Il tag <cite> non è usato per citare il testo stesso ma per riferire la fonte della citazione. Può essere il nome della persona da cui proviene la citazione ed è aggiunto come attributo a <blockquote> come URL.
Nomi dei programmi e codice
Per i nomi dei programmi e il codice sorgente c'è un tag chiamato <code>. I browser normalmente sanno come mostrare codice e nomi dei programmi, ma la visualizzazione può anche essere cambiata dal CSS. Non è una buona idea usare <tt> al suo posto perché non rivela nulla a proposito del contenuto.
Esempi di output
Per i messaggi del computer sullo schermo esiste un tag speciale detto <samp>. Se si deve inserire un blocco di messaggi più largo, si dovrebbe controllare nel file CSS se è stata creata una classe speciale per definirlo.
Input da tastiera
Se ci sono casi in cui l'utente deve inserire qualcosa da tastiera, vengono usati i tag <kbd> per l'input. Fare anche riferimento al capitolo variabili per sapere che tag applicare all'input variabile.
Variabili
A volte è necessario enfatizzare un input variabile come ad esempio un indirizzo IP speciale o il nome utente usato in una riga di comando. Per questi input variabili è usato il tag <var>.
Contenuti preformattati
Il tag <pre> è utilizzato esclusivamente per il testo preformattato. Lunghezza di riga, spazi e altre cose saranno preservate. Ovviamente questo tag non può contenere la maggior parte degli altri tag HTML.
Immagini
Se ci sono immagini all'interno della pagina, non c'è bisogno di aggiungere l'attributo
border=0. Se possibile, però, dovrebbero essere aggiunti la dimensione dell'immagine e
l'attributo alt
. La dimensione, se non presente, viene aggiunta da wml ma
questo comporta un incremento del tempo di compilazione. L'attributo alt
dovrebbe contenere qualcosa che dica a chi naviga con lynx o alle persone non vedenti
a cosa si riferisce l'immagine.
Collegamenti
Se avete intenzione di creare un collegamento all'interno della documentazione a
una pagina del sito https://www.debian.org
, utilizzate le variabili
definite nel file .wmlrc
di ogni lingua. Per esempio, l'URL nel
tag
<a
href="https://www.debian.org/devel/website/htmlediting">htmlediting</a>
dovrebbe essere sostituito utilizzando la variabile DEVEL come
mostrato di seguito: <a
href="$(DEVEL)/website/htmlediting">htmlediting</a>
.