Questo capitolo, vuole essere solo un riferimento essenziale alla definizione di uno stile letterario, e il contenitore di una piccola raccolta di regole che dovrebbero semplificare la vita di chi scrive documenti elettronici.
L'autore di questo documento non è proprio la persona migliore per scrivere di queste cose, e lo si può vedere leggendo qualunque parte di questi Appunti. Tuttavia, è importante almeno affrontare l'argomento sottolineando alcuni concetti importanti.
Come sempre, tutte le segnalazioni di errore sull'ortografia, la sintassi e il contenuto di questo documento, sono gradite. :-)
Il concetto di stile letterario potrebbe essere espresso semplicemente spiegando l'esigenza di realizzare un documento uniforme: sia dal punto di vista visivo, sia dal punto di vista espressivo. Questo coinvolge quindi l'aspetto grammaticale (ortografia, sintassi, lessico, ecc.) e l'aspetto tipografico (impaginazione, tipi di carattere, dimensione, ecc.) o artistico.
L'esigenza di un'uniformità visiva deriva dal piacere e dal rilassamento che può dare al lettore un documento impaginato e strutturato in un modo ordinato e chiaro, e dalla facilità nella lettura che ne deriva. Nello stesso modo è importante l'uniformità grammaticale, cosa particolarmente delicata in una lingua come la nostra in cui sono consentite molte variazioni, data la varietà linguistico-culturale delle varie regioni.
Il novello scrittore di documentazione tecnica, che scrive e impagina senza l'aiuto di un editore, tende a comprendere l'esigenza di uno stile tipografico, dimenticando che esiste anche uno stile espressivo-grammaticale.
Il problema dell'uniformità stilistica si accentua quando si deve collaborare alla realizzazione di un progetto letterario. L'uniformità non è più solo un fatto di coerenza personale, ma di coerenza complessiva di tutto il gruppo.
La coordinazione dei vari collaboratori è un problema delicato, e diviene essenziale la stesura di uno standard letterario complessivo. Alle volte questo ferisce la sensibilità di alcuni collaboratori e genera discussioni senza fine, né soluzione. *1*
Il modo migliore per definire uno stile grammaticale è lo studio su un testo di grammatica. Qui si vogliono solo raccogliere alcuni punti essenziali che non possono essere ignorati. In effetti, il tipico autore di testi a carattere tecnico, specialmente in ambito volontario come nel caso di questo documento, ha un'ottima conoscenza dell'argomento trattato, e una pessima padronanza della lingua.
La punteggiatura si compone di quei simboli che consentono di separare le parole e di delimitare le frasi.
 |
