Confall, document général d'un système Linux | ||
---|---|---|
Précédent |
La première aide est en reportant les erreurs qui auraient pu s'introduire dans les explications, par inadvertance ou par manque de connaissances de ce qui est expliqué. Au bien d'améliorer la section, pour quelle soit plus facile à comprendre.
L'autre manière est d'écrire une section dans ce document sur quelque chose qui n'a pas encore été traitée. Pour cela il vous suffit d'écrire un chapitre dans un fichier que vous enverrez par mail. Pour cela le plus facile est de regarder comment est écrit un autre chapitre. Le document est en DocBook, si vous lisez ceci dans un autre format (ce qui est probablement le cas) reportez vous à la section DocBook pour savoir comment écrire du DocBook. Si vous n'avez pas le courage d'utiliser DocBook, mettez tout de même deux trois élément DocBook, sans rien installer. Cela permettra l'intégration de votre document sans le modifier, pour cela regardez l'exemple suivant, il donne un exemple d'utilisation des tags que l'on utilise le plus souvent.
Exemple 14-1. Ecriture d'un chapitre en DocBook
<chapter> <title>Le titre du document</title> <section> <title>Le titre de la section 1</title> <section> <title>Le titre de la sous section de la section 1</title> ... </section> ... </section> <section> <title>Le titre de la section 2</title> <para> un paragraphe de texte. <ulink url="http://lesiteweb.fr">avec un lien hypertext</ulink> </para> <para> ... <example> <title>Titre de l'exemple</title> <programlisting><![CDATA[ ... ]]></programlisting> </example> <figure> <title>Le titre de la figure</title> <graphic fileref="le_nom_du_fichier_de_l_image"></graphic> </figure> </para> </section> </chapter>