|
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.
La balise <pubdate>, dans l'en-tête, doit encadrer un texte de la forme suivante :
v1.0, 21 Avril 2000 |
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.
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"> |
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.
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.
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