Ogni parola è separata da un solo spazio. Tipograficamente, lo spazio è una separazione di ampiezza non definita, spesso ampliato o compresso, per ottenere un allineamento del testo sia a sinistra che a destra. Un autore non deve pensare a queste cose quando scrive la propria opera; si deve limitare a spaziare le parole con un solo carattere spazio. *2* La dattilografia insegnava a ottenere testi allineati a sinistra e a destra con l'inserzione opportuna di spazi aggiuntivi, vicino alle parole composte da poche lettere (congiunzioni, articoli, ecc.). Questo tipo di tecnica è ormai da abbandonare, lasciando semmai che siano i programmi di composizione a prendersi cura di questi problemi, anche quando il risultato finale deve essere un file di testo puro e semplice. I programmi di composizione più evoluti facilitano il compito dello scrittore eliminando gli spazi superflui, per cui con questi non c'è l'esigenza di porre attenzione alla dimensione delle spaziature. *3* |
|
I simboli di punteggiatura normale sono attaccati alla parola che precede e separati con uno spazio dalla parola che segue. Si tratta di: punto, virgola, due punti, punto e virgola, punto interrogativo e punto esclamativo. Alle volte, l'autore di documenti tecnici di informatica si lascia confondere dall'uso che si fa di tali simboli in un particolare linguaggio di programmazione o in altri ambiti analoghi. È chiaro, per esempio, che se si deve indicare un'estensione di un file, come |
|
Le parentesi sono attaccate al testo che racchiudono, e rispetto alla punteggiatura esterna si comportano come un'unica parola. La parentesi di apertura è separata con uno spazio dalla parola che precede, e quella di chiusura è separata con uno spazio dalla parola che segue. I simboli di punteggiatura normale che dovessero seguire una parentesi chiusa vanno attaccati a quest'ultima. Nella lingua italiana non è consentito racchiudere all'interno di parentesi un periodo terminante con il punto fermo. Questa modalità è tipica della lingua inglese, e i traduttori devono tenerne conto, al limite togliendo le parentesi nella frase tradotta. |
|
Il testo riportato tra virgolette si comporta come quello racchiuso tra parentesi. La lingua italiana prevede l'uso di virgolette uncinate (in basso), virgolette elevate doppie e singole. Secondo la grammatica, le virgolette uncinate, o virgolette basse, sono da preferire. Tuttavia, dal momento che le virgolette elevate possono essere ottenute anche utilizzando soltanto il codice ASCII tradizionale a 7 bit, molti autori preferiscono accontentarsi e utilizzare solo quelle elevate. *4* |
|
Il trattino di unione è corto, e unito alle parole da collegare. Si usa per unire insieme due parole in modo da formare una parola composta. I programmi di composizione tendono a considerare un trattino singolo come un trattino corto, proprio per questo scopo. |
|
La lineetta, o trattino lungo, serve per introdurre un discorso diretto, oppure un inciso. Il trattino utilizzato per delimitare un discorso diretto, viene usato normalmente solo in apertura. Può apparire anche un trattino in chiusura quando al discorso diretto segue un commento. Se il trattino si usa per delimitare un inciso, si usa per aprirlo e solitamente anche per chiuderlo, come se si trattasse di parentesi. Generalmente, il trattino lungo è preceduto e seguito da uno spazio; davanti al trattino di chiusura vanno collocati il punto interrogativo, il punto esclamativo e i puntini, mentre per gli altri simboli di punteggiatura non esiste una convenzione precisa. *5* |
L'uso della punteggiatura nella lingua italiana è definito da regole molto vaghe che si prestano a facili eccezioni di ogni tipo. Qui si elencano solo alcuni concetti fondamentali.
|
, La virgola è un segno di interpunzione che collega due segmenti di testo separati da un pausa debole. |
|
; Il punto e virgola è un segno di interpunzione che si colloca a metà strada tra la virgola e il punto. Non segna la chiusura di un periodo. |
|
: I due punti sono un simbolo di interpunzione esplicativo. Collegano due segmenti di testo separati dal punto di vista sintattico, in cui la seconda parte, quella che segue il simbolo, elenca, chiarisce o dimostra il concetto espresso nella prima parte. |
|
. Il punto fermo è un segno di interpunzione che collega due segmenti di testo separati da un pausa forte. Generalmente segna la conclusione di un periodo. La parola successiva al punto ha l'iniziale maiuscola. |
|
! Il punto esclamativo indica generalmente la conclusione di un'esclamazione affermativa. Generalmente, quando conclude un periodo, il testo che segue ha l'iniziale maiuscola. |
|
? Il punto di domanda indica un tono interrogativo alla fine di una frase. Generalmente, quando conclude un periodo, il testo che segue ha l'iniziale maiuscola. |
|
... I punti di sospensione sono in numero fisso di tre e indicano che il discorso non viene portato a conclusione. Generalmente, sono uniti alla parola o al segno di interpunzione che li precede, oppure distanziati, a seconda che siano solo una sospensione oppure indichino l'omissione di un nome o di un'altra parola. Se si trovano alla fine di un periodo, dove andrebbe collocato un punto, questo non viene aggiunto, e la frase successiva inizia con la maiuscola. Nello stesso modo, se si trovano alla fine di un'abbreviazione che termina con un punto, quest'ultimo viene assorbito. |
|
ecc. Il punto di abbreviazione, quando si trova alla fine di un periodo, conclude da solo anche il periodo stesso, ed è seguito da iniziale maiuscola. |
|
( ) Le parentesi, generalmente tonde, servono per delimitare un inciso, come un commento, una nota dello scrivente, un chiarimento, ecc. Generalmente, i commenti del redattore o del traduttore sono terminati, entro l'ambito delle parentesi, con le sigle NdR (nota del redattore) e NdT (nota del traduttore). |
Nella lingua italiana scritta, l'uso degli accenti è un fatto puramente convenzionale. Ciò significa che l'accento non indica necessariamente il suono che ha effettivamente la lettera accentata, ma solo la sua rappresentazione consueta (nell'appendice 191 è riportato il testo della norma UNI 601567 sul «segnaccento obbligatorio»). *6*
|
Nella lingua scritta è prevista (ed è obbligatoria) solo l'accentazione delle vocali finali delle parole nelle quali il tono della voce si rafforza sull'ultima sillaba (accento grafico). È possibile l'uso dell'accento per le vocali interne quando ciò serva per togliere ambiguità tra termini omografi (scritti nello stesso modo) che abbiano significati differenti. Generalmente, questa ambiguità è risolta dal contesto, e raramente si incontra la necessità di utilizzare accenti interni. |
|
Si utilizza comunemente solo l'accento grave (àèìòù), con l'eccezione della vocale «e» che può avere l'accento acuto (é). |
|
Vogliono l'accento acuto le parole terminanti in ché (perché, poiché, ecc.), oltre a né (congiunzione) e sé (pronome tonico). Quest'ultimo monosillabo viene scritto generalmente senza accento quando è seguito da stesso, anche se la grammatica non lo richiede. |
|
Vogliono l'accento alcuni monosillabi contenenti due vocali: ciò, già, giù, più e può. |
|
Vogliono l'accento i monosillabi che senza potrebbero avere un significato differente. La tabella 100.1 mostra l'elenco dei monosillabi accentati più importanti. |
|
Non vogliono l'accento alcuni monosillabi tra cui: qui, qua, sto e sta. |
|
Solo alcune parole tronche richiedono la segnalazione di tale troncamento con l'apostrofo finale. In particolare: po' (poco), mo' (modo), ca' (casa) e alcuni imperativi. |
|
L'accento circonflesso (^) non si usa più. Serviva per i nomi terminanti in |
| dà | indicativo di dare (dà valore) | da | preposizione (da voi) |
| è | verbo | e | congiunzione |
| là | avverbio (resta là) | la | articolo |
| lì | avverbio (vado lì) | li | pronome |
| né | congiunzione (né questo né quello) | ne | pronome (ne voglio ancora) |
| sé | pronome tonico (pieno di sé) | se | pronome atono o congiunzione |
| sì | avverbio (dice di sì) | si | pronome |
Alle volte, l'uso delle vocali accentate può creare problemi tecnici, dovuti alla loro mancanza nell'insieme di caratteri a disposizione. In Italia, e nei paesi dell'Europa centrale, si utilizza la codifica ISO 8859-1 (Latin-1) che contiene tutte le nostre lettere accentate. Nelle circostanze in cui ciò non è attuabile (per esempio quando si dispone di un sistema configurato male, o la tastiera non dispone dei simboli necessari), occorre utilizzare delle tecniche di rappresentazione che dipendono dal programma utilizzato per la composizione.
SGML, comprendendo in questo anche HTML, dispone di una serie di codici macro standardizzati elencati nella tabella 100.2.
| Vocale accentata | Macro corrispondente |
| à, À | à, À |
| è, È | è, È |
| ì, Ì | ì, Ì |
| ò, Ò | ò, Ò |
| ù, Ù | ù, Ù |
| é, É | é, É |
TeX, e di conseguenza LaTeX, dispongono di una serie di codici elencati nella tabella 100.3.
| Vocale accentata | Codice TeX corrispondente |
| à, À | \`a, \`A |
| è, È | \`e, \`A |
| ì, Ì | \`{\i}, \`I |
| ò, Ò | \`o, \`O |
| ù, Ù | \`u, \`U |
| é, É | \'e, \'E |
Lout dispone del comando @Char per indicare simbolicamente i segni tipografici che per qualche ragione non possono essere scritti letteralmente attraverso la codifica a disposizione. La tabella
100.4 mostra i comandi necessari a ottenere le vocali accentate.
| Vocale accentata | Comando di Lout |
| à, À | @Char agrave, @Char Agrave |
| è, È | @Char egrave, @Char Egrave |
| ì, Ì | @Char igrave, @Char Igrave |
| ò, Ò | @Char ograve, @Char Ograve |
| ù, Ù | @Char ugrave, @Char Ugrave |
| é, É | @Char eacute, @Char Eacute |
Quando si scrive un file di testo puro e semplice, e non è possibile utilizzare la codifica ISO 8859-1, si può utilizzare un trucco con cui si usa un apice opportuno subito dopo la vocale da accentare. Naturalmente questa tecnica può valere solo per la lingua italiana in cui gli accenti si pongono solo nelle vocali finali. Visivamente il risultato è molto simile a quello corretto.
| Vocale accentata | Vocale apostrofata corrispondente |
| à, À | a`, A` |
| è, È | e`, E` |
| ì, Ì | i`, I` |
| ò, Ò | o`, O` |
| ù, Ù | u`, U` |
| é, É | e', E' |
Le congiunzioni e, o, e la preposizione a, consentono l'aggiunta di una d eufonica, per facilitarne la pronuncia quando la parola che segue inizia per vocale. Si tratta di una possibilità, e non di una regola; di questa d si potrebbe benissimo fare a meno.
Ognuno tende a usare questa d eufonica in modo differente, a seconda della propria cadenza personale, che ne può richiedere o meno la presenza. Quando si scrive, bisognerebbe mantenere lo stesso stile, anche sotto questo aspetto, quindi ognuno deve stabilire e seguire un proprio modo.
Esiste tuttavia un suggerimento che punta all'uso moderato di queste d eufoniche: usare la d solo quando la vocale iniziale della parola successiva è la stessa; e non usarla nemmeno quando, pur essendoci la stessa vocale iniziale nella parola successiva, ci sia subito dopo una d che possa complicare la pronuncia.
L'iniziale maiuscola si utilizza all'inizio del periodo e per evidenziare i nomi propri. Nel dubbio è meglio evitare di utilizzare le maiuscole. La lingua italiana fa un uso diverso delle maiuscole rispetto ad altre lingue. Il novello scrittore di documenti tecnici tende a lasciarsi influenzare dall'uso che si fa delle maiuscole nella lingua inglese. Per questo è bene ribadire che in italiano l'uso di queste deve essere ridotto al minimo indispensabile.
Ci sono alcuni aspetti del plurale nella lingua italiana che vale la pena di annotare. In particolare, nel caso di chi deve utilizzare anche termini stranieri, si pone il problema di decidere se questi siano invariabili o meno. A questo proposito, esistono due regolette semplici e pratiche:
|
le parole terminanti per consonante sono invariate al plurale; |
|
i termini di provenienza straniera non ancora assimilati sono invariati al plurale. |
In particolare, per quanto riguarda la seconda, la logica è che non si può applicare un plurale secondo le regole di una lingua straniera mentre si usa l'italiano. Inoltre, dato che nella maggior parte dei casi si tratta di termini inglesi, che nella loro lingua prenderebbero quasi sempre una terminazione in -s al plurale, diventerebbe anche difficile la loro pronuncia in italiano.
Esiste una regoletta che permette di stabilire facilmente come debba essere ottenuto il plurale delle parole che terminano in -cia e -gia: la i rimane se la c e la g sono precedute da vocale, oppure se la i viene pronunciata con accento, mentre viene eliminata se queste consonanti sono precedute da un'altra consonante.
Quindi si ha: camicia, camicie e interfaccia, interfacce; ciliegia, ciliegie e spiaggia, spiagge; energia, energie.
Gli elementi puntati, o numerati, possono essere composti da elementi brevi, oppure da interi periodi. Se tutti gli elementi sono brevi:
|
l'elenco deve essere introdotto da una frase terminante con due punti; |
|
ogni elemento deve essere terminato con un punto e virgola, a eccezione dell'ultimo che termina normalmente con un punto. |
La descrizione appena fatta mostra un esempio di elenco del genere. Se anche uno solo degli elementi è troppo lungo, è bene trasformare tutti gli elementi in periodi terminati da un punto. In tal caso, se l'elenco viene introdotto da una frase, anch'essa termina con un punto.
Ci possono essere situazioni in cui queste indicazioni non sono applicabili: come sempre è necessario affidarsi al buon senso.
Le citazioni, cioè le frasi o i brani riprodotti letteralmente da altri documenti, devono apparire distinte chiaramente dal testo normale. Si usano normalmente queste convenzioni:
|
quando la citazione è incorporata nel testo viene delimitata attraverso le virgolette, oppure utilizzando il corsivo se la citazione è particolarmente breve; |
|
le citazioni incluse in un'altra citazione già virgolettata si evidenziano attraverso l'uso di un altro tipo di virgolette, cominciando da quelle uncinate («»), utilizzando poi quelle elevate doppie (``'') e terminando con quelle singole (`'); |
|
quando la citazione è molto lunga e occupa diversi capoversi, conviene utilizzare un corpo minore o un altro espediente tipografico per distinguerla dal testo normale, come con l'uso di rientri differenti; |
|
quando la citazione è lunga e non si vogliono utilizzare altri espedienti per evidenziarla, si utilizzano le virgolette, e quelle di apertura vanno ripetute all'inizio di ogni capoverso; |
|
all'interno delle citazioni possono apparire dei commenti o chiarimenti inseriti da chi scrive, delimitandoli attraverso l'uso di parentesi quadre; |
|
all'interno delle citazioni vanno indicate le omissioni, e queste possono essere segnalate attraverso l'uso dei puntini di sospensione racchiusi tra parentesi quadre (come per i commenti); |
|
quando si fanno delle omissioni nella citazione all'inizio o alla fine del brano, è preferibile l'uso dei puntini di sospensione senza che questi siano racchiusi tra parentesi quadre; all'inizio i puntini di sospensione sono staccati dalla prima parola, mentre alla fine sono attaccati all'ultima. |
Le traduzioni rappresentano un problema in più, dal punto di vista dell'uniformità stilistica espressiva, soprattutto perché sono frequentemente il risultato di un lavoro di gruppo. Il problema più grave è rappresentato dalla traduzione o dall'acquisizione di quei termini che non fanno parte del linguaggio comune.
|
Una traduzione non può essere letterale, perché lingue diverse hanno strutture differenti, e il significato che si attribuisce alle parole dipende dal contesto. Quello che conta, quindi, è che il significato sia mantenuto. |
|
Quando si tratta di termini tecnici di origine straniera, la loro traduzione è spesso inopportuna, soprattutto quando chi deve esprimersi utilizzando quei concetti utilizza già abitualmente il termine in questione, nella forma originale, senza tradurlo. In pratica, è importante che gli utenti esperti possano trovare familiare la traduzione di un documento tecnico rivolto a loro. |
L'attività di traduzione è tanto più delicata se si considerano i vincoli posti dalle convenzioni internazionali che regolano l'editoria. In breve, la traduzione deve essere autorizzata dall'autore originale, verso il quale ci si assume la responsabilità del buon esito di questa operazione.
Per questo, la traduzione non può alterare il contenuto espresso dall'autore originale, e nemmeno chiarirlo. Nello stesso modo, una traduzione deve sempre essere accompagnata dall'indicazione dei nomi dei traduttori che l'hanno realizzata.
Come sempre, la scelta di tradurre o meno un termine tecnico deve essere affidata al buon senso, e al confronto con altri traduttori. Qui si elencano brevemente alcuni punti su cui si può basare la decisione di non tradurre.
|
Quando un termine straniero ha un significato più specifico della sua traduzione letterale, allora non viene tradotto. L'esempio più importante che deriva da questa affermazione è il termine file, che in italiano identifica precisamente il concetto di archivio elettronico generico. |
|
Una traduzione utilizzata largamente sul campo deve essere privilegiata al momento della scelta. È importante evitare che gli utenti esperti possano essere confusi da una traduzione. In pratica: gli utenti esperti devono trovare familiari le traduzioni scelte. |
Quando si decide di lasciare inalterato il termine straniero nel testo italiano, si pone il problema di stabilire il modo con cui questo possa convivere con il resto del testo. L'unica regola sicura è la verifica dell'uso generale, attraverso la discussione nelle liste specializzate. Tuttavia si possono definire alcune regole di massima, per dare l'idea del problema.
È importante osservare che nell'ambito delle traduzioni di documenti tecnici, nella stragrande maggioranza dei casi, si ha a che fare con l'inglese. Infatti, l'acquisizione di un termine straniero tende a seguire logiche differenti a seconda della lingua di origine. Per comprenderlo basta pensare con quanta facilità si potrebbe acquisire un termine francese, come «console», rispetto a un termine inglese.
|
La prima cosa da fare di fronte a un termine da non tradurre è di verificare in un vocabolario di lingua italiana; se c'è, il problema è risolto. Questo potrebbe sembrare un consiglio banale; ma attualmente appaiono già parole come «input» e «output» che non sono poi di uso così generalizzato. |
|
Un termine inglese può assumere il genere che avrebbe se tradotto in italiano, oppure quello che suona meglio dandogli un significato italiano. In caso di dubbio è importante controllare l'uso comune (se esiste). |
|
I termini inglesi non tradotti sono invariabili al plurale, cioè quando sono inseriti in testi in italiano vanno scritti sempre al singolare, senza aggiungere la lettera «s» finale, anche se ci si riferisce a una quantità maggiore di uno. A titolo di esempio si pensi al termine «mouse» che al plurale inglese diventa «mice». Chi usa questo termine, probabilmente è costretto a farlo, dato che l'italiano offre poche alternative; forse si potrebbe indicare come «dispositivo di puntamento», ma questa definizione è troppo generica e probabilmente non verrebbe compresa. Pertanto, chi usa questi termini non può essere anche costretto a conoscere perfettamente l'inglese e il modo corretto di usare i plurali in quella lingua. In altri termini, la lingua italiana non può incorporare le regole di un'altra lingua. |
Quando il termine che non si traduce non è di uso comune nell'ambiente a cui si rivolge il documento, dovrebbe essere evidenziato in corsivo tutte le volte che viene utilizzato. Per chiarire meglio il concetto, un termine tecnico può essere o meno di uso comune per il pubblico di lettori a cui si rivolge: se si tratta di un termine considerato normale per quell'ambiente, non è il caso di usare alcuna evidenziazione.
Quando si traduce un documento è importante la preparazione di un glossario, ossia una raccolta di traduzioni standard che permettono di mantenere uniformità nel documento tradotto. Questo diventa tanto più importante quando si lavora in gruppo, o si partecipa alla traduzione di un gruppo di opere che fanno parte di uno stesso ambito tecnico.
Un glossario del genere non può essere un documento statico, in quanto si ha la necessità di aggiornare continuamente il suo contenuto; se non altro per estenderlo.
Nell'ambito della documentazione GNU/Linux, ci si può iscrivere alla lista it@li.org per chiedere informazioni sul lavoro già svolto e per discutere termini non ancora definiti dal glossario in corso di realizzazione. Per iscriversi basta inviare un messaggio a majordomo@li.org contenente nel corpo (e non nell'oggetto) il testo seguente:
subscribe it
L'invio di messaggi al gruppo di discussione va indirizzato poi a it@li.org.
Eventualmente si può scaricare il glossario attuale da ftp://ftp.linux.it/pub/ILS/People/md/glossario.tgz, tenendo presente che il moderatore della lista desidera che non sia distribuito ulteriormente, in modo da evitare che si diffondano versioni obsolete.
Come ultima nota è opportuno chiarire che un glossario per la traduzione può essere solo uno strumento, per l'utilizzo da parte di persone in grado di capire il contesto in cui i termini sono usati, e di stabilire se le voci corrispondenti del glossario sono applicabili alle situazioni particolari.
Anche l'autore di un'opera originale di carattere tecnico, si imbatte in problemi simili a quelli dei traduttori. Infatti, quando l'acquisizione di un termine tecnico straniero riguarda solo l'ambito specializzato per il quale si scrive, si può dubitare del modo giusto di utilizzarlo.
Per questo, anche gli autori di opere originali possono avere la necessità di preparare un glossario e di discutere le espressioni migliori per un determinato concetto.
La definizione dello stile tipografico è un altro punto delicato nella definizione dello stile letterario generale. Di solito, la sua preparazione, è compito del tipografo o del coordinatore di un gruppo di autori o traduttori.
Il modo migliore per stabilire e utilizzare uno stile tipografico è quello di usare un sistema SGML, attraverso cui definire un DTD che non permetta alcun dubbio nella relazione che ci deve essere tra le varie componenti di un documento. In questo modo, gli autori hanno solo in compito di qualificare correttamente le varie componenti del testo, senza pensare al risultato finale, per modificare il quale si può semmai intervenire sul sistema di conversione successivo.
Le sezioni seguenti trattano dei problemi legati alla definizione di uno stile tipografico per la redazione di documenti tecnico-informatici, mostrando prevalentemente esempi in SGMLtools (LinuxDoc) e a volte anche in LaTeX. L'idea è presa dalla guida di stile del gruppo di documentazione di Linux: LDP (Linux Documentation Project), ma le indicazioni si basano sulle consuetudini tipografiche italiane.
Scrivendo documenti che riguardano l'uso dell'elaboratore, si incorre frequentemente nella necessità scrivere nomi, o intere parti di testo, che devono essere trattati in modo letterale. Possono essere nomi di file e directory, comandi, porzioni del contenuto di file, listati di programmi, ecc. In questi casi è sconsigliabile l'uso di un tipo di carattere proporzionale, perché si rischierebbe di perdere delle informazioni importanti. Si pensi al trattino utilizzato nelle opzioni della maggior parte dei comandi Unix: utilizzando un carattere proporzionale, attraverso un sistema di composizione come LaTeX, si otterrebbe un trattino corto, mentre due trattini posti di seguito genererebbero un trattino normale; e ancora, da tre trattini si otterrebbe un trattino largo.
Altri tipi di problemi sono dati da nomi di altro genere, come i marchi di fabbrica, e dalla necessità di marcare dei concetti quando appaiono per la prima volta.
|
I nomi di file, di qualunque tipo, dovrebbero essere rappresentati attraverso un tipo di carattere a spaziatura fissa. |
|
I nomi di questi tipi di entità sono sensibili alla differenza tra maiuscole e minuscole. Per questo vanno scritti sempre così come sono, anche quando si trovano all'inizio di un periodo, senza acquisire un'eventuale iniziale maiuscola. |
|
I nomi di file eseguibili, in quanto tali, sono indicati preferibilmente senza il percorso necessario al loro avvio. |
|
I nomi di programmi per i sistemi Dos, dovrebbero essere indicati utilizzando lettere maiuscole, e dovrebbero essere completi della loro estensione. |
Il testo ottenuto da listati di vario tipo, come i pezzi di un programma sorgente, il risultato dell'elaborazione di un comando, o il contenuto di una schermata, possono essere rappresentati convenientemente attraverso un ambiente di inclusione di testo letterale a spaziatura fissa. Generalmente, con LinuxDoc si utilizza l'ambiente verb contenuto in tscreen (l'uso dell'ambiente code è sconsigliabile).
Il problema sta nel fatto che l'ampiezza di tale testo non può superare i margini del corpo del documento, in base al tipo di impaginazione finale che si ritiene dover applicare. Infatti, tale testo non può essere continuato nella riga successiva perché ciò costituirebbe un'alterazione delle informazioni che si vogliono mostrare.
Generalmente, non è possibile superare un'ampiezza di 80 colonne, pari a quella di uno schermo a caratteri normale.
|
I nomi di variabili di ambiente dovrebbero essere rappresentati attraverso un tipo di carattere a spaziatura fissa. |
|
I nomi di questi tipi di entità sono sensibili alla differenza tra maiuscole e minuscole. Per questo vanno scritti sempre così come sono, anche quando si trovano all'inizio o all'interno di un periodo. |
|
A seconda del tipo di documentazione, potrebbe essere stata definita la convenzione per cui queste debbano essere indicate sempre precedute dal simbolo dollaro ( |
La scelta di rappresentare le variabili utilizzando il dollaro come prefisso è motivata dalla facilità con cui questa può essere identificata durante la lettura del testo. Tuttavia, questa scelta potrebbe essere discutibile, perché il dollaro non appartiene al nome della variabile, e perché potrebbe indurre il lettore a utilizzarlo sempre, anche quando negli script non si deve. Quindi, il buon senso deve guidare nella decisione finale.
A volte si ha la necessità di indicare un comando, o un'istruzione, all'interno del testo normale. Per questo, è opportuno utilizzare un carattere a spaziatura fissa, come nel caso dei nomi di file e directory, però qui si pone un problema nuovo dovuto alla possibile presenza di spazi e trattini. I programmi di composizione normali tendono a interrompere le righe, quando necessario, in corrispondenza degli spazi ed eventualmente anche dei trattini. Se il comando o l'istruzione che si scrive è breve, è consigliabile l'utilizzo di spazi e trattini non interrompibili. *7*
Quando si utilizza SGML (compreso HTML), si può usare l'entità per indicare uno spazio non interrompibile, mentre se si usa solo LaTeX, è il carattere tilde (~) che ha questa funzione.
Il problema del trattino non è semplice, perché non esiste un trattino generico non separabile, fine a se stesso. Di trattini ne esistono di varie misure e non sempre esistono corrispondenti per diversi tipi di programmi di composizione.
Quando si fa riferimento al nome di un programma si pongono due alternative: l'indicazione del file eseguibile oppure del nome attribuito dall'autore al suo applicativo.
Per comprendere la differenza, si può pensare a Apache: il server HTTP. Non si tratta di un semplice eseguibile, ma di un applicativo composto da diverse parti, in cui l'eseguibile è httpd. Nello stesso modo, nel caso di Perl (il linguaggio di programmazione), si può pensare all'applicativo in generale, composto dalle librerie e tutto ciò che serve al suo funzionamento; oppure si può voler fare riferimento solo all'eseguibile: perl.
|
I nomi di programmi applicativi vanno indicati nello stesso modo in cui lo fa il loro autore, rispettando l'uso delle maiuscole e delle minuscole, in qualunque posizione del testo. |
|
I nomi di questi tipi di entità non dovrebbero essere evidenziati in modo particolare. |
Ghostscript è un programma molto importante.
nanoBase è un semplice applicativo per Dos.
|
I concetti e i termini che non si ritengono familiari per il lettore, dovrebbero essere evidenziati la prima volta che si presentano. |
Per questo tipo di evidenziazione si utilizza un neretto oppure un corsivo. L'uso del neretto è contrario alla tradizione dei testi italiani, in cui questo viene fatto normalmente utilizzando solo il corsivo. Tuttavia, il neretto si presta meglio alla composizione in formati molto diversi; per esempio si ottiene facilmente anche su un documento da visualizzare attraverso uno schermo a caratteri.
Questo meccanismo permette di inserire le cosiddette entità interne, con cui si possono definire delle macro.
A volte è opportuno utilizzare termini stranieri, non tradotti. Quando si tratta di termini non ben acquisiti nel linguaggio comune, almeno per il pubblico a cui si rivolge il documento, è opportuno utilizzare il corsivo tutte le volte in cui il termine viene adoperato.
Un termine tecnico può essere o meno di uso comune per il pubblico di lettori a cui si rivolge: se si tratta di un termine considerato normale per quell'ambiente, non è il caso di usare alcuna evidenziazione.
L'indicazione di nomi che fanno riferimento a marchi di fabbrica o simili, va fatta come appare nel copyright o nella nota che fa riferimento al brevetto, rispettando l'uso delle maiuscole e dell'eventuale punteggiatura. Si dovrebbe evitare, quindi, di prendere in considerazione un eventuale logo grafico del prodotto. Non è opportuno fare risaltare maggiormente i nomi di questo tipo.
All'interno del testo non è conveniente fare riferimento al detentore del copyright o del brevetto. Di questo problema dovrebbero farsi carico delle note opportune all'inizio del documento che si scrive.
Sistema di stampa PostScript...
Scheda SCSI Adaptec...
Unità magneto-ottica FUJITSU...
Hewlett Packard
Nei testi di lingua italiana, i titoli vanno scritti come se si trattasse di testo normale, con le particolarità seguenti:
|
non viene mai posto il punto fermo finale; |
|
si cerca di evitare l'inserzione di altri segni di punteggiatura, a meno che ciò sia necessario per qualche motivo; |
|
non si usano evidenziazioni particolari di parole o nomi come invece potrebbe avvenire nel testo normale. |
Un documento a carattere tecnico viene normalmente suddiviso in segmenti a più livelli. Per avere maggiore facilità nella trasformazione del documento in diversi formati tipografici finali, conviene limitare la scomposizione a un massimo di due livelli. Nel caso di LinuxDoc, significa limitarsi a usare sect e sect1.
Gli elementi che non fanno parte del flusso normale di un documento, come tabelle e figure, sono accompagnate generalmente da un titolo e da una didascalia. Il titolo serve a identificarle, mentre la didascalia ne descrive il contenuto.
I titoli di tabelle, figure e oggetti simili, seguono le regole dei titoli normali, mentre il testo delle didascalie segue le regole del testo normale. Tuttavia, quando si utilizzano programmi di composizione che permettono di abbinare solo una nota descrittiva, che funga sia da titolo che da didascalia, occorre fare una scelta:
|
quando le note sono brevi, è opportuno che si comportino come i titoli, cioè non contengano simboli di punteggiatura; |
|
quando sono più lunghe, si può decidere di trattarle come didascalie vere e proprie, con tutti i simboli di punteggiatura necessari per una comprensione corretta del contenuto. |
Naturalmente, la scelta fatta deve valere per tutte le descrizioni che si abbinano a questi oggetti di un particolare documento: brevi o lunghe che siano.
Gli elenchi descrittivi, come quelli che si ottengono con LinuxDoc utilizzando la struttura seguente, possono essere insidiosi, perché potrebbero tradursi in modo differente a seconda del tipo di programma di composizione utilizzato.
<descrip> <tag>Primo elemento</tag> Descrizione del primo elemento,... Bla bla bla... </descrip> |
L'elemento descrittivo dell'elenco è in pratica un titolo che introduce una parte di testo generalmente rientrata. Sotto questo aspetto, questo titolo segue le regole già viste per i titoli. Tuttavia, il problema sta nel fatto che si potrebbe essere indotti a riprendere un discorso lasciato in sospeso quando veniva introdotto l'elenco, come nell'esempio seguente:
Bla bla bla bla... Primo elemento Descrizione del primo elemento,... Bla bla bla... Qui si riprende il discorso precedente all'elenco descrittivo. ... |
Infatti, l'utilizzo dei rientri fa percepire immediatamente la conclusione dell'elenco stesso. Quando si scrive un documento che deve poter essere convertito in molti formati differenti, che quindi potrebbe essere elaborato da programmi di composizione di vario tipo, può darsi che i rientri vengano perduti, e gli elementi descrittivi dell'elenco appaiano come dei titoli veri e propri. Ma se ciò accade, quando si ricomincia «il discorso lasciato in sospeso», sembra che questo appartenga all'argomento dell'ultimo titolo apparso.
Bla bla bla bla... Primo elemento Descrizione del primo elemento,... Bla bla bla... Qui si riprende il discorso precedente all'elenco descrittivo. ... |
Pertanto, se si vogliono utilizzare strutture di questo tipo, è consigliabile che appaiano alla fine di una sezione, quando quello che viene dopo è un titolo di una sezione o di qualcosa di simile.
I richiami in nota (le note a piè pagina e quelle alla fine del documento) sono composti con le stesse regole del testo normale. Quando il riferimento a una nota si trova alla fine di una parola cui segue un segno di interpunzione, è opportuno collocare tale riferimento dopo il simbolo di interpunzione stesso.
La costruzione di un indice analitico deriva dall'inserzione di riferimenti all'interno del testo, attraverso istruzioni opportune definite dal tipo di programma usato per la composizione.
LinuxDoc consente attualmente di inserire tali riferimenti all'interno del testo, utilizzando gli ambienti nidx e ncdx, che vengono poi gestiti solo nella composizione attraverso LaTeX, e ignorati in tutti gli altri casi. ncdx si usa per i nomi tecnici (file, directory, variabili di ambiente, ecc.), mentre nidx per tutti gli altri tipi di riferimento.
Le voci inserite in questi riferimenti, che poi formeranno l'indice generale, vanno scelte in modo da essere uniformi, secondo alcune regole molto semplici.
|
Si utilizzano le lettere minuscole, a meno che si tratti di nomi particolari che vanno sempre scritti in un modo prestabilito:
| ||||||||
|
Si utilizza solo il singolare; |
I riferimenti per la generazione dell'indice generale vanno posti preferibilmente nei luoghi opportuni, in modo da evitare inutili rimandi a pagine che non contengono ciò che si cerca. Per esempio, la parola file potrebbe trovarsi in quasi tutte le pagine di un testo di informatica, mentre sarebbe conveniente che l'indice analitico riporti solo le pagine in cui si parla del concetto che questa parola rappresenta.
I nomi di programmi eseguibili e di file di dati standard dovrebbero essere inseriti nell'indice analitico ogni volta che appaiono nel testo.
I riferimenti ad altri documenti dovrebbero contenere tutti gli elementi necessari a identificare la pubblicazione:
|
il titolo completo; |
|
l'autore; |
|
l'editore; |
|
la data di edizione; |
|
l'URI (se il documento è disponibile attraverso la rete). |
Generalmente è consigliabile comporre gli elenchi bibliografici indicando le opere a partire dall'autore, mettendo il titolo in testo corsivo o inclinato, e separando le varie componenti di ogni riferimento bibliografico attraverso delle virgole.
Claudio Beccari, LaTeX, Guida a un sistema di editoria elettronica, Hoepli, 1991
|
I riferimenti ad altri documenti, all'interno del testo normale, vanno fatti indicando il titolo completo, in corsivo o inclinato, e il nome dell'autore. |
|
Il titolo è separato con una virgola da un eventuale sottotitolo. |
|
I riferimenti a un testo già citato possono essere fatti utilizzando solo il titolo o solo l'autore, o attraverso altri mezzi, purché si sia certi di non creare ambiguità o disagio al lettore. |
Questa sezione fa riferimento a concetti contenuti in LaTeX, Guida a un sistema di editoria elettronica, di Claudio Beccari.
|
Michele Dalla Silvestra, Scrittura testi per l'ILDP |
|
Robert Kiesling, The LDP Style Mini-HOWTO |
|
Claudio Beccari, LaTeX, Guida a un sistema di editoria elettronica, Hoepli, 1991 |
|
Scienza, tecnologia e arte della stampa e della comunicazione: Giuseppe Orsello, Preparazione del manoscritto |
|
Marco Gaiarin, Linux Italian HOWTO |
|
Maurizio Pistone, Lingua italiana e altra linguistica http://www.freeweb.org/letteratura/pistone/linguaitaliana.html |
|
Dictionnaire panlatin de l'informatique |
|
NetGlos - The Multilingual Glossary of Internet Terminology |
|
Amiga Translators' Organization |
|
Dizionario di Informatica |
---------------------------
Appunti Linux 1999.07.12 --- Copyright © 1997-1999 Daniele Giacomini -- daniele @ evo.it
1.) Il vero artista è colui che crea qualcosa di nuovo e non accetta di sottostare alle regole generali. È evidente quindi che costui non potrà lavorare in un gruppo perché non si sottometterà mai alle regole poste dagli altri o dalla consuetudine.
2.) Secondo una regola della tipografia del passato, ormai generalmente condannata, era necessario aumentare lo spazio che divide la fine di un periodo dall'inizio del successivo. Per qualche ragione si trovano ancora documenti in lingua inglese che seguono questa regola, anche quando si tratta di file di testo.
3.) Purtroppo LaTeX segue la vecchia regola dell'allungamento dello spazio dopo il punto fermo che chiude il periodo, con l'aggravante che per riuscire a determinarlo può fare solo delle supposizioni, che a volte sono errate. Per fare in modo che LaTeX eviti di applicare questa regola errata, si può utilizzare il comando \frenchspacing nel preambolo del documento.
4.) Quando il sistema di composizione si basa su TeX, e si usano virgolette elevate, le virgolette doppie si ottengono preferibilmente attraverso una coppia di apici singoli aperti (``) e una coppia di apici singoli chiusi (''). In altri casi, soprattutto quando si tratta di file di testo puri e semplici, gli apici doppi si indicano con le virgolette normali ("...").
5.) TeX permette l'uso di tre trattini di lunghezza differente: il trattino corto che si ottiene con un trattino singolo, il trattino medio che si ottiene con due trattini in sequenza e il trattino lungo che si ottiene con tre. Nella lingua italiana vanno usati solo i primi due, dove il trattino medio di TeX corrisponde al trattino lungo della nostra grammatica.
6.) Nell'ambito della documentazione tecnica, sarebbe consigliabile di evitare l'uso di accentazioni non comuni, anche se queste potrebbero essere preferibili in ambienti più raffinati.
7.) Naturalmente questo ha senso se poi il programma di composizione non tenta di suddividere le parole in sillabe.
