[successivo] [precedente] [inizio] [fine] [indice generale] [violazione GPL] [translators] [docinfo] [indice analitico] [volume] [parte]


Capitolo 276.   Convenzioni di «Appunti di informatica libera»

Questo capitolo raccoglie alcune convenzioni importanti relative all'opera Appunti di informatica libera. Le annotazioni sulla terminologia sono separate in un altro capitolo.

276.1   Unità di misura e moltiplicatori

In informatica si utilizzano delle unità di misura e dei moltiplicatori ben conosciuti, ma senza uno standard simbolico ben definito. Nel testo di questo documento si usano le convenzioni elencate nel seguito.

In particolare è bene distinguere tra il nome di un'unità di misura e il simbolo che la rappresenta: quando si parla dell'unità si usa il nome esteso, minuscolo; quando si indica un valore si deve usare il simbolo. In altri termini, si può parlare di hertz in generale, ma poi si indicano n Hz per indicarne una quantità precisa.

Quando si nominano i prefissi moltiplicatori, come «mega», «giga» e «tera», si usano le iniziali minuscole anche se il simbolo corrispondente è dato dalla loro iniziale maiuscola.

276.2   Casi particolari di testo che non viene enfatizzato

Alle volte verrebbe da enfatizzare di tutto. Qui si annotano le cose che per regola non vengono enfatizzate.

276.3   Valori numerici in lettera e in cifre

I valori numerici da zero a nove vengono rappresentati preferibilmente in lettere, soprattutto per evitare ambiguità nella lettura, a meno che si presentino le condizioni seguenti:

276.4   Distinzione nell'uso dei nomi degli applicativi

In generale, in questo documento, i nomi riferiti a degli «eseguibili», ovvero i programmi e gli script, sono indicati in modo evidenziato, esattamente come si utilizzano nel sistema operativo, senza cambiamenti nella collezione alfabetica delle lettere maiuscole e minuscole. Quando però il programma riveste un'importanza particolare, può assumere una denominazione diversa da quella che si usa nel nome del file eseguibile, oppure semplicemente si può decidere di trattarlo come qualcosa di più importante.

Per fare un esempio pratico, quando si parla di shell si fa riferimento alla shell Bash, alla shell Korn, alla shell C,... mentre l'eseguibile vero e proprio potrebbe essere bash, ksh, csh,... Lo stesso vale per i programmi che meritano questa attenzione anche se il loro nome (verbale) non cambia.

In generale, il nome di un programma applicativo, di un pacchetto o di altre situazioni analoghe, viene indicato con l'iniziale maiuscola, salvo eccezioni che possono derivare dall'uso acquisito in una qualche forma differente, escludendo a ogni modo l'uso di sole lettere minuscole.

Il nome di un programma eseguibile va annotato in forma dattilografica, esattamente come deve essere scritto per avviarlo, ovvero come indicato nel file system. Nell'ambito dello stile dell'opera, quando si scrive il nome di un programma senza voler fare riferimento al file eseguibile, il nome in questione non può essere annotato usando solo lettere minuscole, anche se l'autore originale fa così.

La tabella 276.1 elenca alcune delle scelte di stile nell'uso dei nomi dei programmi distinguendo tra «eseguibile» e qualcosa di diverso: applicativo, pacchetto, servizio, sistema e simili, riferite a forme che costituiscono un'eccezione rispetto alla regola generale.(2)

Tabella 276.1. Stile nell'uso dei nomi dei programmi distinguendo tra «eseguibile» e «applicativo», limitatamente ad alcune eccezioni.

Eseguibile Applicativo, pacchetto, servizio, sistema,...
lilo LILO
*getty Getty
getty, uugetty Getty_ps
mgetty Mgetty+Sendfax
bash shell Bash
csh shell C
ksh shell Korn
sh shell Bourne
init Procedura di inizializzazione del sistema, Init
cron (demone) Cron (sistema)
inetd supervisore dei servizi di rete
tcpd TCP wrapper
portmap Portmapper
named BIND (pacchetto)
telnet Telnet (programma)
TELNET (protocollo o servizio)
finger Finger (servizio)
sendmail Sendmail
mail Mailx
ex EX
vi VI
joe Joe
m4 M4
mc Midnight Commander
nsgmls SP
sgmlspl SGMLSpm
gs Ghostscript
bmv BMV
ghostview Ghostview
gv GV
xpaint XPaint
ee Electric Eyes
xfm XFM
tcd, gtcd TCD
xcdroast X-CD-Roast

276.5   Descrizione degli acronimi

Gli acronimi non sono sempre ottenuti con le sole iniziali delle parole che compongono il nome di qualcosa; inoltre, non c'è alcuna necessità pratica nell'evidenziare la corrispondenza tra le lettere usate e la frase corrispondente. In questo senso, la descrizione degli acronimi che si fa con l'elemento dacronym ha un aspetto uniforme: l'iniziale maiuscola e il resto del testo in minuscolo, tranne nel caso in cui si tratti di termini che rappresentano dei nomi importanti o degli altri acronimi, oppure quando la lingua di origine impone l'uso della maiuscola. Seguono alcuni esempi:

276.6   Indice analitico

Il problema della costruzione di un indice analitico è già trattato nel capitolo sullo stile letterario in generale. All'interno dell'opera Appunti di informatica libera ci sono delle particolarità che è bene precisare.

In particolare, l'indice analitico realizzato con il sistema di composizione di Appunti di informatica libera consente l'uso di un carattere dattilografico attraverso l'uso dell'elemento code, oppure assegnando il valore code all'attributo emph:


