5. Conventions de style

Cette section fournit des informations sur les conventions adopt�es par le LDP dans le but de donner le m�me style � tous ses documents. Gardez ces conseils en m�moire lors de la r�daction de votre document.

5.1. Format des dates

La balise <pubdate>, dans l'en-t�te, doit encadrer un texte de la forme suivante�:

v1.0, 21 Avril 2000

5.2. Utilisation des images

Si vous devez envoyer des images avec votre document, envoyez pour chaque image une version au format EPS et une autre au format GIF ou JPEG. Bien qu'il donne de meilleurs r�sultats que le format JPEG, faites attention au probl�me des brevets sur le format GIF.

5.3. Versions de DocBook

Seule la version 3.1 de DocBook est support�e par le LDP pour le moment. Le LDP envisage l'utilisation future de la version 4.0. La plupart des documents en version 3.1 peuvent �tre facilement convertis en 4.0 en �vitant d'utiliser les balises obsol�tes.

L'en-t�te DocBook de votre document devrait ressembler � ceci�:

<!doctype article public "-//OASIS//DTD
DocBook V3.1//EN">

5.4. Balises obsol�tes

Le LDP encourage � ne pas utiliser les balises indiqu�es comme obsol�tes dans le livre DocBook: The Definitive Guide. La mani�re d'utiliser les nouvelles balises est indiqu�e dans la section Trucs et Astuces.

5.5. R�duction des balises

La r�duction des balises consiste � utiliser </> � la place de la forme compl�te de fin de balise (comme </para>). Puisque cette pratique rend le document plus confus pour les futurs auteurs et les membres du LDP, et qu'elle n'est pas permise en DocBook XML, il est demand� de l'�viter.

5.6. Conventions

Les conventions sur les diff�rents types de texte sont les suivantes�:

Si vous voulez montrer l'utilisation d'une commande, mettez-la sous la forme d'une vraie ligne de commande sous shell. L'invite de l'interpr�teur de commande doit contenir le nom du shell (bash, tcsh, zsh, etc.) suivi de $ pour les commandes d'un utilisateur normal ou # pour les commandes du super-utilisateur (root).

Ainsi une commande devrait ressembler � ceci�:

bash$ command "en tant qu'utilisateur normal" 
bash# command "en tant que root"
tcsh# setenv DISPLAY :0.0 

Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:30