301 lines
12 KiB
Text
301 lines
12 KiB
Text
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
|
|
|
|
Redistribution and use in source (SGML DocBook) and 'compiled' forms
|
|
(SGML, HTML, PDF, PostScript, RTF and so forth) with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
1. Redistributions of source code (SGML DocBook) must retain the above
|
|
copyright notice, this list of conditions and the following
|
|
disclaimer as the first lines of this file unmodified.
|
|
|
|
2. Redistributions in compiled form (transformed to other DTDs,
|
|
converted to PDF, PostScript, RTF and other formats) must reproduce
|
|
the above copyright notice, this list of conditions and the
|
|
following disclaimer in the documentation and/or other materials
|
|
provided with the distribution.
|
|
|
|
THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY EXPRESS OR
|
|
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
|
|
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
|
ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
|
|
POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
The FreeBSD Documentation Project
|
|
The FreeBSD French Documentation Project
|
|
|
|
$FreeBSD$
|
|
Original revision: 1.6
|
|
-->
|
|
|
|
<chapter id="tools">
|
|
<title>Outils</title>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>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.</para>
|
|
|
|
<important>
|
|
<title>Utilisez <filename>textproc/docproj</filename> si possible</title>
|
|
|
|
<para>Vous pouvez gagner beaucoup de temps si vous les installez avec
|
|
<filename>textproc/docproj</filename>. C'est un
|
|
<emphasis>méta-port</emphasis> 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
|
|
<emphasis>devrait</emphasis> 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.</para>
|
|
|
|
<para>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.</para>
|
|
|
|
<para>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 :</para>
|
|
|
|
<informalexample>
|
|
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
|
|
</informalexample>
|
|
|
|
<para>ou :</para>
|
|
|
|
<informalexample>
|
|
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
|
|
</informalexample>
|
|
|
|
<para>selon le cas.</para>
|
|
</important>
|
|
|
|
<sect1>
|
|
<title>Outils indispensables</title>
|
|
|
|
<sect2>
|
|
<title>Logiciels</title>
|
|
|
|
<para>Vous aurez besoin de ces programmes avant de pouvoir utilement
|
|
travailler sur la documentation de FreeBSD. Ils font tous partie de
|
|
<filename>textproc/docproj</filename>.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><application>SP</application>
|
|
(<filename>textproc/sp</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Une série d'applications, dont un analyseur syntaxique SGML
|
|
et un outil de normalisation du source SGML.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Jade</application>
|
|
(<filename>textproc/jade</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Une implémentation des DSSSL. Cela sert à convertir des
|
|
documents marqués vers d'autres formats, dont HTML et
|
|
TeX.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Tidy</application>
|
|
(<filename>www/tidy</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Un formateur HTML, qui sert à remettre en forme le code HTML
|
|
généré automatiquement pour qu'il soit plus lisible.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Lynx</application>
|
|
(<filename>www/lynx-current</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Navigateur WWW en mode texte, &man.lynx.1; peut aussi
|
|
convertir des fichiers HTML en fichiers texte.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>DTDs et Entités</title>
|
|
|
|
<para>Ce sont les DTDs et jeux d'entités utilisés par le FDP. Il faut
|
|
les installer avant de pouvoir travailler à la documentation.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>DTD HTML (<filename>textproc/html</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>HTML est le langage principal du <foreignphrase>World Wide
|
|
Web</foreignphrase>, il est utilisé constamment par le site
|
|
Web de FreeBSD.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>DTD LinuxDoc
|
|
(<filename>textproc/linuxdoc</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Une partie de la documentation de FreeBSD est marquée avec
|
|
LinuxDoc. Le FDP migre activement de LinuxDoc à DocBook.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>DTD DocBook
|
|
(<filename>textproc/docbook</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>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.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term>Entités ISO 8879
|
|
(<filename>textproc/iso8879</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>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.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
|
|
<sect2>
|
|
<title>Feuilles de style</title>
|
|
|
|
<para>Les feuilles de style sont utilisées pour convertir et formater
|
|
la documentation pour l'affichage à l'écran, l'impression, et ainsi de
|
|
suite.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>Les <foreignphrase>Modular DocBook Stylesheets</foreignphrase>
|
|
(<filename>textproc/dsssl-docbook-modular</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Les <foreignphrase>Modular DocBook
|
|
Stylesheets</foreignphrase> sont utilisées pour convertir la
|
|
documentation marqué en DocBook aux autres formats, comme HTML
|
|
ou RTF.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</sect2>
|
|
</sect1>
|
|
|
|
<sect1>
|
|
<title>Outils facultatifs</title>
|
|
|
|
<para>Il n'est pas obligatoire d'installer les outils qui suivent. Si vous
|
|
le faites cependant, vous trouverez peut-être plus facile de travailler
|
|
à la documentation et ils vous donneront plus de possibilité de choix du
|
|
format de sortie.</para>
|
|
|
|
<sect2>
|
|
<title>Logiciels</title>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><application>JadeTeX</application> et
|
|
<application>teTeX</application>
|
|
(<filename>print/jadetex</filename> et
|
|
<filename>print/teTeX</filename>)</term>
|
|
|
|
<listitem>
|
|
<para><application>Jade</application> et
|
|
<application>teTeX</application> servent à convertir les
|
|
documents DocBook en DVI, Postscript et PDF. Il faut pour cela
|
|
les macro-instructions
|
|
<application>JadeTeX</application>.</para>
|
|
|
|
<para>Si vous n'avez pas l'intention de convertir votre
|
|
documentation à l'un de ces formats (i.e., HTML, texte et RTF
|
|
vous suffisent), il n'est pas nécessaire d'installer
|
|
<application>JadeTeX</application> et
|
|
<application>teTeX</application>. Cela vous fera gagner du temps
|
|
et de l'espace disque, <application>teTeX</application>, en
|
|
effet occupe plus de 30 Mo.</para>
|
|
|
|
<important>
|
|
<para>Si vous choisissez d'installer
|
|
<application>JadeTeX</application> et
|
|
<application>teTeX</application>, vous devrez configurer
|
|
<application>teTeX</application> après avoir installé
|
|
<application>JadeTeX</application>.
|
|
<filename>print/jadetex/pkg-message</filename> vous donnera
|
|
des instructions détaillées sur la façon de procéder.</para>
|
|
</important>
|
|
</listitem>
|
|
</varlistentry>
|
|
|
|
<varlistentry>
|
|
<term><application>Emacs</application> ou
|
|
<application>xemacs</application>
|
|
(<filename>editors/emacs</filename> ou
|
|
<filename>editors/xemacs</filename>)</term>
|
|
|
|
<listitem>
|
|
<para>Ces deux éditeurs ont un mode spécialisé pour travailler sur
|
|
des documents marqués conformément à une DTD SGML. Cela vous
|
|
permet d'avoir moins de choses à saisir et limite la possibilité
|
|
d'erreurs.</para>
|
|
|
|
<para>Vous n'êtes pas obligé de les utiliser, n'importe quel
|
|
éditeur peut servir avec des documents marqués. Mais vous
|
|
trouverez peut-être qu'ils vous permettent d'être plus
|
|
efficace.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
|
|
<para>Si quelqu'un a d'autres outils utiles pour manipuler des documents
|
|
SGML, merci de transmettre l'information à Nik Clayton
|
|
(nik@freebsd.org), de façon à ce qu'il les ajoute à cette
|
|
liste.</para>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
|
|
<!--
|
|
Local Variables:
|
|
mode: sgml
|
|
sgml-declaration: "../chapter.decl"
|
|
sgml-indent-data: t
|
|
sgml-omittag: nil
|
|
sgml-always-quote-attributes: t
|
|
sgml-parent-document: ("../book.sgml" "part" "chapter")
|
|
End:
|
|
-->
|