1. Conventions de documentation
Ce manuel utilise plusieurs conventions pour souligner l'importance de certains mots ou expressions, mais aussi en vue d'attirer l'attention sur certains passages d'informations précis.
1.1. Conventions typographiques
Quatre conventions typographiques sont utilisées pour attirer l'attention sur certains mots et expressions. Ces conventions, et les circonstances auxquelles elles s'appliquent, sont les suivantes.
Caractères gras à espacement fixe
Utilisé pour surligner certaines entrées du systèmes comme les commandes de console, les noms de fichiers et les chemins d'accès. Également utilisé pour surligner les touches et les combinaisons de touches principales. Par exemple:
Pour voir le contenu du fichier mon_nouvel_ouvrage_littéraire qui se trouve dans votre répertoire en cours, saisir la commande cat mon_nouvel_ouvrage_littéraire par invitation-console et appuyer sur Enter (entrer) pour exécuter la commande.
Cela comprendra un nom de fichier, une commande-console et un nom de touche, tous présentés sous forme de caractères gras à espacement fixe et tous bien distincts grâce au contexte.
Les combinaisons-clé sont différenciées des noms de touches par le trait d'union qui fait partie de chaque combinaison-clé. Ainsi:
Appuyer sur Enter (entrer) pour exécuter la commande.
Appuyer sur Ctrl+Alt+F1 pour passer au premier terminal virtuel. Appuyer sur Ctrl+Alt+F7 pour retourner à votre session X-Windows.
La première phrase surligne la touche précise sur laquelle il faut appuyer. La seconde surligne deux ensemble de trois touches, à presser simultanément séparémment.
Si le code source est mentionné, les noms de classe, les méthodes, les fonctions, les noms de variables et les valeurs de retour citées dans un paragraphe seront présentées comme ci-dessus, en caractères gras à espacement fixe . Par exemple:
Les classes fichier comprennent le nom de classe filesystem pour les noms de fichier, file pour les fichiers, et dir pour les répertoires. Chaque classe correspond à un ensemble de permissions associées.
Caractères gras proportionnels
Cela surligne des mots ou expressions que l'on rencontre dans le système, comprenant des noms d'application, des fenêtres de dialogue texte, des boutons étiquetés, des cases à cocher et des boutons d'options; enfin, des intitulés de menus et de sous-menus. Ainsi:
Sélectionner à partir de la barre de menu principal pour lancer l'appication souris Mouse Preferences. A partir de l'onglet Buttons (Boutons), cliquer sur la case à cocher Left-handed mouse (souris main gauche) et cliquer sur Close (Fermeture) pour faire passer le bouton principal de la souris de la gauche vers la droite (ce qui permet l'utilisation de la souris par la main gauche).
Pour insérer un caractère spécial dans le fichier gedit choisir à partir de la barre du menu principal. Ensuite, sélectionner à partir de la barre de menu de l'application Character Map, taper le nom du caractère dans le champ Search et cliquer Next (Suite). Le caractère que vous cherchiez sera surligné dans la Character Map (Table de caractères). Cliquez deux fois sur ce caractère surligné pour l'insérer dans le champ Text to copy (texte à copier), puis cliquer sur le bouton Copy (copier) . Maintenant, revenez à votre document, et sélectionner à partir de la barre de menu gedit.
Le texte ci-dessus comprend des noms d'application, des noms de menu et autres s'appliquant à l'ensemble du système, des noms de menu pour applications particulières; et des boutons et textes que l'on trouve dans l'interface GUI, tous présentés sous la forme Gras proportionnelle et identifiables en fonction du contexte.
Remarquez l'écriture raccourcie utilisée pour les traverses de menu et de sous-menus. Cela permet d'éviter l'approche difficile d'abord 'Sélectionner à partir du sous-menu dans le menu de la barre de menu principale .'
Italique gras à espacement fixe Italique gras proportiionnel
Qu'ils soient en caractères gras à espacement fixe ou à caractères gras proportionnels, l'ajout des italiques indique la présence de texte remplaçable ou variable. Les caractères en italique indiquent la présence de texte que vous ne saisissez pas littéralement ou de texte affiché qui change suivant les circonstances. Par exemple:
Pour connecter à une machine éloignée en utilisant ssh, taper ssh nom d'utilisateur@domain.name (nom.domaine) par invitation de la console. Si la machine éloignée est exemple.com et que votre nom d'utilisateur pour cette machine est john, tapez ssh john@example.com.
La commande mount -o remount du système de fichiers remonte jusqu'au nom du système de fichiers. Ainsi, pour remonter au /home du système de fichier, la commande est mount -o remount /home.
Pour voir la version d'un package actuellement installé, utiliser la commande du package rpm -q package-version-release
Notez les mots en caractères italique gras au dessus de — nom d'utilisateur, domain.name, système fichier, package, version et mise à jour. Chaque mot est un signet, soit pour le texte que vous saisissez suite à l'activation d'une commande, soit pour le texte affiché par le système.
Mis à part l'utilisation habituelle de présentation du titre d'un ouvrage, les caractères italiques indiquent l'utilisation initiale d'un terme nouveau et important. Ainsi:
Quand le serveur Apache HTTP enregistre des demandes, il envoie des threads ou des processes enfant pour les traiter. Ce groupe de threads ou processes enfant est connu en tant que serveur-pool. Sous Apache HTTP Server 2.0, on a donné la responsabilité de créer et de maintenir ces pools-de-serveurs à un groupe de modules intitulé Multi-Processing Modules (MPMs). A la différence des autres modules, un seul module du groupe MPM ne peut être chargé par le serveur Apache HTTP.
1.2. Conventions pour citations mises en vedette
Deux types de données, normalement présentées sur lignes multiples, ressortent visuellement du texte avoisinant.
Les sorties envoyées vers un terminal sont en caractères Romains à espacement fixe et présentés ainsi:
books Desktop documentation drafts mss photos stuff svn
books_tests Desktop1 downloads images notes scripts svgs
Des listings code-source sont également présentés en espaces romains à espacemnt fixe mais sont présentés et surlignés comme suit:
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"));
}
}