Introduction au Projet de Documentation de FreeBSD pour les nouveaux participants
Précédent		Suivant

Chapitre 2. Outils

Table des matières
2.1. Outils indispensables
2.2. Outils facultatifs

Le FDP utilise un certain nombre de logiciels pour faciliter la gestion de la documentation de FreeBSD, la convertir en différents formats, et ainsi de suite. Vous devrez vous-même vous servir de ces outils, si vous travaillez à la documentation de FreeBSD.

Tous ces outils existent sous forme de logiciels portés ou pré-compilés pour FreeBSD, ce qui vous simplifie beaucoup la tâche de leur installation.

Vous devrez les installer avant de mettre en pratique les exemples donnés dans les chapitres suivants. Ces chapitres vous expliquent comment vous servir de ces outils.

Utilisez textproc/docproj si possible : Vous pouvez gagner beaucoup de temps si vous les installez avec textproc/docproj. C'est un méta-port qui ne contient pas lui-même de logiciels. Au lieu de cela, il dépend de l'installation correcte de divers autres logiciels portés. Son installation devrait télécharger et installer automatiquement tous les paquetages listés dans ce chapitre dont vous aurez besoin, s'ils n'existent pas déjà sur votre système.

L'un des paquetages dont vous aurez peut-être besoin est le jeu de macro-instructions JadeTeX. Celui-ci, à son tour, a besoin que TeX soit installé. TeX est un paquetage volumineux, dont vous n'aurez besoin que si vous voulez générer les versions PostScript et PDF.

Pour économiser du temps et de l'espace disque, vous pouvez préciser si vous voulez ou non installer JadeTeX (et donc TeX). Faites soit :
# make JADETEX=yes install
ou :
# make JADETEX=no install
selon le cas.

2.1. Outils indispensables

2.1.1. Logiciels

Vous aurez besoin de ces programmes avant de pouvoir utilement travailler sur la documentation de FreeBSD. Ils font tous partie de textproc/docproj.

SP (textproc/sp): Une série d'applications, dont un analyseur syntaxique SGML et un outil de normalisation du source SGML.
Jade (textproc/jade): Une implémentation des DSSSL. Cela sert à convertir des documents marqués vers d'autres formats, dont HTML et TeX.
Tidy (www/tidy): Un formateur HTML, qui sert à remettre en forme le code HTML généré automatiquement pour qu'il soit plus lisible.
Lynx (www/lynx-current): Navigateur WWW en mode texte, lynx(1) peut aussi convertir des fichiers HTML en fichiers texte.

2.1.2. DTDs et Entités

Ce sont les DTDs et jeux d'entités utilisés par le FDP. Il faut les installer avant de pouvoir travailler à la documentation.

DTD HTML (textproc/html): HTML est le langage principal du World Wide Web, il est utilisé constamment par le site Web de FreeBSD.
DTD LinuxDoc (textproc/linuxdoc): Une partie de la documentation de FreeBSD est marquée avec LinuxDoc. Le FDP migre activement de LinuxDoc à DocBook.
DTD DocBook (textproc/docbook): DocBook est conçu pour le marquage de documentation technique et le FDP est en cours de migration de LinuxDoc à DocBook. A la date de rédaction de cette documentation, celle-ci et le Manuel de Référence de FreeBSD sont au format DocBook.
Entités ISO 8879 (textproc/iso8879): 19 de jeux de caractères ISO 8879:1986 utilisés par de nombreuses DTDs. Cela comprend des symboles mathématiques nommés, les caractères ``latins'' supplémentaires (accents, signes diacritiques et ainsi de suite) et les lettres grecques.

2.1.3. Feuilles de style

Les feuilles de style sont utilisées pour convertir et formater la documentation pour l'affichage à l'écran, l'impression, et ainsi de suite.

Les Modular DocBook Stylesheets (textproc/dsssl-docbook-modular): Les Modular DocBook Stylesheets sont utilisées pour convertir la documentation marqué en DocBook aux autres formats, comme HTML ou RTF.

Précédent	Sommaire	Suivant
Avant de commencer		Outils facultatifs