<indexentry>Perl: <code>print</code></indexentry>


<indexentry><code>/etc/profile</code></indexentry>

I riferimenti per la generazione dell'indice analitico vanno posti preferibilmente nel titolo della sezione a cui fanno riferimento, come nell'esempio seguente:


<H3>
Copie di sicurezza
<indexentry>salvataggio: copia di sicurezza</indexentry>
<indexentry>salvataggio: recupero dei dati</indexentry>
</H3>

Come si vede, viene indicato prima il titolo e subito dopo l'elenco dei riferimenti da inserire nell'indice, che riguardano la sezione.

Inserendo le voci dell'indice analitico nell'ambito del titolo di una sezione, si comprende che non abbia senso ripetere la stessa voce nelle sottosezioni relative.

276.7   Enfatizzazioni e uso degli elementi «special»

La gestione corretta delle «enfatizzazioni» è sempre un problema serio di coerenza, soprattutto se si considera il fatto che l'enfatizzazione non implica solo la composizione finale con un aspetto particolare, ma anche la classificazione dell'oggetto per qualche fine. In particolare, l'elemento special non genera alcuna enfatizzazione, ma serve a dare una classificazione al termine inserito, per qualche ragione. L'opera Appunti di informatica libera usa le convenzioni che vengono sintetizzate in questa sezione.

276.8   Rappresentazione del contenuto di file e dei flussi standard

In generale, il contenuto di un file o quanto emesso da un programma attraverso standard output e standard error, viene rappresentato in un elemento per il testo preformattato. Tuttavia, si manifestano dei problemi estetici, dovuti alla suddivisione del testo in pagine e al riconoscimento del contesto.

Per controllare la possibilità o meno di spezzare il testo tra più pagine, si inserisce l'elemento che lo contiene in un listato (l'elemento listing) fisso, che, a seconda di ciò che si preferisce, possa essere spezzato o meno:


<listing pos="fixed" split="0">
...
...
</listing>

In questo caso, evidentemente, si tratta di un listato che non si può spezzare; la scelta se mantenere unito o consentire la divisione in più pagine dipende naturalmente dalla lunghezza del testo.

In particolare, il listato riferito al contenuto di un file su disco (che può essere anche uno script), viene delimitato con una linea orizzontale, all'inizio e alla fine, anche quando si tratta di una sola riga di testo; mentre quanto emesso attraverso lo standard output o standard error non viene delimitato. Tuttavia, se il comportamento è molto simile a quello di un programma interattivo che usa delle schermate intere, o comunque se il contesto lo suggerisce, si può usare un listato bordato, ma ciò deve avvenire in modo coerente con la sezione in cui è contenuto.

276.9   Altri problemi di coerenza nell'uso degli elementi SGML

La coerenza in ciò che poi si traduce in forme di enfatizzazione del testo è la cosa più importante da definire e anche la più difficile da mantenere. Tuttavia, ci sono altre considerazioni da fare su elementi che potrebbero sembrare più ovvi.

276.10   Sezioni marcate per le annotazioni

Vengono usate delle sezioni marcate per inserire delle annotazioni da ottenere solo nella stampa di bozze. Queste sezioni marcate fanno riferimento all'entità parametrica ANNOTAZIONI. Di solito si fanno queste annotazioni utilizzando delle note a piè pagina, usando l'elemento blockfootnote, che permette di non intaccare un blocco di testo normale. Si distinguono due tipi di segnalazioni: un'informazione da ricordare e un problema non risolto, da sistemare in un secondo momento. Si osservino i due esempi seguenti:


<![%ANNOTAZIONI;[

    <blockfootnote><strong>ATTENZIONE</strong> --- questa notizia
    proviene da una ricerca fatta... così e così...</blockfootnote>

]]><!--%ANNOTAZIONI;-->


<![%ANNOTAZIONI;[

    <blockfootnote><strong>SISTEMARE</strong> --- manca da analizzare
    la questione relativa alla...</blockfootnote>

]]><!--%ANNOTAZIONI;-->

A differenza delle altre sezioni marcate normali, queste vengono incolonnate come i blocchi di testo:


<ul>
<li>

    <p>Bla bla bla bla...</p>

    <![%ANNOTAZIONI;[

        <blockfootnote><strong>SISTEMARE</strong> --- manca da analizzare
        la questione relativa alla...</blockfootnote>

    ]]><!--%ANNOTAZIONI;-->
    
    <p>Bla bla bla bla...</p>

</li>
<li>

    ...

</li>
</ul>

Appunti di informatica libera 2003.01.01 --- Copyright © 2000-2003 Daniele Giacomini -- daniele @ swlibero.org

1) Le unità di misura del SI, si nominano senza iniziale maiuscola. Tuttavia, il simbolo attribuito all'unità di misura è stato espresso con un'iniziale maiuscola quando questo derivava dal nome di una persona. Per esempio, questo è il caso di Hertz, di Alessandro Volta e di altri.

2) Un elenco più completo di come sono stati scritti i nomi degli applicativi può essere ottenuto dalla sezione 414, che contiene il riepilogo delle licenze.


Dovrebbe essere possibile fare riferimento a questa pagina anche con il nome convenzioni_di_laquo_appunti_di_informatica_libera_raquo.html

[successivo] [precedente] [inizio] [fine] [indice generale] [violazione GPL] [translators] [docinfo] [indice analitico]