1. Convenzioni del documento
Questo manuale utilizza numerose convenzioni per evidenziare parole e frasi, ponendo attenzione su informazioni specifiche.
1.1. Convenzioni tipografiche
Vengono utilizzate quattro convenzioni tipografiche per richiamare l'attenzione su parole e frasi specifiche. Queste convenzioni, e le circostanze alle quali vengono applicate, sono le seguenti.
Neretto monospazio
Usato per evidenziare l'input del sistema, incluso i comandi della shell, i nomi dei file ed i percorsi. Utilizzato anche per evidenziare tasti singoli e combinazione di tasti. Per esempio:
Per visualizzare i contenuti del file my_next_bestselling_novel nella vostra directory di lavoro corrente, inserire il comando cat my_next_bestselling_novel al prompt della shell e premere Invio per eseguire il comando.
Quanto sopra riportato include un nome del file, un comando della shell ed un tasto, il tutto riportato in Neretto monospazio e distinguibile grazie al contesto.
Le combinazioni di tasti possono essere distinte dalle chiavi singole, tramite il trattino che collega ogni parte della combinazione di tasti. Per esempio:
Premere Invio per eseguire il comando.
Premere Ctrl+Alt+F1 per smistarsi sul primo virtual terminal. Premere Ctrl+Alt+F7 per ritornare alla sessione X-Windows.
La prima frase evidenzia il tasto specifico singolo da premere. La seconda evidenzia due set di tre tasti, ogni set viene premuto simultaneamente.
Se si affronta il codice sorgente, i nomi della classe, i metodi, le funzioni i nomi della variabile ed i valori ritornati indicati all'interno di un paragrafo, essi verranno indicati come sopra, e cioè in Neretto monospazio. Per esempio:
Le classi relative ad un file includono filesystem per file system, file per file, e dir per directory. Ogni classe possiede il proprio set associato di permessi.
Neretto proporzionale
Ciò denota le parole e le frasi incontrate su di un sistema, incluso i nomi delle applicazioni; il testo delle caselle di dialogo; i pulsanti etichettati; le caselle e le etichette per pulsanti radio, titoli del menu e dei sottomenu. Per esempio:
Selezionare dalla barra del menu principale per lanciare Preferenze del mouse. Nella scheda Pulsanti, fate clic sulla casella di dialogo mouse per mancini, e successivamente fate clic su Chiudi per cambiare il pulsante primario del mouse da sinistra a destra (rendendo così il mouse idoneo per un utilizzo con la mano sinistra).
Per inserire un carattere speciale in un file gedit, selezionare dalla barra menu principale. Successivamente, selezionare dalla barra del menu Mappa carattere, inserire il nome del carattere nel campo Cerca e cliccare Successivo. Il carattere ricercato verrà evidenziato nella Tabella caratteri. Fate un doppio clic sul carattere evidenziato per posizionarlo nel campo Testo da copiare, e successivamente fate clic sul pulsante Copia. Ora ritornate al vostro documento e selezionate dalla barra del menu di gedit.
Il testo sopra riportato include i nomi delle applicazioni; nomi ed oggetti del menu per l'intero sistema; nomi del menu specifici alle applicazioni; e pulsanti e testo trovati all'interno di una interfaccia GUI, tutti presentati in Neretto proporzionale e distinguibili dal contesto.
Da notare l'abbreviazione usata per andare da un menu e sottomenu relativi. Tale operazione viene eseguita per evitare l'uso di 'Seleziona dal sottomenu nel menu della barra principale del menu.
Corsivo neretto monospazioCorsivo neretto proporzionale
Sia se si tratta di Corsivo neretto monospazio o Corsivo neretto proporzionale, l'aggiunta del carattere Corsivo indica un testo variabile o sostituibile . Il carattere Corsivo denota un testo che non viene inserito letteralmente, o visualizzato che varia a seconda delle circostanze. Per esempio:
Per collegarsi ad una macchina remota utilizzando ssh, digitare ssh username@domain.name al prompt della shell. Se la macchina remota è example.com ed il nome utente sulla macchina interessata è john, digitare ssh john@example.com.
Il comando mount -o remount file-system rimonta il file system indicato. Per esempio, per rimontare il file system /home, il comando è mount -o remount /home.
Per visualizzare la versione di un pacchetto attualmente installato, utilizzare il comando rpm -q package. Esso ritornerà il seguente risultato: package-version-release
Da notare la parola in Corsivo neretto — nome utente, domain.name, file-system, pacchetto, versione e release. Ogni parola racchiude il testo da voi inserito durante l'emissione di un comando o per il testo mostrato dal sistema.
Oltre all'utilizzo normale per la presentazione di un titolo, il carattere Corsivo denota il primo utilizzo di un termine nuovo ed importante. Per esempio:
Quando il server HTTP Apache accetta le richieste, esso invia i processi figlio o thread per la loro gestione. Questo gruppo di processi figlio o thread è conosciuto come server-pool. Con Apache HTTP Server 2.0, la responsabilità per la creazione e gestione di questi server-pool si riassume in un gruppo di moduli chiamati Multi-Processing Modules (MPMs). Diversamente da altri moduli, solo un modulo dal gruppo MPM può essere caricato del server HTTP Apache.
1.2. Convenzioni del documento
Due tipi di dati, comunemente con più righe, vengono evidenziati rispetto al testo circostante.
L'output inviato ad un terminale è impostato su Tondo monospazio e così presentato:
books Desktop documentation drafts mss photos stuff svn
books_tests Desktop1 downloads images notes scripts svgs
Gli elenchi del codice sorgente sono impostati in Mono-spaced Roman ma vengono presentati ed evidenziati nel modo seguente:
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object ref = iniCtx.lookup("EchoBean");
EchoHome home = (EchoHome) ref;
Echo echo = home.create();
System.out.println("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}
1.3. Note ed avvertimenti
E per finire, tre stili vengono usati per richiamare l'attenzione su informazioni che in caso contrario potrebbero essere ignorate.
Nota Bene
Una nota è un suggerimento o un approccio alternativo per il compito da svolgere. Non dovrebbe verificarsi alcuna conseguenza negativa se la nota viene ignorata, ma al tempo stesso potreste non usufruire di qualche trucco in grado di facilitarvi il compito.
Importante
Caselle importanti riportano informazioni che potrebbero passare facilmente inosservate: modifiche alla configurazione applicabili solo alla sessione corrente, o servizi i quali necessitano di un riavvio prima di applicare un aggiornamento. Ignorare queste caselle non causa alcuna perdita di dati, ma potrebbe causare irritazione e frustrazione da parte dell'utente.
Avvertenza
Un avvertimento non dovrebbe essere ignorato. Se ignorato, potrebbe verificarsi una perdita di dati.