Introduction au Projet de Documentation de FreeBSD pour les nouveaux participants

Nik Clayton

Copyright © 1998, 1999 Nik Clayton

Merci de votre participation au Projet de Documentation de FreeBSD. Votre contribution est très utile.

Cette introduction décrit tout ce que vous devez savoir pour commencer à participer au projet de documentation de FreeBSD, des outils et logiciels que vous utiliserez (indispensables et facultatifs) à la philosophie sous-jacente au Projet de Documentation.

Ce document est en cours de rédaction et n'est pas terminé. Les sections inachevées sont indiquées par un astérisque - * - qui précède leur nom.

Version française de Frédéric Haby .

[ Multiples pages HTML / Page HTML unique ]
Table des matières
Préface
Invites de l'interpréteur de commandes
Conventions Typographiques
Notes, avertissements et exemples
Remerciements
1. Introduction
1.1. Le jeu de documentations de FreeBSD
1.2. Avant de commencer
2. Outils
2.1. Outils indispensables
2.1.1. Logiciels
2.1.2. DTDs et Entités
2.1.3. Feuilles de style
2.2. Outils facultatifs
2.2.1. Logiciels
3. Introduction à SGML
3.1. Introduction
3.2. Eléments, marques et attributs
3.2.1. A faire…
3.3. La déclaration DOCTYPE
3.3.1. Formal Public Identifiers (FPIs) - Identifiants Publics Officiels
3.3.2. Alternatives aux FPIs
3.4. Revenir au SGML
3.5. Commentaires
3.5.1. A faire…
3.6. Entités
3.6.1. Entités Générales
3.6.2. Entités paramètres
3.6.3. A faire…
3.7. Utiliser les entités pour inclure des fichiers
3.7.1. Utiliser les entités générales pour inclure des fichiers
3.7.2. Utiliser les entités paramètres pour inclure des fichiers
3.7.3. A faire…
3.8. Sections marquées
3.8.1. Mots-clés pour les sections marquées
3.8.2. A faire…
3.9. Conclusion
4. Marques SGML
4.1. HTML
4.1.1. Formal Public Identifier (FPI) - Identifiant Public Formel
4.1.2. Sections
4.1.3. Eléments de blocs
4.1.4. Eléments
4.1.5. Liens
4.2. DocBook
4.2.1. Extensions FreeBSD
4.2.2. Identifiant Public Formel - Formal Public Identifier, (FPI)
4.2.3. Structure des documents
4.2.4. Eléments de blocs
4.2.5. Eléments en ligne
4.2.6. Liens
4.3. * LinuxDoc
5. * Feuilles de style
5.1. * DSSSL
5.2. * CSS
6. * La Foire Aux Questions
7. * Le Manuel de Référence
7.1. Organisation logique
7.2. Organisation physique
7.2.1. Makefile
7.2.2. handbook.xml
7.2.3. répertoire/chapter.xml
7.3. Guide de style
7.3.1. Majuscules et minuscules
7.3.2. Indentation
7.3.3. Modifications de présentation des sources
7.4. * Conversion du Manuel dans d'autres formats
8. * Le site Web
9. Traductions
10. Style
11. Utiliser sgml-mode avec Emacs
12. A consulter
12.1. Projet de Documentation de FreeBSD
12.2. SGML
12.3. HTML
12.4. DocBook
12.5. Le Projet de Documentation de Linux
Liste des exemples
1. Un exemple d'exemple
3-1. Utiliser un élément (marques de début et de fin)
3-2. Utiliser un élément (marque de début uniquement)
3-3. Eléments dans des éléments ; <em>
3-4. Utiliser un élément avec un attribut
3-5. Simples quotes dans un attribut
3-6. .profile, pour les utilisateurs de sh(1) et bash(1)
3-7. .login, pour les utilisateurs de csh(1) et tcsh(1)
3-8. Commentaire SGML générique
3-9. Commentaires SGML erronnés
3-10. Définition d'entités générales
3-11. Définition d'entités paramètres
3-12. Utiliser les entités générales pour inclure des fichiers
3-13. Utiliser les entités paramètres pour inclure des fichiers
3-14. Structure d'une section marquée
3-15. Utiliser une section marquée CDATA
3-16. Utiliser INCLUDE et IGNORE dans les sections marquées
3-17. Utiliser une entité paramètre pour contrôler une section marquée
4-1. Structure habituelle d'un document HTML
4-2. <h1>, <h2>, etc.
4-3. Mauvais ordonnancement des éléments <hn>
4-4. <p>
4-5. <blockquote>
4-6. <ul> et <ol>
4-7. Listes de définition avec <dl>
4-8. <pre>
4-9. Emploi simple de <table>
4-10. Emploi de rowspan
4-11. Emploi de colspan
4-12. Emploi de rowspan et colspan ensemble
4-13. <em> et <strong>
4-14. <b> et <i>
4-15. <tt>
4-16. <big>, <small> et <font>
4-17. Emploi de <a href="...">
4-18. Emploi de <a name="...">
4-19. Lien sur une partie nommée d'un autre document
4-20. Lien sur une partie nommée du même document
4-21. Boilerplate??? <book> avec <bookinfo>
4-22. Boilerplate??? <article> avec <artheader>
4-23. Un chapitre
4-24. Chapitres vides
4-25. Sections dans les chapitres
4-26. <para>
4-27. <blockquote>
4-28. <warning>
4-29. <itemizedlist>, <orderedlist> et <procedure>
4-30. <programlisting>
4-31. <informaltable>
4-32. Tableaux avec frame="none"
4-33. <screen>, <prompt> et <userinput>
4-34. <emphasis>
4-35. Applications, commandes et options.
4-36. <filename>
4-37. <devicename>
4-38. <hostid> et roles
4-39. <username>
4-40. <maketarget> et <makevar>
4-41. <literal>
4-42. <replaceable>
4-43. id de chapitres et de section
4-44. <anchor>
4-45. Se servir de <xref>
4-46. Utiliser <link>
4-47. <ulink>
    Suivant
    Préface

Ce document, ainsi que d'autres peut être téléchargé sur ftp.FreeBSD.org/pub/FreeBSD/doc/.

Pour toutes questions à propos de FreeBSD, lisez la documentation avant de contacter <[email protected]>.
Pour les questions sur cette documentation, contactez <[email protected]>.