Convenzioni di «a

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

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.

Unità di misura Descrizione
byte, Kibyte, Mibyte, Gibyte,
bit, Kibit, Mibit, Gibit
L'unità byte viene indicata al minuscolo, di seguito al suo moltiplicatore eventuale. In particolare: «Ki» sta per 210 = 1 024; «Mi» sta per 220 = 1 048 576; «Gi» sta per 230 = 1 073 741 824. L'unità di misura, con il suo moltiplicatore, viene indicata dopo e staccata dalla quantità a cui si riferisce.
bit/s, kbit/s, Mbit/s L'unità bit/s (nota comunemente come bps, ovvero Bit per second) viene indicata al minuscolo, di seguito al suo moltiplicatore eventuale. In questo caso si utilizzano i moltiplicatori standard del SI: «k» sta per 103 = 1 000; «M» sta per 106 = 1 000 000; «G» sta per 109 = 1 000 000 000. È importante ricordare che la lettera «k» deve essere minuscola.
In generale, è preferibile la notazione bit/s rispetto a bps, perché la seconda è in realtà un'abbreviazione e come tale sconsigliabile secondo il SI. A questo proposito, si può leggere Guide for the Use of the International System of Units (SI) edito dal NIST (National institute of standards and technology), http://physics.nist.gov/cuu/pdf/sp811.pdf, in particolare la sezione 6.1.8: Unacceptability of abbreviations for units.
Hz, kHz, MHz, GHz, THz L'unità «hertz», il cui simbolo è «Hz», viene indicata nel modo che si vede, di seguito al suo moltiplicatore eventuale. In questo caso si utilizzano i moltiplicatori tradizionali: «k» sta per 103 = 1 000; «M» sta per 106 = 1 000 000; «G» sta per 109 = 1 000 000 000; «T» sta per 1012 = 1 000 000 000 000. È importante ricordare che la lettera «k» deve essere minuscola.
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.
Ex La grandezza Ex rappresenta l'altezza di una lettera «x», nell'ambito del sistema di composizione tipografica utilizzato. Viene indicata nel testo in questo modo, con l'iniziale maiuscola, per evitare confusione. Nel caso della misura relativa alla lettera «M» maiuscola, si usa il termine quadratone.

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.

Valori numerici in lettere 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:

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 u113.2 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.

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

Eseguibile Applicativo, pacchetto, servizio, sistema,...
lilo, grub, syslinux LILO, GRUB, SYSLINUX
*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, eeyes Electric Eyes
xfm XFM
tcd, gtcd TCD

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:

Acronimo Descrizione completa Annotazioni
MTA Mail transfer agent
XML Extensible markup language
ORF Österreichischer Rundfunk Nella lingua tedesca i sostantivi hanno l'iniziale maiuscola.
MIME Multipurpose Internet mail extentions Il nome che contiene (Internet) si scrive comunemente con l'iniziale maiuscola.

Indice analitico

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

In particolare, l'indice analitico realizzato con il sistema di composizione di a2 consente l'uso di un carattere dattilografico attraverso l'uso dell'elemento code e delle forme di evidenziamento particolari per combinazioni di tasti (reali o virtuali) e per codici ASCII:

<indexentry>Perl: <code>print</code></indexentry>
<indexentry><code>/etc/profile</code></indexentry>
<indexentry><kbd>Ctrl c</kbd></indexentry>
<indexentry><kbd>Ctrl \</kbd></indexentry>
<indexentry><vkbd>Control c</vkbd></indexentry>
<indexentry><vkbd>Control \</vkbd></indexentry>
<indexentry><asciicode>^c</asciicode></indexentry>
<indexentry><asciicode>ETX</asciicode></indexentry>
<indexentry><asciicode>^\</asciicode></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.

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 a2 usa le convenzioni che vengono sintetizzate in questa sezione.

Tabella u113.10. Elenco dei caratteri speciali che si possono inserire nell'elemento asciicode.

Binario Esadecimale Ottale Decimale Carattere Sigla equivalente
000000002 0016 0008 00010 <NUL>
000000012 0116 0018 00110 <SOH> <^a>
000000102 0216 0028 00210 <STX> <^b>
000000112 0316 0038 00310 <ETX> <^c>
000001002 0416 0048 00410 <EOT> <^d>
000001012 0516 0058 00510 <ENQ> <^e>
000001102 0616 0068 00610 <ACK> <^f>
000001112 0716 0078 00710 <BEL> <^g>
000010002 0816 0108 00810 <BS> <^h>
000010012 0916 0118 00910 <HT> <^i>
000010102 0A16 0128 01010 <LF> <^j>
000010112 0B16 0138 01110 <VT> <^k>
000011002 0C16 0148 01210 <FF> <^l>
000011012 0D16 0158 01310 <CR> <^m>
000011102 0E16 0168 01410 <SO> <^n>
000011112 0F16 0178 01510 <SI> <^o>
000100002 1016 0208 01610 <DLE> <^p>
000100012 1116 0218 01710 <DC1> <^q>
000100102 1216 0228 01810 <DC2> <^r>
000100112 1316 0238 01910 <DC3> <^s>
000101002 1416 0248 02010 <DC4> <^t>
000101012 1516 0258 02110 <NAK> <^u>
000101102 1616 0268 02210 <SYN> <^v>
000101112 1716 0278 02310 <ETB> <^w>
000110002 1816 0308 02410 <CAN> <^x>
000110012 1916 0318 02510 <EM> <^y>
000110102 1A16 0328 02610 <SUB> <^z>
000110112 1B16 0338 02710 <ESC> <^[>
000111002 1C16 0348 02810 <FS> <^\>
000111012 1D16 0358 02910 <GS> <^]>
000111102 1E16 0368 03010 <RS> <^^>
000111112 1F16 0378 03110 <US> <^_>
001000002 2016 0408 03210 <SP>
011111112 7F16 1778 12710 <DEL>

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 riquadro (l'elemento object) fisso, che, a seconda di ciò che si preferisce, possa essere spezzato o meno:

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

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.

Per quanto riguarda l'uso di linee e bordi di separazione, all'inizio del sorgente sono dichiarate alcune macro per la definizione dello stile, in modo da consentire in un secondo momento di cambiare l'aspetto generale. Si distinguono i casi seguenti, dimostrati da esempi:

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.

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 RM. Di solito si fanno queste annotazioni utilizzando delle note a piè pagina. 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:

<![%RM;[<footnote><strong>ATTENZIONE</strong>:
questa notizia proviene da una ricerca fatta...
così e così...</footnote>]]><!--%RM;-->
<![%RM;[ <footnote><strong>SISTEMARE</strong>:
manca da analizzare la questione relativa
alla...</footnote>]]><!--%RM;-->

«a2» 2013.11.11 --- Copyright © Daniele Giacomini -- appunti2@gmail.com http://informaticalibera.net