diff options
| author | Sebastien Gioria <gioria@FreeBSD.org> | 2000-06-12 15:47:08 +0000 |
|---|---|---|
| committer | Sebastien Gioria <gioria@FreeBSD.org> | 2000-06-12 15:47:08 +0000 |
| commit | 4b4212705e6272ce21556b4d077319015fe3dee9 (patch) | |
| tree | 8719c993a4da128f8acc0cc2fe7bf318f7ab2014 /fr_FR.ISO8859-1 | |
| parent | 17147340bba6822ee86847812daa329dccc65579 (diff) | |
| download | doc-4b4212705e6272ce21556b4d077319015fe3dee9.tar.gz doc-4b4212705e6272ce21556b4d077319015fe3dee9.zip | |
Adding the FDP-primer
Notes
Notes:
svn path=/head/; revision=7338
Diffstat (limited to 'fr_FR.ISO8859-1')
15 files changed, 6238 insertions, 0 deletions
diff --git a/fr_FR.ISO8859-1/books/fdp-primer/Makefile b/fr_FR.ISO8859-1/books/fdp-primer/Makefile new file mode 100644 index 0000000000..c0e962b1db --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/Makefile @@ -0,0 +1,47 @@ +# +# The FreeBSD Documentation Project +# The FreeBSD French Documentation Project +# +# Compilation de l'Introduction au Projet de Documentation de FreeBSD +# +# $Id: Makefile,v 1.1 2000-06-12 15:46:26 gioria Exp $ +# Original revision: 1.6 +# + +MAINTAINER=nik@FreeBSD.ORG + +DOC?= book + +FORMATS?= html-split html + +INSTALL_COMPRESSED?= gz +INSTALL_ONLY_COMPRESSED?= + +# +# SRCS lists the individual SGML files that make up the document. Changes +# to any of these files will force a rebuild +# + +# SGML content +SRCS= book.sgml +SRCS+= overview/chapter.sgml +SRCS+= psgml-mode/chapter.sgml +SRCS+= see-also/chapter.sgml +SRCS+= sgml-markup/chapter.sgml +SRCS+= sgml-primer/chapter.sgml +SRCS+= stylesheets/chapter.sgml +SRCS+= the-faq/chapter.sgml +SRCS+= the-handbook/chapter.sgml +SRCS+= the-website/chapter.sgml +SRCS+= tools/chapter.sgml +SRCS+= translations/chapter.sgml +SRCS+= writing-style/chapter.sgml + +# Entities +SRCS+= chapters.ent +SRCS+= ../handbook/mailing-lists.ent +SRCS+= ../../../en_US.ISO_8859-1/books/handbook/authors.ent + +DOC_PREFIX?= ${.CURDIR}/../../.. + +.include "${DOC_PREFIX}/share/mk/doc.project.mk" diff --git a/fr_FR.ISO8859-1/books/fdp-primer/book.sgml b/fr_FR.ISO8859-1/books/fdp-primer/book.sgml new file mode 100644 index 0000000000..38dbc8c38c --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/book.sgml @@ -0,0 +1,303 @@ +<!-- 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 + + $Id: book.sgml,v 1.1 2000-06-12 15:46:26 gioria Exp $ + Original revision: 1.7 +--> + +<!DOCTYPE BOOK PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [ +<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"> %man; +<!ENTITY % urls PUBLIC "-//FreeBSD//ENTITIES Common Document URL Entities//FR"> %urls; +<!ENTITY % bookinfo PUBLIC "-//FreeBSD//ENTITIES DocBook BookInfo Entities//FR"> %bookinfo; +<!ENTITY % translators PUBLIC "-//FreeBSD//ENTITIES DocBook Translator Entities//FR"> %translators; +<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters; +<!ENTITY % authors SYSTEM "../../../en_US.ISO_8859-1/books/handbook/authors.ent"> %authors; +<!ENTITY % mailing-lists SYSTEM "../handbook/mailing-lists.ent"> %mailing-lists; +<!ENTITY rel.current CDATA "3.2"> +<!-- We need the followings until the translation is completed --> +<!ENTITY sgml.in-progress SYSTEM "../handbook/in-progress.sgml"> +<!ENTITY sgml.todo SYSTEM "../handbook/todo.sgml"> +]> + +<book lang="fr"> + <bookinfo> + <title>Introduction au Projet de Documentation de FreeBSD pour les + nouveaux participants</title> + + <author> + <firstname>Nik</firstname> + <surname>Clayton</surname> + <affiliation> + <address><email>nik@FreeBSD.ORG</email></address> + </affiliation> + </author> + + <copyright> + <year>1998</year> + <year>1999</year> + <holder role="mailto:nik@FreeBSD.ORG">Nik Clayton</holder> + </copyright> + + <pubdate role="rcs">$Date: 2000-06-12 15:46:26 $</pubdate> + + <releaseinfo>$Id: book.sgml,v 1.1 2000-06-12 15:46:26 gioria Exp $</releaseinfo> + + <legalnotice> + <para>La redistribution et l'utilisation du code source (SGML), et + compilé (HTML, PostScript, etc.), modifiés ou non, sont soumises aux + conditions suivantes :</para> + + <orderedlist> + <listitem> + <para>Le code source (SGML DocBook) distribué doit conserver le + copyright ci-dessus, la présente liste de conditions et + l'avertissement qui la suit, sans modifications, en tête de ce + fichier.</para> + </listitem> + + <listitem> + <para>Le code source distribué sous forme compilé (transformation + vers d'autres DTDs, conversion en PDF, PostScript, RTF et autres + formats) doit faire apparaître dans la documentation et/ou les + autres composants distribués, le copyright ci-dessus, la présente + liste de conditions et l'avertissement qui la suit.</para> + </listitem> + </orderedlist> + + <important> + <para>CE DOCUMENT EST FOURNI PAR NIK CLAYTON “TEL QUEL” ET + AUCUNE GARANTIE EXPRESSE OU IMPLICITE, Y COMPRIS, MAIS NON + LIMITÉE, GARANTIES IMPLICITES DE COMMERCIABILITÉ ET + D'ADÉQUATION À UN BUT PARTICULIER N'EST DONNÉE. + EN AUCUN CAS NIK CLAYTON NE SAURAIT ÊTRE TENU RESPONSABLE DES + DOMMAGES DIRECTS, INDIRECTS, ACCIDENTELS, SPÉCIAUX, + EXEMPLAIRES OU CONSÉQUENTS (Y COMPRIS, MAIS SANS LIMITATION, + LA FOURNITURE DE BIENS ET SERVICES ANNEXES DÉFAUT + D'UTILISABILITÉ, PERTE DE DONNÉES OU DE PROFITS ; + OU INTERRUPTION DE TRAVAIL) QUELLE QU'EN SOIT LA CAUSE ET SELON + TOUTE DÉFINITION DE RESPONSABILITÉ, SOIT PAR CONTRAT, + RESPONSABILITÉ STRICTE, OU PRÉJUDICE (Y COMPRIS + NÉGLIGENCE OU AUTRES) IMPUTABLES D'UNE FAÇON OU D'UNE + AUTRE À L'UTILISATION DE CE DOCUMENT, MÊME APRES AVOIR + ÉTÉ AVISÉ DE LA POSSIBILITÉ DE TELS + DOMMAGES.</para> + </important> + </legalnotice> + + <abstract> + <para>Merci de votre participation au Projet de Documentation de + FreeBSD. Votre contribution est très utile.</para> + + <para>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.</para> + + <para>Ce document est en cours de rédaction et n'est pas terminé. Les + sections inachevées sont indiquées par un + astérisque - <literal>*</literal> - qui précède + leur nom.</para> + + &trans.a.haby; + </abstract> + </bookinfo> + + <preface> + <title>Préface</title> + + <sect1> + <title>Invites de l'interpréteur de commandes</title> + + <para>La table ci-dessous donne les invites par défaut du système pour + un utilisateur normal et pour le super-utilisateur. Elles sont + utilisées dans les exemples pour indiquer quel utilisateur doit + appliquer l'exemple.</para> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Utilisateur</entry> + <entry>Invite</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Utilisateur normal</entry> + <entry>&prompt.user;</entry> + </row> + + <row> + <entry><username>root</username></entry> + <entry>&prompt.root;</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </sect1> + + <sect1> + <title>Conventions Typographiques</title> + + <para>La table ci-dessous décrit les conventions typographiques + utilisées dans le présent ouvrage.</para> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Signification</entry> + <entry>Exemples</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Noms de commandes, fichiers et répertoires. Affichage à + l'écran de l'ordinateur.</entry> + + <entry><para>Modifiez votre fichier + <filename>.login</filename>.</para><para>Utilisez + <command>ls -a</command> pour avoir la liste de tous les + fichiers.</para><para><screen>Vous avez reçu du courrier.</screen></para></entry> + </row> + + <row> + <entry>Ce que vous tapez, par opposition à ce que l'ordinateur + affiche.</entry> + + <entry><screen>&prompt.user; <userinput>su</userinput> +Password:</screen></entry> + </row> + + <row> + <entry>Références aux pages de manuel</entry> + + <entry>Utilisez <citerefentry><refentrytitle>su</refentrytitle> + <manvolnum>1</manvolnum></citerefentry> pour changer de nom + d'utilisateur.</entry> + </row> + + <row> + <entry>Noms d'utilisateurs et de groupes</entry> + + <entry>Seul <username>root</username> peut le faire.</entry> + </row> + + <row> + <entry>Mise en valeur</entry> + + <entry>Vous <emphasis>devez</emphasis> le faire.</entry> + </row> + + <row> + <entry>Variables sur la ligne de commande ; à remplacer par + le nom ou la valeur effectif.</entry> + + <entry>Pour supprimer un fichier, tapez <command>rm + <filename><replaceable>nom_du_fichier</replaceable></filename></command>.</entry> + </row> + + <row> + <entry>Variables d'environnement</entry> + + <entry><envar>$HOME</envar> est votre répertoire + utilisateur.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </sect1> + + <sect1> + <title>Notes, avertissements et exemples</title> + + <para>Dans le cours du texte, il peut y avoir des notes, des + avertissements et des exemples.</para> + + <note> + <para>Les notes apparaissent comme ceci, et contiennent des + informations que vous devriez prendre en considération, parce + qu'elles peuvent avoir une incidence sur ce que vous faites.</para> + </note> + + <warning> + <para>Les avertissements apparaissent comme ceci, et vous préviennent + de problèmes potentiels si vous n'appliquez pas ces instructions. + Des dégats peuvent être causés à votre matériel, ou ne pas être + physiques, suppression inopinée de fichiers importants par + exemple.</para> + </warning> + + <example> + <title>Un exemple d'exemple</title> + + <para>Les exemples apparaissent comme ceci, et sont généralement des + exemples que vous devriez tester ou qui vous montrent quels doivent + être les résultats d'une opération donnée.</para> + </example> + </sect1> + + <sect1> + <title>Remerciements</title> + + <para>Mes remerciements à Sue Blake, Patrick Durusau, Jon Hamilton, + Peter Flynn et Christopher Maden, qui ont pris le temps de lire les + premières versions de ce document et ont apporté de nombreux + commentaires et critiques utiles.</para> + </sect1> + </preface> + + &chap.overview; + &chap.tools; + &chap.sgml-primer; + &chap.sgml-markup; + &chap.stylesheets; + &chap.the-faq; + &chap.the-handbook; + &chap.the-website; + &chap.translations; + &chap.writing-style; + &chap.psgml-mode; + &chap.see-also; +</book> + +<!-- + Local Variables: + mode: sgml + sgml-indent-data: t + sgml-omittag: nil + sgml-always-quote-attributes: t + End: +--> diff --git a/fr_FR.ISO8859-1/books/fdp-primer/chapters.ent b/fr_FR.ISO8859-1/books/fdp-primer/chapters.ent new file mode 100644 index 0000000000..eaaa5d0a09 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/chapters.ent @@ -0,0 +1,23 @@ +<!-- + Creates entities for each chapter in the Documentation Project Primer. + Each entity is named chap.foo, where foo is the value of the id + attribute on that chapter, and corresponds to the name of the + directory in which that chapter's .sgml file is stored. + + Chapters should be listed in the order in which they are referenced. + + $Id: chapters.ent,v 1.1 2000-06-12 15:46:26 gioria Exp $ +--> + +<!ENTITY chap.overview SYSTEM "overview/chapter.sgml"> +<!ENTITY chap.sgml-primer SYSTEM "sgml-primer/chapter.sgml"> +<!ENTITY chap.tools SYSTEM "tools/chapter.sgml"> +<!ENTITY chap.sgml-markup SYSTEM "sgml-markup/chapter.sgml"> +<!ENTITY chap.stylesheets SYSTEM "stylesheets/chapter.sgml"> +<!ENTITY chap.the-faq SYSTEM "the-faq/chapter.sgml"> +<!ENTITY chap.the-handbook SYSTEM "the-handbook/chapter.sgml"> +<!ENTITY chap.the-website SYSTEM "the-website/chapter.sgml"> +<!ENTITY chap.translations SYSTEM "translations/chapter.sgml"> +<!ENTITY chap.writing-style SYSTEM "writing-style/chapter.sgml"> +<!ENTITY chap.psgml-mode SYSTEM "psgml-mode/chapter.sgml"> +<!ENTITY chap.see-also SYSTEM "see-also/chapter.sgml"> diff --git a/fr_FR.ISO8859-1/books/fdp-primer/overview/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/overview/chapter.sgml new file mode 100644 index 0000000000..81cbc4421e --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/overview/chapter.sgml @@ -0,0 +1,187 @@ +<!-- 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 + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:30 gioria Exp $ + Original revision: 1.3 +--> + +<chapter id="overview"> + <title>Introduction</title> + + <para>Bienvenue au Projet de Documentation de FreeBSD. Une documentation de + bonne qualité est un facteur important de succès pour FreeBSD, et le + Projet de Documentation de + FreeBSD - “<foreignphrase>The FreeBSD Documentation + Project</foreignphrase>” - est la source d'une grande + part de cette documentation. Votre participation est importante.</para> + + <para>L'objectif principal de ce document est d'expliquer clairement + <emphasis>comment est organisé le FDP</emphasis>, <emphasis>comment + écrire et soumettre de la documentation au FDP</emphasis> et + <emphasis>comment utiliser les outils disponibles pour produire de la + documentation</emphasis>.</para> + + <para>La participation de chacun au FDP est bienvenue. Il n'y a pas de + cotisation minimum, pas de quota de documentation à produire par mois. Il + vous suffit de vous inscrire sur la &a.doc;.</para> + + <para>Après avoir lu ce document, vous :</para> + + <itemizedlist> + <listitem> + <para>Saurez quelles sont les documentations maintenues par le + FDP.</para> + </listitem> + + <listitem> + <para>Serez capable de lire et comprendre le code SGML source des + documentations maintenues par le FDP.</para> + </listitem> + + <listitem> + <para>Serez capable de modifier la documentation.</para> + </listitem> + + <listitem> + <para>Saurez comment soumettre vos modifications pour qu'elles soient + revues et incorporées à la documentation de FreeBSD.</para> + </listitem> + </itemizedlist> + + <sect1> + <title>Le jeu de documentations de FreeBSD</title> + + <para>Le FDP a la responsabilité de quatre catégories de documents.</para> + + <variablelist> + <varlistentry> + <term>Les pages de manuel</term> + + <listitem> + <para>Les pages de manuel système en anglais ne sont pas rédigées + par le FDP, puisqu'elles font partie du système de base. Le FDP, + néanmoins, peut (et a) récrit des pages de manuel existantes pour + les clarifier ou corriger des inexactitudes.</para> + + <para>Les équipes de traductions sont responsables de la traduction + des pages de manuel dans les différentes langues. Ces traductions + sont archivées par le FDP.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>FAQ</term> + + <listitem> + <para>L'objectif de la FAQ est de répondre (sous forme de courtes + questions/réponses) aux questions qui sont posées, ou devraient + être posées, sur les différentes listes de diffusion et forums de + discussion consacrées à FreeBSD. Son format n'autorise pas de + réponses longues et exhaustives.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Manuel de + référence - “<foreignphrase>Handbook</foreignphrase>”</term> + + <listitem> + <para>Le Manuel cherche à être la ressource en ligne exhaustive et + de référence pour les utilisateurs de FreeBSD.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Le site Web</term> + + <listitem> + <para>C'est le point de présence central de FreeBSD sur le + <foreignphrase>World Wide Web</foreignphrase>, dont le site + principal est <ulink + url="http://www.freebsd.org/">http://www.freebsd.org/</ulink> + et qui a de nombreux sites miroirs dans le monde. Pour beaucoup + de gens, ce site est leur première rencontre avec FreeBSD.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Ces quatres catégories de documentation sont disponibles dans les + archives CVS de FreeBSD. Ce qui signifie que les modifications et les + notifications sont accessibles à tous, et que chacun peut utiliser un + programme comme <application>CVSup</application> ou + <application>CTM</application> pour maintenir à jour son propre + exemplaire local.</para> + + + <para>En plus de ces documents, de nombreuses personnes ont écrit des + guides ou réalisé des sites Web se rapportant à FreeBSD. Certains sont + aussi archivés dans l'arborescence CVS (quand l'auteur a donné son + accord). Dans d'autre cas, l'auteur a choisi de conserver ses + documentations en dehors des archives FreeBSD. Le FDP essaie de donner + le maximum de liens possible sur ces documents.</para> + </sect1> + + <sect1> + <title>Avant de commencer</title> + + <para>Ce document fait l'hypothèse que vous savez déjà :</para> + <itemizedlist> + <listitem> + <para>Vous procurer et tenir à jour une copie locale de la + documentation. Soit en maintenant une copie locale des archives CVS + de FreeBSD (avec <application>CVS</application>, + <application>CVSup</application> ou <application>CTM</application>), + ou en vous servant de <application>CVSup</application> pour ne + télécharger que la version + extraite - <emphasis>courante</emphasis>.</para> + </listitem> + + <listitem> + <para>Comment télécharger et installer de nouveaux logiciels en vous + servant soit du catalogue des logiciels de FreeBSD soit de + &man.pkg.add.1;.</para> + </listitem> + </itemizedlist> + </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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml new file mode 100644 index 0000000000..0d53044f66 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/psgml-mode/chapter.sgml @@ -0,0 +1,154 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:33 gioria Exp $ +--> + +<chapter id="psgml-mode"> + <title> Utiliser <literal>sgml-mode</literal> avec + <application>Emacs</application></title> + + <para>Les versions récentes d'Emacs ou Xemacs (disponibles au catalogue des + logiciels portés) incluent un paquetage très utile appelé PSGML. Il est + automatiquement appelé au chargement d'un fichier avec l'extension + <filename>.sgml</filename>, ou lorsque l'on tape <command>M-x + sgml-mode</command>. C'est un mode majeur pour traiter les fichiers + SGML, les éléments et les attributs.</para> + + <para>Connaître certaines des commandes de ce mode peut rendre le travail + sur des documents comme le Manuel de Référence beaucoup plus + facile.</para> + + <variablelist> + <varlistentry> + <term><command>C-c C-e</command></term> + + <listitem> + <para>Exécute <literal>sgml-insert-element</literal>. On vous + demandera le nom de l'élement à insérer là ou se trouve le + curseur. Vous pouvez utiliser la touche <keycap>Tab</keycap> pour + compléter le nom de l'élément. Seuls les éléments syntaxiquement + valides à cet endroit seront acceptés.</para> + + <para>L'éditeur insérera les marques de début et de fin de l'élément. + S'il y a d'autres éléments obligatoires qui doivent être inclus + dans cet élément, ils seront aussi inclus.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>C-c =</command></term> + + <listitem> + <para>Exécute <literal>sgml-change-element-name</literal>. Mettez-vous + dans un élément et utilisez cette commande. On vous demandera le nom + de l'élément par lequel il faut le remplacer. Les marques de début + et de fin de l'élément seront remplacées.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>C-c C-r</command></term> + + <listitem> + <para>Exécute <literal>sgml-tag-region</literal>. Sélectionnez du + texte (placez-vous au début, <command>C-espace</command>, allez à + la fin du texte, <command>C-espace</command>) et lancez ensuite + cette commande. On vous demandera quel élement utiliser. Celui-ci + sera inséré immédiatement avant et après la région choisie.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>C-c -</command></term> + + <listitem> + <para>Exécute <literal>sgml-untag-element</literal>. Mettez-vous sur + la marque de début ou de fin de l'élément que vous voulez supprimer + et lancez cette commande. Les marques de début et de fin de + l'élément seront supprimées.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>C-c C-q</command></term> + + <listitem> + <para>Exécute <literal>sgml-fill-element</literal>. + “Remplira” (i.e., reformatera) le contenu de l'élément + courant. Cela affectera aussi le contenu dont les blancs sont + significatifs, comme celui des éléments + <sgmltag>programlisting</sgmltag>, utilisez donc cette commande avec + précaution.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>C-c C-a</command></term> + + <listitem> + <para>Exécute <literal>sgml-edit-attributes</literal>. Ouvre un + deuxième tampon donnant la liste des attributs de l'élément + qui inclut le contenu courant, avec leurs valeurs. La touche + <keycap>Tab</keycap> vous permet de passer d'un attribut à l'autre, + <command>C-k</command> de modifier une valeur existante, et + <command>C-c</command> de fermer le tampon et de revenir au + document principal.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>C-c C-v</command></term> + + <listitem> + <para>Exécute <literal>sgml-validate</literal>. Vous propose de + sauvegarder le document en cours (si besoin est) et passe ensuite un + programme de validation du SGML. Les résultats de cette validation + sont affichés dans un nouveau tampon et vous pouvez ensuite naviguer + d'une erreur à l'autre, pour les corriger au fur et à mesure.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Il y a sans aucun doute d'autres fonctions utiles, mais j'ai décrit + celles que j'utilise le plus souvent.</para> +</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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/see-also/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/see-also/chapter.sgml new file mode 100644 index 0000000000..d0f17d671a --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/see-also/chapter.sgml @@ -0,0 +1,124 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:35 gioria Exp $ +--> + +<chapter id="see-also"> + <title> A consulter</title> + + <para>Ce document ne décrit délibérement pas exhaustivement, ni le SGML, ni + les DTDs citées, ni le Projet de Documentation de FreeBSD. Pour plus + d'information sur ces sujets, il est recommandé de consulter les sites Web + ci-dessous.</para> + + <sect1> + <title>Projet de Documentation de FreeBSD</title> + + <itemizedlist> + <listitem> + <para><ulink url="http://www.freebsd.org/docproj/">Les pages Web du + Projet de Documentation de FreeBSD</ulink>,</para> + </listitem> + + <listitem> + <para><ulink url="http://www.freebsd.org/handbook/">Le Manuel de + Référence de FreeBSD</ulink>.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1> + <title>SGML</title> + + <itemizedlist> + <listitem> + <para><ulink url="http://www.oasis-open.org/cover/">La page Web + SGML/XML</ulink>, un ressource SGML exhaustive,</para> + </listitem> + + <listitem> + <para><ulink + url='http://etext.virginia.edu/bin/tei-tocs?div=DIV1&id=SG">http://etext.virginia.edu/bin/tei-tocs?div=DIV1&id=SG'>L'Introduction en + douceur au SGML</ulink>.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1> + <title>HTML</title> + + <itemizedlist> + <listitem> + <para><ulink url="http://www.w3.org/">Le consortium World Wide + Web</ulink>,</para> + </listitem> + + <listitem> + <para><ulink url="http://www.w3.org/TR/REC-html40/">Les spécifications + du HTML 4.0</ulink>.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1> + <title>DocBook</title> + + <itemizedlist> + <listitem> + <para><ulink url="http://www.oreilly.com/davenport/">Le + <foreignphrase>Davenport Group</foreignphrase></ulink>, qui + maintient la DTD DocBook.</para> + </listitem> + </itemizedlist> + </sect1> + + <sect1> + <title>Le Projet de Documentation de Linux</title> + + <itemizedlist> + <listitem> + <para><ulink url="http://metalab.unc.edu/LDP/">Les pages Web du Projet + de Documentation de Linux</ulink>.</para> + </listitem> + </itemizedlist> + </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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml new file mode 100644 index 0000000000..a131820fd0 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml @@ -0,0 +1,2356 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:41 gioria Exp $ +--> + +<chapter id="sgml-markup"> + <title>Marques SGML</title> + + <para>Ce chapitre décrit les trois langages de marquage que vous + rencontrerez si vous contribuez au Projet de Documentation de FreeBSD. + Chaque section décrit le langage et détaille les marques que vous serez + probablement amenés à utiliser, ou qui sont déjà utilisées.</para> + + <para>Ces langages sont riches en éléments et il est parfois difficile de + savoir lequels employer dans un contexte particulier. Cette section + décrit ceux dont vous aurez probablement besoin et donne des exemples de + la manière de s'en servir.</para> + + <para>Ce n'est <emphasis>pas</emphasis> une liste exhaustive d'éléments, + cela ne ferait que reprendre le contenu de la documentation de chacun de + ces langages. L'objectif de cette section est de lister les éléments qui + ont le plus de chance de vous être utiles. Si vous avez des questions sur + le type de marque à employer dans un contexte particulier, posez-les s'il + vous plaît à la liste de diffusion du Projet de Documentation de FreeBSD, + <email>freebsd-doc@freebsd.org</email>.</para> + + <note> + <title>En ligne vs. de bloc</title> + + <para>Dans la suite de ce document, quand on décrira des éléments, + <emphasis>en ligne</emphasis> signifie que l'élément peut apparaître à + l'intérieur d'un bloc et ne génère pas de passage à la ligne. A + l'inverse un élément de bloc provoque un passage à la ligne (et d'autres + opérations) lorsqu'on le rencontre.</para> + </note> + + <sect1> + <title>HTML</title> + + <para>HTML, l'<foreignphrase>HyperText Markup + Language</foreignphrase> - Langage de Marquage de + l'Hypertexte - est le langage de prédilection du + World Wide Web. Vous trouverez plus d'informations sur + <URL:<ulink + url="http://www.w3.org/">http://www.w3.org/</ulink>>.</para> + + <para>HTML est utilisé pour marquer les pages du site Web de FreeBSD. Il + ne devrait (habituellement) pas servir pour d'autre type de + documentation, parce que DocBook offre un jeu de marques beaucoup plus + riche. Vous ne devriez donc rencontrez des pages HTML que si vous + écrivez pour le site Web.</para> + + <para>Il y a eu plusieurs versions de HTML, 1, 2, 3.0, 3.2, et il existe + deux variantes de la dernière version, 4.0 (disponible à la fois en + version <emphasis>stricte</emphasis> et + <emphasis>relachée</emphasis>).</para> + + <para>Les DTDs HTML existent au catalogue des logiciels portés dans + <filename>textproc/html</filename>. Elles sont automatiquement + installées par le méta-port + <filename>textproc/docproj</filename>.</para> + + <sect2> + <title><foreignphrase>Formal Public Identifier + (FPI)</foreignphrase> - Identifiant Public Formel</title> + + <para>Il y a un certain nombre de FPIs HTML, selon la version (qu'on + appelle aussi le niveau) de HTML avec laquelle vous voulez que votre + document soit compatible.</para> + + <para>La plupart des documents HTML du site Web de FreeBSD respectent + strictement la version relachée de HTML 4.0 :</para> + + <programlisting> +PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"</programlisting> + </sect2> + + <sect2> + <title>Sections</title> + + <para>Un document HTML est habituellement composé de deux sections. La + première section, appelée + <emphasis>head</emphasis> - en-tête, contient des + informations sur le document, comme son titre, le nom de son auteur, + le document dans lequel il est inclus, et ainsi de suite. La seconde + section, le <emphasis>body</emphasis> - corps, contient ce + qui sera affiché.</para> + + <para>Ces sections sont dénotées par les éléments + <sgmltag>head</sgmltag> et <sgmltag>body</sgmltag> respectivement. Ces + éléments appartiennent à l'élément de premier niveau + <sgmltag>html</sgmltag>.</para> + + <example> + <title>Structure habituelle d'un document HTML</title> + + <programlisting> +<html> + <head> + <title><replaceable>Le titre du document</replaceable></title> + </head> + + <body> + + … + + </body> +</html></programlisting> + </example> + </sect2> + + <sect2> + <title>Eléments de blocs</title> + + <sect3> + <title>Titres</title> + + <para>HTML vous permet d'avoir jusqu'à six niveaux de titres + différents dans votre document.</para> + + <para>Le titre le plus gros et le plus visible est + <sgmltag>h1</sgmltag>, puis <sgmltag>h2</sgmltag>, jusqu'à + <sgmltag>h6</sgmltag>.</para> + + <para>Le contenu de l'élément est le texte du titre.</para> + + <example> + <title><sgmltag>h1</sgmltag>, <sgmltag>h2</sgmltag>, etc.</title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<h1>Première section</h1> + +<!-- Introduction du document --> + +<h2>C'est le titre de la première section</h2> + +<!-- Contenu de la première section --> + +<h3>C'est le titre de la première sous-section</h3> + +<!-- Contenu de la première sous-section --> + +<h2>C'est le titre de la seconde section</h2> + +<!-- Contenu de la seconde section -->]]></programlisting> + </example> + + <para>Un page HTML doit normalementi avoir un titre de premier niveau + (<sgmltag>h1</sgmltag>). Il peut contenir plusieurs titres de second + niveau (<sgmltag>h2</sgmltag>), et à leur tour, de nombreux titres + de troisième niveau. Chaque élément + <sgmltag>h<replaceable>n</replaceable></sgmltag> doit appartenir à + un même élément de niveau supérieur. Il faut éviter de sauter d'un + cran dans la numérotation.</para> + + <example> + <title>Mauvais ordonnancement des éléments + <sgmltag>h<replaceable>n</replaceable></sgmltag></title> + + <para>Use:</para> + + <programlisting> +<![ CDATA [<h1>Première section</h1> + +<!-- Introduction du document --> + +<h3>Sous-section</h3> + +<!-- Ce n'est pas bon, <h2> a été oublié -->]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Paragraphes</title> + + <para>HTML n'a qu'un seul élément paragraphe, + <sgmltag>p</sgmltag>.</para> + + <example> + <title><sgmltag>p</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>C'est un paragraphe. Il peut contenir pratiquement + n'importe quel élément.</p>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Citations</title> + + <para>Une citation d'un long extrait d'un autre document, qui ne doit + pas apparaître dans le paragraphe en cours, mais est mise dans un bloc + de citation.</para> + + <example> + <title><sgmltag>blockquote</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>Un court extrait de la Constitution des Etats-Unis :</p> + +<blockquote>Nous le Peuple des Etats-Unis, dans le But de former + une Union plus parfaite, d'établir la Justice, d'assurer + la Tranquilité domestique, de défendre chacun, de promouvoir + le Bien-être général, et de garantir les Bénédictions de + la Liberté à nous-mêmes et à notre Postérité, décidons et + établissons cette Constitution des Etats-Unis d'Amérique.</blockquote>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Listes</title> + + <para>Il y a trois types de listes que vous pouvez afficher : + ordonnée, non ordonnée et de définition.</para> + + <para>Typiquement, chaque entrée d'une liste ordonnée sera numérotée, + alors que chaque entrée d'une liste non ordonnée sera précédée d'une + puce. Les listes de définition ont deux sections pour chaque entrée. + La première est le terme que l'on définit et la seconde sa + définition.</para> + + <para>Les listes ordonnées sont dénotées par l'élément + <sgmltag>ol</sgmltag>, les listes non ordonnées par l'élément + <sgmltag>ul</sgmltag> et les listes de définition par l'élément + <sgmltag>dl</sgmltag> element.</para> + + <para>Les listes ordonnées et non ordonnées contiennent des éléments + de liste, notés avec l'élément <sgmltag>li</sgmltag>. Un élément de + liste peut contenir du texte, ou être décomposé en plusieurs + éléments <sgmltag>p</sgmltag>.</para> + + <para>Les listes de définition contiennent des termes à définir + (<sgmltag>dt</sgmltag>) et leurs définitions + (<sgmltag>dd</sgmltag>). Le terme à définir n'est composé que de + texte. La définition peut comporter d'autres éléments de + blocs.</para> + + <example> + <title><sgmltag>ul</sgmltag> et <sgmltag>ol</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>Une liste non ordonnée. Les éléments de la liste seront + probablement précédés par des puces.</p> + +<ul> + <li>Premier élément</li> + + <li>Second élément</li> + + <li>Troisième élément</li> +</ul> + +<p>Une liste ordonnée, dont les éléments comportent plusieurs paragraphes. + Chaque élément (note : et non chaque paragraphe) sera numéroté.</p> + +<ol> + <li><p>C'est le premier élément. Il n'a qu'un paragraphe..</p></li> + + <li><p>C'est le premier paragraphe du second élément.</p> + + <p>C'est le second paragraphe du second élément.</p> + + <li><p>C'est le premier et seul paragraphe du troisième élément.</p></li> +</ol>]]></programlisting> + </example> + + <example> + <title>Listes de définition avec <sgmltag>dl</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<dl> + <dt>Terme 1</dt> + + <dd><p>Paragraphe 1 de la définition 1.</p></dd> + + <p>Paragraphe 2 de la définition 1.</p></dd> + + <dt>Terme 2</dt> + + <dd><p>Paragraphe 1 de la définition 2.</p></dd> + + <dt>Terme 3</dt> + + <dd>Paragraphe 1 de la définition 3. Remarquez que l'élément <p> n'est + pas obligatoire dans le cas d'un paragraphe unique.</dd> +</dl>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Texte pré-formaté</title> + + <para>Vous pouvez préciser que du texte doit apparaître exactement + comme il est présenté dans le fichier. Cela signifie habituellement + que le texte est affiché en police fixe, que les blancs successifs + sont conservés et que les passages à la ligne dans le texte sont + significatifs.</para> + + <para>Pour cela, il faut mettre ce texte dans un élément + <sgmltag>pre</sgmltag>.</para> + + <example> + <title><sgmltag>pre</sgmltag></title> + + <para>Vous pouvez utiliser <sgmltag>pre</sgmltag> pour marquer le + texte d'un courrier électronique :</para> + + <programlisting> +<![ CDATA [<pre> + From: nik@freebsd.org + To: freebsd-doc@freebsd.org + Subject: Nouvelle documentation disponible + + Une nouvelle version de mon introduction pour les nouveaux + participants au Projet de Documentation de FreeBSD est + disponible à l'adresse suivante : + + <URL:http://www.freebsd.org/~nik/primer/index.html> + + Commentaires souhaités. + + N +</pre>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Tables</title> + + <note> + <para>La plupart des navigateurs en mode texte (comme Lynx) + n'affichent pas très bien les tables. Si vous utilisez ce type de + présentation en tableaux, vous devriez envisager d'utiliser + d'autres marques pour éviter la confusion.</para> + </note> + + <para>Marquez les tableaux avec l'élément <sgmltag>table</sgmltag>. + Un tableau est composé d'une ou plusieurs lignes + (<sgmltag>tr</sgmltag>), chacune contenant une ou plusieurs + cellules (<sgmltag>td</sgmltag>). Chaque cellule peut contenir + d'autres éléments de bloc, des paragraphes ou des listes par + exemple. Elle peut aussi contenir d'autres tables (cet emboîtement + peut se répéter indéfiniment). Si la cellule ne contient qu'un seul + paragraphe, l'élément <sgmltag>p</sgmltag> n'est pas + obligatoire.</para> + + <example> + <title>Emploi simple de <sgmltag>table</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>C'est une table 2x2 simple.</p> + +<table> + <tr> + <td>Cellule en haut à gauche</td> + + <td>Cellule en haut à droite</td> + </tr> + + <tr> + <td>Cellule en bas à gauche</td> + + <td>Cellule en bas à droite</td> + </tr> +</table>]]></programlisting></example> + + <para>Une cellule peut occuper plusieurs lignes ou colonnes. Pour le + préciser, ajoutez les attributs <literal>rowspan</literal> et/ou + <literal>colspan</literal>, dont les valeurs donnent le nombre de + lignes et de colonnes occupées.</para> + + <example> + <title>Emploi de <literal>rowspan</literal></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>Une grande cellule à gauche, deux petites cellule à droite.</p> + +<table> + <tr> + <td rowspan="2">Grande et mince</td> + </tr> + + <tr> + <td>Cellule du haut</td> + + <td>Cellule du bas</td> + </tr> +</table>]]></programlisting> + </example> + + <example> + <title>Emploi de <literal>colspan</literal></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>Une grande cellule en haut, deux petites cellules en dessous.</p> + +<table> + <tr> + <td colspan="2">Cellule du haut</td> + </tr> + + <tr> + <td>Cellule du bas à gauche</td> + + <td>Cellule du bas à droite</td> + </tr> +</table>]]></programlisting> + </example> + + <example> + <title>Emploi de <literal>rowspan</literal> et + <literal>colspan</literal> ensemble</title> + + <para>Use:</para> + + <programlisting> +<![ CDATA [<p>Sur une grille 3x3, la cellule en haut à gauche d'étend sur deux + lignes et deux colonnes. Les autres cellules sont normales.</p> + +<table> + <tr> + <td colspan="2" rowspan="2">Grande cellule en haut à gauche</td> + + <td>Cellule en haut à droite</td> + </tr> + + <tr> + <!-- Comme la grande cellule se prolonge + sur cette colonne, la première cellule + marquée par <td> se trouvera à sa droite --> + + <td>Cellule du milieu à droite</td> + </tr> + + <tr> + <td>Cellule en bas à gauche</td> + + <td>Cellule en bas au milieu</td> + + <td>Cellule en bas à droite</td> + </tr> +</table>]]></programlisting> + </example> + </sect3> + </sect2> + + <sect2> + <title>Eléments</title> + + <sect3> + <title>Information d'accentuation</title> + + <para>Il y a deux niveaux d'accentuation disponibles en HTML, + <sgmltag>em</sgmltag> et <sgmltag>strong</sgmltag>. + <sgmltag>em</sgmltag> marque une accentuation normale et + <sgmltag>strong</sgmltag> une accentuation plus prononcée.</para> + + <para><sgmltag>em</sgmltag> est généralement rendu en italiques et + <sgmltag>strong</sgmltag> en gras. Ce n'est malgré tout pas toujours + le cas, et il ne faut pas se baser là-dessus.</para> + + <example> + <title><sgmltag>em</sgmltag> et <sgmltag>strong</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p><em>Ceci</em> est accentué, et + <strong>cela</strong> l'est encore plus.</p>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Gras et italiques</title> + + <para>HTML comporte des marques pour la présentation, vous pouvez donc + aussi préciser qu'un contenu donné doit apparaître en gras ou en + italiques. Les éléments pour cela sont respectivement + <sgmltag>b</sgmltag> et <sgmltag>i</sgmltag>.</para> + + <example> + <title><sgmltag>b</sgmltag> et <sgmltag>i</sgmltag></title> + + <programlisting> +<![ CDATA [<p><b>Ceci</b> est en gras, tandis que <i>cela</i> est + en italiques.</p>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Texte en police fixe</title> + + <para>S'il y a du texte qui doit être affiché en police fixe (machine + à écrire), servez-vous de <sgmltag>tt</sgmltag> ( pour + “télétype”).</para> + + <example> + <title><sgmltag>tt</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>L'auteur original de ce document est + Nik Clayton, qui peut être contacté par courrier + électronique à l'adresse : <tt>nik@freebsd.org</tt>.</p>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Taille de police</title> + + <para>Vous pouvez préciser qu'un contenu doit être affiché en police + plus grande ou plus petite. Il y a trois façons de le faire.</para> + + <orderedlist> + <listitem> + <para>Utilisez <sgmltag>big</sgmltag> et <sgmltag>small</sgmltag> + pour encadrer le texte dont vous voulez modifier la taille. Ces + marques peuvent être imbriquées, il est donc possible + d'avoir : <literal><big><big>C'est bien plus + gros</big></big></literal>.</para> + </listitem> + + <listitem> + <para>Servez-vous de <sgmltag>font</sgmltag> avec l'attribut + <literal>size</literal> prenant respectivement les valeurs + <literal>+1</literal> ou <literal>-1</literal>. C'est la même + chose que d'utiliser <sgmltag>big</sgmltag> ou + <sgmltag>small</sgmltag>. Mais cette façon de faire est + obsolète.</para> + </listitem> + + <listitem> + <para>Utilisez <sgmltag>font</sgmltag> avec l'attribut + <literal>size</literal> prenant une valeur de 1 à 7. La taille + de police par défaut est <literal>3</literal>. Cette façon de + faire est aussi obsolète.</para> + </listitem> + </orderedlist> + + <example> + <title><sgmltag>big</sgmltag>, <sgmltag>small</sgmltag> et + <sgmltag>font</sgmltag></title> + + <para>Les trois extraits suivants ont le même résultat :</para> + + <programlisting> +<![ CDATA [<p>Ce texte est <small>un peu plus petit</small>. + Mais celui-là <big>est un peu plus gros</big>.</p> + +<p>Ce texte est <font size="-1">un peu plus petit</font>. + Mais celui-là <font size="+1">est un peu plus gros</font>.</p> + +<p>Ce texte est <font size="2">un peu plus petit</font>. + Mais celui-là <font size="4">est un peu plus gros</font>.</p>]]></programlisting> + </example> + </sect3> + </sect2> + + <sect2> + <title>Liens</title> + + <note> + <para>Les liens font aussi partie du contenu du document.</para> + </note> + + <sect3> + <title>Liens vers d'autres documents sur le WWW</title> + + <para>Pour mettre un lien sur un autre document sur le WWW, il faut + que vous connaissiez l'URL de ce document.</para> + + <para>Ce lien est noté avec <sgmltag>a</sgmltag> et l'attribut + <literal>href</literal> contient l'URL du document cible. Le + lien est le contenu de l'élément, il est habituellement présenté + d'une façon ou d'une autre à l'utilisateur (souligné, couleur + différente, curseur de forme différente quand on passe dessus, et + ainsi de suite).</para> + + <example> + <title>Emploi de <literal><a href="..."></literal></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p>Vous trouverez plus d'informations sur le + <a href="http://www.freebsd.org/">site Web de FreeBSD</a>.</p>]]></programlisting> + </example> + + <para>Ces liens amèneront l'utilisateur au début du document + sélectionné.</para> + </sect3> + + <sect3> + <title>Liens sur d'autres parties des documents</title> + + <para>Pour mettre un lien sur un endroit précis d'un autre (ou du + même) document, il faut que l'auteur de ce document y ait mis des + points d'ancrage sur lequels vous pouvez pointer.</para> + + <para>Les points d'ancrage sont notés avec <sgmltag>a</sgmltag> et + l'attribut <literal>name</literal> au lieu de + <literal>href</literal>.</para> + + <example> + <title>Emploi de <literal><a name="..."></literal></title> + + <para>Utilisez :</para> + + <programlisting> +<![ CDATA [<p><a name="para1">Ce</a> paragraphe peut être référencé + par d'autres liens via le nom <tt>para1</tt>.</p>]]></programlisting> + </example> + + <para>Pour mettre un lien sur une partie nommée d'un document, utilisez + un lien ordinaire, mais ajoutez-y le nom du point d'ancrage précédé + d'un symbole <literal>#</literal>.</para> + + <example> + <title>Lien sur une partie nommée d'un autre document</title> + + <para>Supposons que l'exemple <literal>para1</literal> se trouve + dans un document appelé <filename>foo.html</filename>.</para> + + <programlisting> +<![ CDATA [<p>Vous trouverez plus d'informations au + <a href="foo.html#para1">premier paragraphe</a> de + <tt>foo.html</tt>.</p>]]></programlisting> + </example> + + <para>Si le lien pointe sur un point d'ancrage nommé du même document, + vous pouvez ommettre son URL et ne mettre que le nom du point + d'ancrage (précédé de <literal>#</literal>).</para> + + <example> + <title>Lien sur une partie nommée du même document</title> + + <para>Supposons que l'exemple <literal>para1</literal> fasse partie + de ce document.</para> + + <programlisting> +<![ CDATA [<p>Vous trouverez plus d'informations au + <a href="#para1">premier paragraphe</a> de + ce document.</p>]]></programlisting> + </example> + </sect3> + </sect2> + </sect1> + + <sect1> + <title>DocBook</title> + + <para>DocBook est une DTD créée par le <ulink + url="http://www.oreilly.com/davenport/">Davenport Group</ulink> + pour la rédaction de documentation technique. De sorte que, et au + contraire de LinuxDoc ou HTML, les marques DocBook sont plus conçues + pour décrire <emphasis>ce qu'est</emphasis> quelque chose que + <emphasis>comment</emphasis> il faut le présenter.</para> + + <note> + <title><literal>formel</literal> vs. <literal>informel</literal></title> + + <para>Certains éléments ont deux + versions - <emphasis>formelle</emphasis> et + <emphasis>informelle</emphasis>. Habituellement, la version formelle + de l'élément comporte une titre. La version informelle n'en a + pas.</para> + </note> + + <para>La DTD DocBook est disponible au catalogue des logiciels portés avec + le “méta-logiciel porté” + <filename>textproc/docbook</filename>. Elle est automatiquement + installée par ce dernier.</para> + + <sect2> + <title>Extensions FreeBSD</title> + + <para>Le Projet de Documentation de FreeBSD a ajouté quelques nouveaux + éléments à la DTD DocBook. Ces éléments permettent un marquage plus + précis.</para> + + <para>Dans la suite, quand il sera question d'un élément propre à + FreeBSD, ce sera clairement indiqué.</para> + + <para>Le terme “DocBook” désigne dans ce qui suit la DTD + DocBook avec les extensions FreeBSD.</para> + + <note> + <para>Il n'y a rien dans ces extensions qui soit propre à FreeBSD, + on a juste pensé que ce seraient des ajouts utiles pour ce projet + précis. Si d'autres contributeurs aux autres projets + “*nix” (NetBSD, OpenBSD, Linux, …) sont + intéressés à participer à la mise au point d'un jeu d'extensions + DocBook standard, merci de contacter Nik Clayton + <email>nik@FreeBSD.org</email>.</para> + </note> + + <para>Les extensions FreeBSD ne font pas (actuellement) partie du + catalogue des logiciels portés. Elles sont inclues dans les sources du + Projet de Documentation et se trouvent dans + <filename>doc/share/sgml/freebsd.dtd</filename>.</para> + </sect2> + + <sect2> + <title>Identifiant Public Formel - <foreignphrase>Formal + Public Indentifier</foreignphrase>, (FPI)</title> + + <para>En conformité avec les conventions DocBook concernant les FPIs + pour les personnalisations de DocBook, le FPI pour la DTD DocBook avec + les extensions FreeBSD est :</para> + + <programlisting>PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN"</programlisting> + </sect2> + + <sect2> + <title>Structure des documents</title> + + <para>DocBook vous permet de structurer votre documentation de + différentes façons. Le Projet de Documentation de FreeBSD utilise deux + types de documents de base, le livre et l'article.</para> + + <para>Un livre est organisé <sgmltag>chapter</sgmltag>s. C'est une + obligation. Il peut y avoir des <sgmltag>part</sgmltag>s entre le + livre et le chapitre s'il l'on veut un niveau supplémentaire dans le + découpage.</para> + + <para>Un chapitre peut avoir (ou non) une ou plusieurs sections. Elles + sont désignées par l'élément <sgmltag>sect1</sgmltag>. Si une section + inclue une autre section, utilisez l'élément <sgmltag>sect2</sgmltag>, + et ainsi de suite, jusqu'à <sgmltag>sect5</sgmltag>.</para> + + <para>Le contenu du livre est lui-même dans les chapitres et + sections.</para> + + <para>Un article est plus simple qu'un livre, et n'a pas de chapitres. + Au lieu de cela, le contenu d'un article est organisé en une ou + plusieurs sections, à l'aide des mêmes éléments + <sgmltag>sect1</sgmltag> (<sgmltag>sect2</sgmltag> et ainsi de suite) + dont on se sert pour les livres.</para> + + <para>Il vous faudra manifestement choisir le type de document à + utiliser selon la nature du document que vous rédigez. Les articles + sont bien adaptés pour des documents qui n'ont pas besoin d'être + décomposés en chapitres, et qui sont, relativement parlant, assez + court - jusqu'à 20-25 pages. Les livres eux conviennent + aux documents qui peuvent être découpés en plusieurs chapitres, + avec éventuellement des annexes, et autres composants.</para> + + <para>Les <ulink url="&url.tutorials;">guides + FreeBSD</ulink> sont tous des articles, tandis que ce document, la + <ulink url="&url.faq;">FAQ FreeBSD</ulink>, et le + <ulink url="&url.handbook;">Manuel de Référence FreeBSD</ulink> sont + des livres.</para> + + <sect3> + <title>Commencer un livre</title> + + <para>Le contenu d'un livre est un inclus dans l'élément + <sgmltag>book</sgmltag>. Tout autant que des marques organisant le + contenu, cet élément peut contenir des éléments qui donnent des + informations supplémentaires sur le livre. Ce sont soit des + méta-informations, utilisées pour y faire référence, soit un + contenu supplémentaire servant à générer la page de titre.</para> + + <para>Ces informations supplémentaires doivent être inclues dans + l'élément <sgmltag>bookinfo</sgmltag>.</para> + + <example> + <title>Boilerplate??? <sgmltag>book</sgmltag> avec + <sgmltag>bookinfo</sgmltag></title> + + <!-- Can't put this in a marked section because of the + replaceable elements --> + <programlisting><book> + <bookinfo> + <title><replaceable>Mettez le titre ici</replaceable></title> + + <author> + <firstname><replaceable>Votre prénom</replaceable></firstname> + <surname><replaceable>Votre nom de famille</replaceable></surname> + <affiliation> + <address><email><replaceable>Votre adresse de courrier + électronique</replaceable></email></address> + </affiliation> + </author> + + <copyright> + <year><replaceable>1998</replaceable></year> + <holder role="mailto:<replaceable>Votre adresse de courrier + électronique</replaceable>"><replaceable>Votre nom</replaceable></holder> + </copyright> + + <pubdate role="rcs">$Date$</pubdate> + + <releaseinfo>$Id$</releaseinfo> + + <abstract> + <para><replaceable>Résumez ici le contenu du + livre.</replaceable></para> + </abstract> + </bookinfo> + + … + +</book></programlisting> + </example> + </sect3> + + <sect3> + <title>Commencer un article</title> + + <para>Le contenu d'un article est un inclus dans l'élément + <sgmltag>article</sgmltag>. Tout autant que des marques organisant le + contenu, cet élément peut contenir des éléments qui donnent des + informations supplémentaires sur l'article. Ce sont soit des + méta-informations, utilisées pour y faire référence, soit un + contenu supplémentaire servant à générer la page de titre.</para> + + <para>Ces informations supplémentaires doivent être inclues dans + l'élément <sgmltag>artheader</sgmltag>.</para> + + <example> + <title>Boilerplate??? <sgmltag>article</sgmltag> avec + <sgmltag>artheader</sgmltag></title> + + <!-- Can't put this in a marked section because of the + replaceable elements --> + <programlisting><article> + <artheader> + <title><replaceable>Mettez le titre ici</replaceable></title> + + <author> + <firstname><replaceable>Votre prénom</replaceable></firstname> + <surname><replaceable>Votre nom de famille</replaceable></surname> + <affiliation> + <address><email><replaceable>Votre adresse de courrier + électronique</replaceable></email></address> + </affiliation> + </author> + + <copyright> + <year><replaceable>1998</replaceable></year> + <holder role="mailto:<replaceable>Votre adresse de courrier + électronique</replaceable>"><replaceable>Votre nom</replaceable></holder> + </copyright> + + <pubdate role="rcs">$Date$</pubdate> + + <releaseinfo>$Id$</releaseinfo> + + <abstract> + <para><replaceable>Résumez ici le contenu de l'article.</replaceable></para> + </abstract> + </artheader> + + … + +</article></programlisting> + </example> + </sect3> + <sect3> + <title>Séparer les chapitres</title> + + <para>Utilisez <sgmltag>chapter</sgmltag> pour marquer vos chapitres. + Chaque chapitre a obligatoirement un <sgmltag>title</sgmltag>. Les + articles n'ont pas de chapitre, ils sont réservés aux livres.</para> + + <example> + <title>Un chapitre</title> + + <programlisting><![ CDATA [<chapter> + <title>Le titre du chapitre</title> + + ... +</chapter>]]></programlisting> + </example> + + <para>Un chapitre ne peut pas être vide, il doit contenir des éléments + en plus du <sgmltag>title</sgmltag>. Si vous voulez inclure un + chapitre vide, ajoutez lui simplement un paragraphe vide.</para> + + <example> + <title>Chapitres vides</title> + + <programlisting><![ CDATA [<chapter> + <title>C'est un chapitre vide</title> + + <para></para> +</chapter>]]></programlisting> + </example> + </sect3> + + <sect3> + <title>Sections dans les chapitres</title> + + <para>Dans les livres, les chapitres peuvent (mais ce n'est pas + obligatoire) être décomposés en sections, sous-sections, et ainsi de + suite. Dans les articles, les sections sont les principaux éléments + d'organisation et chaque article doit contenir au moins une section. + Utilisez l'élément + <sgmltag>sect<replaceable>n</replaceable></sgmltag>. Le + <replaceable>n</replaceable> est le type de section, qui indique son + niveau de profondeur.</para> + + <para>La première <sgmltag>sect<replaceable>n</replaceable></sgmltag> + est <sgmltag>sect1</sgmltag>. Vous pouvez en avoir plus d'une dans + un chapitre. Elles peuvent inclure un ou plusieurs éléments + <sgmltag>sect2</sgmltag>, et ainsi de suite, jusqu'à + <sgmltag>sect5</sgmltag>.</para> + + <example> + <title>Sections dans les chapitres</title> + + <programlisting><![ RCDATA [<chapter> + <title>Exemple de chapitre</title> + + <para>Du texte dans le chapitre.</para> + + <sect1> + <title>Première section (1.1)</title> + + … + </sect1> + + <sect1> + <title>Seconde section (1.2)</title> + + <sect2> + <title>Première sous-section (1.2.1)</title> + + <sect3> + <title>Première sous-sous-section (1.2.1.1)</title> + + … + </sect3> + </sect2> + + <sect2> + <title>Seconde sous-section (1.2.2)</title> + + … + </sect2> + </sect1> +</chapter>]]></programlisting> + </example> + + <note> + <para>Cet exemple donne les numéros des sections dans leurs titres. + Vous ne devez pas le faire. Les feuilles de style s'en chargent + (voir plus bas pour plus de détails), et vous n'avez pas à vous + en préoccupez.</para> + </note> + </sect3> + + <sect3> + <title>Subdivision en <sgmltag>part</sgmltag>s</title> + + <para>Vous pouvez avoir un niveau d'organisation supplémentaire entre + le <sgmltag>book</sgmltag> et le <sgmltag>chapter</sgmltag> en + définissant une ou plusieurs <sgmltag>part</sgmltag>s. Ce n'est pas + possible dans un <sgmltag>article</sgmltag>.</para> + + <programlisting><![ CDATA [<part> + <title>Introduction</title> + + <chapter> + <title>Resumé</title> + + ... + </chapter> + + <chapter> + <title>Qu'est-ce que FreeBSD ?</title> + + ... + </chapter> + + <chapter> + <title>Historique</title> + + ... + </chapter> +</part>]]></programlisting> + </sect3> + </sect2> + + <sect2> + <title>Eléments de blocs</title> + + <sect3> + <title>Paragraphes</title> + + <para>DocBook connaît trois types de paragraphes : + <sgmltag>formalpara</sgmltag>, <sgmltag>para</sgmltag> et + <sgmltag>simpara</sgmltag>.</para> + + <para>La plupart du temps, des <sgmltag>para</sgmltag>s vous + suffiront. Les <sgmltag>formalpara</sgmltag>s ont un + <sgmltag>title</sgmltag>, et avec les <sgmltag>simpara</sgmltag>s, + certains éléments sont interdits à l'intérieur du paragraphe. + Tenez-vous en aux <sgmltag>para</sgmltag>s.</para> + + <example> + <title><sgmltag>para</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>C'est un paragraphe. Il peut contenir + presque n'importe quel autre élément.</para> ]]></programlisting> + + <para>Apparence :</para> + + <para>C'est un paragraphe. Il peut contenir presque n'importe quel + autre élément.</para> + </example> + </sect3> + + <sect3> + <title>Citations en bloc</title> + + <para>Une citation en bloc est un long extrait d'un autre document qui + ne doit pas faire partie du paragraphe courant. Vous n'en aurez + probablement pas besoin souvent.</para> + + <para>Les citations en blocs peuvent facultativement avoir un titre et + une attribution (ou n'avoir ni titre ni attribution).</para> + + <example> + <title><sgmltag>blockquote</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>Un court extrait de la constitution des Etats-Unis :</para> + +<blockquote> + <title>Préambule à la Constitution des Etats-Unis</title> + + <attribution>Copié d'un site Web quelque part</attribution> + + <para>Nous le Peuple des Etats-Unis, dans le but de former + une Union plus parfaite, d'établir la Justice, de garantir + la Tranquilité domestique, assurer la défense collective, + promouvoir notre Bien-être général, et conserver à + nous-mêmes et à notre Postérité les bienfaits de la + Liberté, proclamons et établissons cette Constitution des + Etats-Unis d'Amérique.</para> +</blockquote>]]></programlisting> + + <para>Apparence :</para> + + <para>Un court extrait de la constitution des + Etats-Unis :</para> + + <blockquote> + <title>Préambule à la Constitution des Etats-Unis</title> + + <attribution>Copié d'un site Web quelque part</attribution> + + <para>Nous le Peuple des Etats-Unis, dans le but de former une + Union plus parfaite, d'établir la Justice, de garantir la + Tranquilité domestique, assurer la défense collective, + promouvoir notre Bien-être général, et conserver à nous-mêmes et + à notre Postérité les bienfaits de la Liberté, proclamons et + établissons cette Constitution des Etats-Unis d'Amérique.</para> + </blockquote> + </example> + </sect3> + + <sect3> + <title>Indications, notes, avertissements, mises en garde, + informations importantes et barres verticales.</title> + + <para>Vous devrez peut-être ajouter des informations distinctes du + texte lui-même. Ce sont habituellement des + “méta-informations” que l'utilisateur doit + connaître.</para> + + <para>Selon la nature de l'information, vous utiliserez l'un des + élements <sgmltag>tip</sgmltag>, <sgmltag>note</sgmltag>, + <sgmltag>warning</sgmltag>, <sgmltag>caution</sgmltag> ou + <sgmltag>important</sgmltag>. Ou bien, si l'information est en + rapport avec le texte, mais ne correspond à aucun des cas + précédents, servez-vous de <sgmltag>sidebar</sgmltag>.</para> + + <para>Les cas où il faut choisir l'un ou l'autre de ces éléments ne + sont pas clairement explicités. Voici ce que suggère la + documentation DocBook :</para> + + <itemizedlist> + <listitem> + <para>Une Note est une information destinée à tous les + lecteurs.</para> + </listitem> + + <listitem> + <para>Un élément Important est une variante de la Note.</para> + </listitem> + + <listitem> + <para>Une <foreignphrase>Caution</foreignphrase> est une + information relative à la perte de données ou dégats logiciels + éventuels.</para> + </listitem> + + <listitem> + <para>Un <foreignphrase>Warning</foreignphrase> est une + information relative aux dégats matériels ou risques + corporels.</para> + </listitem> + </itemizedlist> + + <example> + <title><sgmltag>warning</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<warning> + <para>Installer FreeBSD peut vous donner envie de supprimer + Windows de votre disque dur.</para> +</warning>]]></programlisting> + </example> + + <!-- Need to do this outside of the example --> + + <warning> + <para>Installer FreeBSD peut vous donner envie de supprimer Windows + de votre disque dur.</para> + </warning> + </sect3> + + <sect3> + <title>Listes and procédures</title> + + <para>Vous aurez souvent besoin de lister des informations ou + d'indiquer à l'utilisateur les différentes étapes nécessaires pour + effectuer une tâche donnée.</para> + + <para>Pour cela, servez-vous de <sgmltag>itemizedlist</sgmltag>, + <sgmltag>orderedlist</sgmltag> ou + <sgmltag>procedure</sgmltag><footnote><para>Il y a d'autres types de + listes dans DocBook, mais ils ne nous concernent pas pour le + moment.</para> + </footnote> + </para> + + <para><sgmltag>itemizedlist</sgmltag> et + <sgmltag>orderedlist</sgmltag> sont semblables à leurs contreparties + <sgmltag>ul</sgmltag> et <sgmltag>ol</sgmltag> en HTML. Chacune + comporte un ou plusieurs éléments <sgmltag>listitem</sgmltag>, et + chaque <sgmltag>listitem</sgmltag> contient un ou plusieurs éléments + de blocs. Les élements <sgmltag>listitem</sgmltag> sont analogues + aux marques <sgmltag>li</sgmltag> du HTML. Néanmoins, au contraire + du HTML, ils sont ici obligatoires.</para> + + <para>Une <sgmltag>procedure</sgmltag> est légérement différente. Elle + consiste en <sgmltag>step</sgmltag>s, qui à leur tour sont composés + de <sgmltag>step</sgmltag>s ou <sgmltag>substep</sgmltag>s. Chaque + <sgmltag>step</sgmltag> contient des éléments de blocs.</para> + + <example> + <title><sgmltag>itemizedlist</sgmltag>, + <sgmltag>orderedlist</sgmltag> et + <sgmltag>procedure</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<itemizedlist> + <listitem> + <para>C'est le premier élément de la liste.</para> + </listitem> + + <listitem> + <para>C'est le second élément de la liste.</para> + </listitem> +</itemizedlist> + +<orderedlist> + <listitem> + <para>C'est le premier élément de la liste + ordonnée.</para> + </listitem> + + <listitem> + <para>C'est le second élément de la liste ordonnée.</para> + </listitem> +</orderedlist> + +<procedure> + <step> + <para>Faites ceci.</para> + </step> + + <step> + <para>Puis cela.</para> + </step> + + <step> + <para>Et maintenant cela.</para> + </step> +</procedure>]]></programlisting> + + <para>Apparence :</para> + + <itemizedlist> + <listitem> + <para>C'est le premier élément de la liste.</para> + </listitem> + + <listitem> + <para>C'est le second élément de la liste.</para> + </listitem> + </itemizedlist> + + <orderedlist> + <listitem> + <para>C'est le premier élément de la liste ordonnée.</para> + </listitem> + + <listitem> + <para>C'est le second élément de la liste ordonnée.</para> + </listitem> + </orderedlist> + </example> + + <!-- Can't have <procedure> inside <example>, so this is a cheat --> + + <procedure> + <step> + <para>Faites ceci.</para> + </step> + + <step> + <para>Puis cela.</para> + </step> + + <step> + <para>Et maintenant cela.</para> + </step> + </procedure> + </sect3> + + <sect3> + <title>Extraits de fichiers</title> + + <para>Si vous voulez incorporer un extrait de fichier (ou + éventuellement une fichier entier), mettez-le dans un élément + <sgmltag>programlisting</sgmltag>.</para> + + <para>Les blancs et sauts de ligne à l'intérieur de + <sgmltag>programlisting</sgmltag> <emphasis>sont</emphasis> + significatifs. Cela signifie en particulier que la marque de début + doit être sur la même ligne que la première ligne du listing et que + la marque de fin doit être sur la même ligne que la dernière ligne + du listing, sans quoi il y aurait des lignes blanches en + trop.</para> + + <example> + <title><sgmltag>programlisting</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA[<para>Quand vous aurez fini, votre programme + ressemblera à cela :</para> + +<programlisting>#include <stdio.h> + +int +main(void) +{ + printf("bonjour, le monde\n"); +}</programlisting>]]></programlisting> + + <para>Notez qu'il faut utiliser les entités correspondantes et non + les signes “supérieur” et “inférieur” à la + ligne <literal>#include</literal>.</para> + + <para>Apparence :</para> + + <para>Quand vous aurez fini votre programme, ressemblera à + cela :</para> + + <programlisting>#include <stdio.h> + +int +main(void) +{ + printf("bonjour, le monde\n"); +}</programlisting> + </example> + + <note> + <para>DocBook dispose d'un mécanisme pour faire référence à des + sections d'un <sgmltag>programlisting</sgmltag> inclus auparavant, + appelé “rappels” (voir + <sgmltag>programlistingco</sgmltag> pour plus d'information). Je + ne le comprend pas tout à fait (i.e., je ne l'ai jamais employé), + je ne peux donc pas le décrire. En attendant, vous pouvez + numéroter les lignes et y faire référence ensuite. Cela changera + dès que je trouverais le temps de comprendre et documenter les + “rappels”.</para> + </note> + </sect3> + + <sect3> + <title>Tables</title> + + <para>Au contraire d'HTML, vous n'avez pas besoin d'utiliser les + tables pour des questions de présentation, puisque les feuilles de + style s'en chargent. Les tables servent uniquement pour les données + en tableaux.</para> + + <para>Brièvement (voyez la documentation de DocBook pour plus de + détails), une table (qui peut-être formelle ou informelle) est + constituée d'un élément <sgmltag>table</sgmltag>. Il contient au + moins un élément <sgmltag>tgroup</sgmltag>, dont l'attribut donne + le nombre de colonnes dans ce sous-tableau. Dans le sous-tableau, + vous pouvez ensuite avoir un élément <sgmltag>thead</sgmltag>, qui + contient les élements correspondant aux en-têtes des colonnes, et + un <sgmltag>tbody</sgmltag> qui contient le corps du + tableau.</para> + + <para>Les <sgmltag>thead</sgmltag> et <sgmltag>tbody</sgmltag> + contiennent des éléments <sgmltag>row</sgmltag> - lignes, + qui contiennent à leur tour des éléments <sgmltag>entry</sgmltag>. + Chaque élément <sgmltag>entry</sgmltag> correspond à une cellule du + tableau.</para> + + <example> + <title><sgmltag>informaltable</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>C'est le titre de la colonne 1</entry> + <entry>C'est le titre de la colonne 2</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Ligne 1, colonne 1</entry> + <entry>Ligne 1, colonne 2</entry> + </row> + + <row> + <entry>Ligne 2, colonne 1</entry> + <entry>Ligne 2, colonne 2</entry> + </row> + </tbody> + </tgroup> +</informaltable>]]></programlisting> + + <para>Apparence :</para> + + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>C'est le titre de la colonne 1</entry> + <entry>C'est le titre de la colonne 2</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Ligne 1, colonne 1</entry> + <entry>Ligne 1, colonne 2</entry> + </row> + + <row> + <entry>Ligne 2, colonne 1</entry> + <entry>Ligne 2, colonne 2</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </example> + + <para>Si vous ne voulez pas de bordures autour du tableau, vous pouvez + ajouter à l'élément <sgmltag>informaltable</sgmltag> l'attribut + <literal>frame</literal> avec la valeur <literal>none</literal> + (i.e., <literal><informaltable + frame="none"></literal>).</para> + + <example> + <title>Tableaux avec <literal>frame="none"</literal></title> + + <para>Apparence :</para> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>C'est le titre de la colonne 1</entry> + <entry>C'est le titre de la colonne 2</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Ligne 1, colonne 1</entry> + <entry>Ligne 1, colonne 2</entry> + </row> + + <row> + <entry>Ligne 2, colonne 1</entry> + <entry>Ligne 2, colonne 2</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </example> + </sect3> + + <sect3> + <title>Exemples que l'utilisateur doit suivre</title> + + <para>Vous aurez souvent à donner des exemples que l'utilisateur + puisse suivre. Ce seront habituellement des dialogues avec la + machine : l'utilisateur tape une commande, il reçoit une + réponse, il tape une autre commande, et ainsi de suite.</para> + + <para>Il y a là un certain nombre d'entités et d'éléments qui entrent + en jeu.</para> + + <variablelist> + <varlistentry> + <term><sgmltag>screen</sgmltag></term> + + <listitem> + <para>Tout ce que l'utilisateur voit dans cet exemple est + affiché sur l'écran de l'ordinateur, l'élément suivant est + donc <sgmltag>screen</sgmltag>.</para> + + <para>A l'intérieur de <sgmltag>screen</sgmltag>, les blancs + sont significatifs.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><sgmltag>prompt</sgmltag>, + <literal>&prompt.root;</literal> et + <literal>&prompt.user;</literal></term> + + <listitem> + <para>Parmi ce que l'utilisateur verra à l'écran, il y a les + invites (du système, de l'interpréteur de commandes ou des + applications). Ils doivent être marqués avec + <sgmltag>prompt</sgmltag>.</para> + + <para>Le cas particulier des deux invites de l'interpréteur de + commandes, pour un utilisateur ordinaire et pour le + super-utilisateur, est traité avec des entités. Chaque fois + que vous voulez montrer que l'utilisateur est sous + l'interpréteur de commande, servez-vous de + <literal>&prompt.root;</literal> ou + <literal>&prompt.user;</literal> selon le cas. Il n'y a + pas besoin qu'elles soient à l'intérieur de + <sgmltag>prompt</sgmltag>.</para> + + <note> + <para><literal>&prompt.root;</literal> et + <literal>&prompt.user;</literal> sont des extensions + FreeBSD à DocBook, et ne font pas partie de la DTD + originale.</para> + </note> + </listitem> + </varlistentry> + + <varlistentry> + <term><sgmltag>userinput</sgmltag></term> + + <listitem> + <para>Quant il s'agit de texte que l'utilisateur doit taper, + mettez-le dans un élément <sgmltag>userinput</sgmltag>. Il + sera normalement affiché différement.</para> + </listitem> + </varlistentry> + </variablelist> + + <example> + <title><sgmltag>screen</sgmltag>, <sgmltag>prompt</sgmltag> et + <sgmltag>userinput</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<screen>&prompt.user; <userinput>ls -1</userinput> +foo1 +foo2 +foo3 +&prompt.user; <userinput>ls -1 | grep foo2</userinput> +foo2 +&prompt.user; <userinput>su</userinput> +<prompt>Password: </prompt> +&prompt.root; <userinput>cat foo2</userinput> +C'est le fichier 'foo2'</screen>]]></programlisting> + + <para>Apparence:</para> + + <screen>&prompt.user; <userinput>ls -1</userinput> +foo1 +foo2 +foo3 +&prompt.user; <userinput>ls -1 | grep foo2</userinput> +foo2 +&prompt.user; <userinput>su</userinput> +<prompt>Password: </prompt> +&prompt.root; <userinput>cat foo2</userinput> +C'est le fichier 'foo2'</screen> + </example> + + <note> + <para>Bien que nous montrions le contenu du fichier + <filename>foo2</filename>, nous n'utilisons + <emphasis>pas</emphasis> la marque + <sgmltag>programlisting</sgmltag>. Réservez + <sgmltag>programlisting</sgmltag> pour les extraits de fichiers + hors du dialogue homme/machine.</para> + </note> + </sect3> + </sect2> + + <sect2> + <title>Eléments en ligne</title> + + <sect3> + <title>Mettre de l'information en valeur</title> + + <para>Si vous voulez mettre en valeur un mot ou une phrase, + servez-vous de <sgmltag>emphasis</sgmltag>. La présentation en sera + peut-être en italiques, ou gras, ou bien ce sera prononcé + différement par un logiciel de synthèse vocale.</para> + + <para>Il n'y a aucun moyen de changer la présentation du texte mis en + valeur dans votre document, pas d'équivalent des + <sgmltag>b</sgmltag> et <sgmltag>i</sgmltag>. Si l'information que + vous donnez est importante, envisagez d'utiliser + <sgmltag>important</sgmltag> plutôt que + <sgmltag>emphasis</sgmltag>.</para> + + <example> + <title><sgmltag>emphasis</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>FreeBSD est sans aucun doute + <emphasis>le</emphasis> premier système + d'exploitation de type Unix pour + architecture Intel.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>FreeBSD est sans aucun doute + <emphasis>le</emphasis> premier + système d'exploitation de type Unix pour architecture + Intel.</para> + </example> + </sect3> + + <sect3> + <title>Applications, commandes, options et références</title> + + <para>Il vous arrivera souvent de désigner des applications ou des + commandes quand vous rédigerez quelque chose pour le Manuel de + Référence. Distinguer les unes des autres est simple : une + application est un ensemble de (ou éventuellement un seul) + programmes dédiés à une tâche particulière. Une commande est le nom + d'un programme que l'utilisateur peut exécuter.</para> + + <para>Vous aurez aussi de temps à autre à lister une ou plusieurs des + options d'une commande.</para> + + <para>Pour finir, il arrivera souvent que vous vouliez indiquer en + même temps que la commande, son numéro de section dans les pages de + manuel, au format “commande(numéro)” habituel dans les + documentations Unix.</para> + + <para>Désignez les noms d'applications avec + <sgmltag>application</sgmltag>.</para> + + <para>Si vous voulez lister une commande avec son numéro de section + dans le manuel (ce qui sera la plupart du temps le cas), l'élément + DocBook pour cela est <sgmltag>citerefentry</sgmltag>. Il contiendra + deux autres éléments, <sgmltag>refentrytitle</sgmltag> et + <sgmltag>manvolnum</sgmltag>. Le contenu de + <sgmltag>refentrytitle</sgmltag> est le nom de la commande, et celui + de <sgmltag>manvolnum</sgmltag> est son numéro de section dans le + manuel.</para> + + <para>Ce peut être fastidieux à taper, aussi a-t-on défini une séries + d'<link + linkend="sgml-primer-general-entities">entités générales</link> + pour faciliter ces références. Chacune de ces entités est de la + forme + <literal>&man.<replaceable>page-de-manuel</replaceable>.<replaceable>section-du-manuel</replaceable>;</literal>.</para> + + <para>Ces entités sont dans le fichier + <filename>doc/share/sgml/man-refs.ent</filename>, qui peut-être + référencé par le FPI :</para> + + <programlisting>PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"</programlisting> + + <para>L'introduction de votre documentation ressemblera donc + probalement à :</para> + + <programlisting><!DOCTYPE book PUBLIC + "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [ + +<!ENTITY % man PUBLIC + "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN"> +%man; + +… + +]></programlisting> + + <para>Servez-vous de <sgmltag>command</sgmltag> quand vous voulez + mettre le nom d'une commande dans le texte en le présentant comme + quelque chose que l'utilisateur doit taper.</para> + + <para>Utilisez <sgmltag>option</sgmltag> pour désigner les options + d'une commande.</para> + + <para>Ce peut être confus, et le bon choix n'est pas toujours évident. + Espérons que les exemples qui suivent éclaircirons les + choses.</para> + + <example> + <title>Applications, commandes et options.</title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para><application>Sendmail</application> est le logiciel de + courrier électronique le plus employé sous Unix.</para> + +<para><application>Sendmail</application> comporte les + programmes <citerefentry> + <refentrytitle>sendmail</refentrytitle> + <manvolnum>8</manvolnum> + </citerefentry> et &man.newaliases.8;.</para> + +<para>L'un des paramètres de la ligne de commande de + <citerefentry><refentrytitle>sendmail</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, + <option>-bp</option>, affiche l'état des messages + dans la file d'attente. Vérifiez-le en exécutant + <command>sendmail -bp</command>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para><application>Sendmail</application> est le logiciel de + courrier électronique le plus employé sous Unix.</para> + + <para><application>Sendmail</application> comporte les programmes + <citerefentry><refentrytitle>sendmail</refentrytitle> + <manvolnum>8</manvolnum></citerefentry> et + <citerefentry><refentrytitle>newaliases</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>.</para> + + <para>L'un des paramètres de la ligne de commande de + <citerefentry><refentrytitle>sendmail</refentrytitle> + <manvolnum>8</manvolnum></citerefentry>, <option>-bp</option>, + affiche l'état des messages dans la file d'attente. Vérifiez-le + en exécutant <command>sendmail -bp</command>.</para> + </example> + + <note> + <para>Remarquez comme il est plus facile d'utiliser la notation + <literal>&man.<replaceable>commande</replaceable>.<replaceable>section</replaceable>;</literal>.</para> + </note> + </sect3> + + <sect3> + <title>Fichiers, répertoires, extensions</title> + + <para>Chaque fois que vous voulez donner le nom d'un fichier, d'un + répertoire ou de l'extension d'un fichier, servez-vous de + <sgmltag>filename</sgmltag>.</para> + + <example> + <title><sgmltag>filename</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>Vous trouverez le source SGML du Manuel + de Référence en Anglais dans + <filename>/usr/doc/en/handbook/</filename>. Le + fichier principal, dans ce répertoire, s'appelle + <filename>handbook.sgml</filename>. Il doit aussi + y avoir un <filename>Makefile</filename> et un + certain nombre de fichiers avec l'extension + <filename>.ent</filename>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>Vous trouverez le source SGML du Manuel de Référence en + Anglais dans <filename>/usr/doc/en/handbook/</filename>. Le + fichier principal, dans ce répertoire, s'appelle + <filename>handbook.sgml</filename>. Il doit aussi y avoir un + <filename>Makefile</filename> et un certain nombre de fichiers + avec l'extension <filename>.ent</filename>.</para> + </example> + </sect3> + + <sect3> + <title>Fichiers spéciaux de périphériques</title> + + <note> + <title>extension FreeBSD</title> + + <para>Ces éléments font partie des extensions FreeBSD à DocBook et + n'existent pas dans la DTD DocBook d'origine.</para> + </note> + + <para>Pour faire référence à des fichiers spéciaux de périphériques, + vous avez deux solutions. Soit utiliser le nom du fichier spécial + dans <filename>/dev</filename>, soit le nom sous lequel il est + désigné dans le noyau. Dans ce dernier cas, servez-vous de + <sgmltag>devicename</sgmltag>.</para> + + <para>Il y a des cas où vous n'aurez pas le choix. Pour certains + périphériques, les cartes réseaux par exemple, il n'y a pas + d'entrées dans <filename>/dev</filename>, ou bien celles-ci sont + très différentes des noms utilisés dans le noyau.</para> + + <example> + <title><sgmltag>devicename</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para><devicename>sio</devicename> sert + sous FreeBSD aux communications séries. + <devicename>sio</devicename> correspond + à un certain nombre d'entrées dans + <filename>/dev</filename>, dont + <filename>/dev/ttyd0</filename> et + <filename>/dev/cuaa0</filename>.</para> + +<para>A l'inverse, les périphériques réseaux, tel que + <devicename>ed0</devicename> n'apparaissent pas dans + <filename>/dev</filename>.</para> + +<para>Sous MS-DOS, le premier lecteur de disquette s'appelle + <devicename>a:</devicename>. Sous FreeBSD, c'est + <filename>/dev/fd0</filename>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para><devicename>sio</devicename> sert sous FreeBSD aux + communications séries. <devicename>sio</devicename> correspond à + un certain nombre d'entrées dans <filename>/dev</filename>, dont + <filename>/dev/ttyd0</filename> et + <filename>/dev/cuaa0</filename>.</para> + + <para>A l'inverse, les périphériques réseaux, tel que + <devicename>ed0</devicename> n'apparaissent pas dans + <filename>/dev</filename>.</para> + + <para>Sous MS-DOS, le premier lecteur de disquette s'appelle + <devicename>a:</devicename>. Sous FreeBSD, c'est + <filename>/dev/fd0</filename>.</para> + </example> + </sect3> + + <sect3> + <title>Machines, domaines, adresses IP, et ainsi de suite</title> + + <note> + <title>extension FreeBSD</title> + + <para>Ces éléments font partie des extensions FreeBSD à DocBook et + n'existent pas dans la DTD DocBook d'origine.</para> + </note> + + <para>Il y a différentes façons de dénoter les informations + d'identification des machines en réseau, selon le type + d'information. Elles utilisent toutes <sgmltag>hostid</sgmltag> + comme élément, l'attribut <literal>role</literal> servant à + qualifier le type d'information.</para> + + <variablelist> + <varlistentry> + <term>Pas de valeur de l'attribut, ou + <literal>role="hostname"</literal></term> + + <listitem> + <para>Sans valeur de l'attribut (i.e., + <sgmltag>hostid</sgmltag>...<sgmltag>hostid</sgmltag>), + l'information donnée est le seul nom de la machine, + <literal>freefall</literal> ou <literal>wcarchive</literal>, + par exemple. Vous pouvez l'expliciter avec + <literal>role="hostname"</literal>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>role="domainname"</literal></term> + + <listitem> + <para>C'est ici un nom de domaine, comme + <literal>FreeBSD.org</literal> ou + <literal>ngo.org.uk</literal>. Il n'y a pas de nom de + machine.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>role="fqdn"</literal></term> + + <listitem> + <para>C'est le nom complet de la + machine - <foreignphrase>Fully Qualified Domain + Name</foreignphrase>, composé du nom de la machine et du nom + de domaine.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>role="ipaddr"</literal></term> + + <listitem> + <para>On donne alors l'adresse IP, probablement sous forme de + quatre nombres séparés par des points.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>role="netmask"</literal></term> + + <listitem> + <para>C'est un masque de sous-réseau, qui peut être donné comme + quatre nombres séparés par des points, un chaîne en + hexadécimal ou un <literal>/</literal> suivi d'un + nombre.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>role="mac"</literal></term> + + <listitem> + <para>C'est une adresse Ethernet MAC, exprimée par un séries de + valeurs hexadéciamales sur deux positions séparées par des + deux-points.</para> + </listitem> + </varlistentry> + </variablelist> + + <example> + <title><sgmltag>hostid</sgmltag> et <literal>role</literal>s</title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>La machine locale peut toujours + être désignée par <hostid>localhost</hostid>, + et aura l'adresse IP + <hostid role="ipaddr">127.0.0.1</hostid>.</para> + +<para>Le domaine + <hostid role="domainname">FreeBSD.org</hostid> + inclut un certain nombre de machine, dont + <hostid role="fqdn">freefall.FreeBSD.org</hostid> et + <hostid role="fqdn">bento.FreeBSD.org</hostid>.</para> + +<para>Quand vous ajoutez un alias IP à une interface (avec + <command>ifconfig</command>), utilisez + <emphasis>toujours</emphasis> le masque de sous-réseau + <hostid role="netmask">255.255.255.255</hostid> + (qui peut aussi s'écrire + <hostid role="netmask">0xffffffff)</hostid>.</para> + +<para>L'adresse MAC identifie de façon unique + chaque carte réseau existante. Une adresse MAC + ressemble typiquement à <hostid + role="mac">08:00:20:87:ef:d0</hostid>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>La machine locale peut toujours être désignée par + <hostid>localhost</hostid>, et aura l'adresse IP + <hostid role="ipaddr">127.0.0.1</hostid>.</para> + + <para>Le domaine <hostid role="domainname">FreeBSD.org</hostid> + inclut un certain nombre de machine, dont + <hostid role="fqdn">freefall.FreeBSD.org</hostid> et + <hostid role="fqdn">bento.FreeBSD.org</hostid>.</para> + + <para>Quand vous ajoutez un alias IP à une interface (avec + <command>ifconfig</command>), utilisez + <emphasis>toujours</emphasis> le masque de sous-réseau + <hostid role="netmask">255.255.255.255</hostid> + (qui peut aussi s'écrire + <hostid role="netmask">0xffffffff</hostid>).</para> + + <para>L'adresse MAC identifie de façon unique chaque carte réseau + existante. Une adresse MAC ressemble typiquement à <hostid + role="mac">08:00:20:87:ef:d0</hostid>.</para> + </example> + </sect3> + + <sect3> + <title>Noms d'utilisateurs</title> + + <note> + <title>extension FreeBSD</title> + + <para>Ces éléments font partie des extensions FreeBSD à DocBook et + n'existent pas dans la DTD DocBook d'origine.</para> + </note> + + <para>Si vous avez besoin de faire référence à un nom d'utilisateur, + comme <literal>root</literal> ou <literal>bin</literal>, servez-vous + de <sgmltag>username</sgmltag>.</para> + + <example> + <title><sgmltag>username</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>Pour effectuer la plupart des + tâches d'administration système, + vous aurez besoin d'être + <username>root</username>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>Pour effectuer la plupart des tâches d'administration système, + vous aurez besoin d'être <username>root</username>.</para> + </example> + </sect3> + + <sect3> + <title>Décrire les <filename>Makefile</filename>s</title> + + <note> + <title>extension FreeBSD</title> + + <para>Ces éléments font partie des extensions FreeBSD à DocBook et + n'existent pas dans la DTD DocBook d'origine.</para> + </note> + + <para>Il y a des éléments pour décrire les composantes d'un + <filename>Makefile</filename>s, <sgmltag>maketarget</sgmltag> et + <sgmltag>makevar</sgmltag>.</para> + + <para><sgmltag>maketarget</sgmltag> désigne une cible définie dans un + <filename>Makefile</filename> qui peut être utilisée en paramètre de + <command>make</command>. <sgmltag>makevar</sgmltag> désigne une + variable qui peut être définie (dans l'environnement, sur la ligne + de commande de <command>make</command> ou dans le + <filename>Makefile</filename>) et affecte le processus .</para> + + <example> + <title><sgmltag>maketarget</sgmltag> et + <sgmltag>makevar</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>Il y a deux cibles courantes dans les + <filename>Makefile</filename> : + <maketarget>all</maketarget> et + <maketarget>clean</maketarget>.</para> + +<para>Généralement, invoquer <maketarget>all</maketarget> + reconstruit l'application, et invoquer + <maketarget>clean</maketarget> supprime les + fichiers temporaires (<filename>.o</filename> + par exemple) créés lors de la reconstruction.</para> + +<para><maketarget>clean</maketarget> peut être + contrôlée par un certain nombre + de variables, dont <makevar>CLOBBER</makevar> et + <makevar>RECURSE</makevar>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>Il y a deux cibles courantes dans les + <filename>Makefile</filename> : <maketarget>all</maketarget> + et <maketarget>clean</maketarget>.</para> + + <para>Généralement, invoquer <maketarget>all</maketarget> + reconstruit l'application, et invoquer + <maketarget>clean</maketarget> supprime les fichiers temporaires + (<filename>.o</filename> par exemple) créés lors de la + reconstruction.</para> + + <para><maketarget>clean</maketarget> peut être contrôlée par un + certain nombre de variables, dont <makevar>CLOBBER</makevar> et + <makevar>RECURSE</makevar>.</para> + </example> + </sect3> + + <sect3> + <title>Litéraux</title> + + <para>Vous aurez souvent besoin d'inclure “litéralement” + du texte dans le Manuel. Ce sont des extraits d'un fichier, que l'on + doit pouvoir copier tel quel dans un autre fichier.</para> + + <para>Il vous suffira parfois de <sgmltag>programlisting</sgmltag> + pour cela. <sgmltag>programlisting</sgmltag> n'est pas toujours + approprié, en particulier quand vous voulez inclure un extrait + de fichier au fil de l'eau, dans le corps même du paragraphe.</para> + + <para>Servez-vous dans ces cas-là de + <sgmltag>literal</sgmltag>.</para> + + <example> + <title><sgmltag>literal</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>La ligne <literal>maxusers 10</literal> du fichier + de configuration du noyau détermine la table de nombreuses + tables système et définit approximativement le nombre de + connexions simultanées qu'acceptera le système.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>La ligne <literal>maxusers 10</literal> du fichier de + configuration du noyau détermine la table de nombreuses tables + système et définit approximativement le nombre de connexions + simultanées qu'acceptera le système.</para> + </example> + </sect3> + + <sect3> + <title>Montrer ce que l'utilisateur <emphasis>doit</emphasis> + renseigner</title> + + <para>Il arrivera souvent que vous vouliez montrer à l'utilisateur ce + qu'il doit faire, faire référence à un fichier, à une ligne de + commande, ou autre, dans lesquels l'utitilisateur ne pourra pas + purement et simplement copier les examples que vous lui donnez, mais + devra y renseigner lui-même certaines informations.</para> + + <para><sgmltag>replaceable</sgmltag> est prévu pour ces cas-là. + Servez-vous en <emphasis>à l'intérieur</emphasis> d'autres éléments + pour indiquer quels contenus l'utilisateur doit remplacer.</para> + + <example> + <title><sgmltag>replaceable</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<informalexample> + <screen>&prompt.user; <userinput>man + <replaceable>command</replaceable></userinput></screen> +</informalexample>]]></programlisting> + + <para>Apparence :</para> + + <informalexample> + <screen>&prompt.user; <userinput>man <replaceable>command</replaceable></userinput></screen> + </informalexample> + + <para><sgmltag>replaceable</sgmltag> peut servir dans de nombreux + autres éléments, dont <sgmltag>literal</sgmltag>. Cet exemple + montre aussi qu'il ne faut mettre <sgmltag>replaceable</sgmltag> + qu'autour du contenu que l'utilisateur <emphasis>doit</emphasis> + fournir. Il faut laisser le reste tel quel.</para> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>La ligne <literal>maxusers 10</literal> du fichier + de configuration du noyau détermine la table de nombreuses + tables système et définit approximativement le nombre + de connexions simultanées qu'acceptera le système.</para> + +<para><literal>32</literal> est un valeur correcte de + <replaceable>n</replaceable> pour une station + de travail.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>La ligne <literal>maxusers 10</literal> du fichier de + configuration du noyau détermine la table de nombreuses tables + système et définit approximativement le nombre de connexions + simultanées qu'acceptera le système.</para> + + <para><literal>32</literal> est un valeur correcte de + <replaceable>n</replaceable> pour une station de travail.</para> + </example> + </sect3> + </sect2> + + <sect2> + <title>Liens</title> + + <note> + <para>Les liens sont aussi des éléments en ligne.</para> + </note> + + <sect3> + <title>Mettre des liens vers d'autres parties du même document</title> + + <para>Pour mettre de liens à l'intérieur même du document, il faut que + vous précisiez d'où part le lien (i.e., le texte ou autre, sur + lequel l'utilisateur clique) et où il va.</para> + + <para>Chaque élément DocBook possède un attribut + <literal>id</literal>. Vous pouvez utiliser cet attribut pour donner + un nom unique à l'élément.</para> + + <para>C'est cette valeur que vous utiliserez quand vous préciserez + la destination du lien.</para> + + <para>Habituellement, vous mettrez des liens sur des chapitres ou des + sections, vous ajouterez donc un attribut <literal>id</literal> à + ces éléments.</para> + + <example> + <title><literal>id</literal> de chapitres et de section</title> + + <programlisting><![ CDATA [<chapter id="chapitre1"> + <title>Introduction</title> + + <para>C'est l'introduction. Elle comporte une sous-section, + qui a aussi un identifiant.</para> + + <sect1 id="chapter1-sect1"> + <title>Sous-section 1</title> + + <para>C'est la sous-section.</para> + </sect1> +</chapter>]]></programlisting> + </example> + + <para>Vous devriez utiliser des valeurs plus explicites. Ces valeurs + doivent être uniques pour le document (i.e., pas uniquement dans le + fichier, mais dans le document dans lequel le fichier peut + éventuellement être inclus aussi). Remarquez que + l'<literal>id</literal> de la sous-section est construit en le + préfixant de l'<literal>id</literal> du chapitre. Cela aide à + construire des identifiants uniques.</para> + + <para>Si vous voulez que l'utilisateur puisse aller à un endroit + précis du document (éventuellement au milieu du paragraphe), ou à un + exemple, servez-vous de <sgmltag>anchor</sgmltag>. Cet élément n'a + pas de contenu, mais il a un attribut <literal>id</literal>.</para> + + <example> + <title><sgmltag>anchor</sgmltag></title> + + <programlisting><![ CDATA [<para>Ce paragraphe inclut un + <anchor id="para1">lien interne. Il n'apparaît + pas dans le document.</para>]]></programlisting> + </example> + + <para>Si vous voulez fournir à l'utilisateur un lien qu'il puisse + activer (probablement en cliquant dessus) pour aller à une section + du document qui a un attribut <literal>id</literal>, vous pouvez + vous servir de <sgmltag>xref</sgmltag> ou + <sgmltag>link</sgmltag>.</para> + + <para>Ces deux éléments ont un attribut <literal>linkend</literal>. + La valeur de cette attribut doit être celle que vous avez utilisée + comme attribut <literal>id</literal> (peu importe si cette valeur + n'a pas encore été définie dans le document, les liens peuvent être + en avant ou en arrière).</para> + + <para>Si vous vous servez de <sgmltag>xref</sgmltag>, vous n'avez pas + le contrôle du texte du lien. Il sera généré automatiquement.</para> + + <example> + <title>Se servir de <sgmltag>xref</sgmltag></title> + + <para>Supposons que ce fragment apparaisse quelque part dans un + document qui contienne l'exemple que nous avons donné pour + <literal>id</literal> :</para> + + <programlisting><![ CDATA [<para>Vous trouverez plus d'information + au <xref linkend="chapter1">.</para> + +<para>Vous trouverez des informations plus détaillées dans + <xref linkend="chapter1-sect1">.</para>]]></programlisting> + + <para>Le texte du lien sera généré automatiquement, et cela + ressemblera à (le texte mis <emphasis>en valeur</emphasis> indique + que c'est cela le lien) :</para> + + <blockquote> + <para>Vous trouverez plus d'information au <emphasis>Chapitre + Un</emphasis>.</para> + + <para>Vous trouverez des informations plus détaillées dans + <emphasis>la section appellée Sous-section 1</emphasis>.</para> + </blockquote> + </example> + + <para>Remarquez que le texte du lien est construit à partir du titre + de la section ou du numéro du chapitre.</para> + + <note> + <para>Cela veut dire que vous <emphasis>ne pouvez pas</emphasis> + utiliser <sgmltag>xref</sgmltag> pour mettre un lien sur + l'attribut <literal>id</literal> d'un élément + <sgmltag>anchor</sgmltag>. L'<sgmltag>anchor</sgmltag> n'a pas de + contenu et <sgmltag>xref</sgmltag> ne pourrait donc pas générer le + texte du lien.</para> + </note> + + <para>Si vous voulez avoir la maîtrise du texte du lien, servez-vous + alors de <sgmltag>link</sgmltag>. Cet élément encadre un contenu qui + sera utilisé comme lien.</para> + + <example> + <title>Utiliser <sgmltag>link</sgmltag></title> + + <para>Supposons que ce fragment apparaisse quelque part dans un + document qui contienne l'exemple que nous avons donné pour + <literal>id</literal> :</para> + + <programlisting><![ CDATA [<para>Vous trouverez plus d'information + au <link linkend="chapter1">premier chapitre</link>.</para> + +<para>Vous trouverez des informations plus détaillées dans + <link linkend="chapter1-sect1">cette</link> + section.</para>]]></programlisting> + + <para>Ce qui générera (le texte mis <emphasis>en valeur</emphasis> + indique que c'est cela le lien) :</para> + + <blockquote> + <para>Vous trouverez plus d'information au <emphasis>premier + chapitre</emphasis>.</para> + + <para>Vous trouverez des informations plus détaillées dans + <emphasis>cette</emphasis> section.</para> + + </blockquote> + </example> + + <note> + <para>Le dernier exemple n'est pas à suivre. N'utilisez jamais + “ce” ou “ici” comme origine du lien. Le + lecteur devra détailler le contexte dans lequel c'est employé pour + comprendre où le lien va le mener.</para> + </note> + + <note> + <para>Vous <emphasis>pouvez</emphasis> vous servir de + <sgmltag>link</sgmltag> pour mettre un lien sur un + <literal>id</literal> ou une <sgmltag>anchor</sgmltag>, puisque + le contenu du <sgmltag>link</sgmltag> définit le texte qui sera + utilisé comme lien.</para> + </note> + </sect3> + + <sect3> + <title>Liens vers d'autres documents sur le WWW</title> + + <para>Mettre des liens sur des documents externes est beaucoup plus + facile, si tant est que vous connaissiez l'URL du document sur + lequel vous voulez mettre un lien. Servez-vous de + <sgmltag>ulink</sgmltag>. L'attribut <literal>url</literal> sera + l'URL de la page où pointera le lien, et le contenu du lien sera + utilisé pour que l'utilisateur puisse l'activer.</para> + + <example> + <title><sgmltag>ulink</sgmltag></title> + + <para>Utilisez :</para> + + <programlisting><![ CDATA [<para>Vous pouvez bien sûr cessez de lire + ce document, et aller au lieu de cela sur la <ulink + url="http://www.FreeBSD.org/"> page Web de FreeBSD</ulink>.</para>]]></programlisting> + + <para>Apparence :</para> + + <para>Vous pouvez bien sûr cessez de lire ce document, et aller au + lieu de cela sur la <ulink + url="http://www.FreeBSD.org/"> page Web de + FreeBSD</ulink>.</para> + </example> + </sect3> + </sect2> + </sect1> + + <sect1> + <title>* LinuxDoc</title> + + <para>LinuxDoc est adapté de la DTD QWERTZ, et a été d'abord utilisé par + le <ulink url="http://sunsite.unc.edu/LDP/">Projet de Documentation de + Linux</ulink>, puis adopté ensuite par celui de FreeBSD.</para> + + <para>La DTD LinuxDoc utilise des marques qui décrivent avant tout + l'apparence du document et non son contenu (i.e., elle décrit à quoi + quelque chose ressemble, et non ce que c'est).</para> + + <para>Et le Projet de Documentation de FreeBSD et celui de Linux sont en + train de migrer de la DTD LinuxDoc à la DTD DocBook.</para> + + <para>La DTD LinuxDoc DTD est disponible au catalogue des logiciels portés, + dans la catégorie <filename>textproc/linuxdoc</filename>.</para> + </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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml new file mode 100644 index 0000000000..29422c6417 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml @@ -0,0 +1,1645 @@ +<!-- 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 + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:44 gioria Exp $ + Original revision: 1.8 +--> + +<chapter id="sgml-primer"> + <title>Introduction à SGML</title> + + <para>La majorité des documentations du FDP utilisent SGML. Ce chapitre vous + explique ce que cela signifie exactement, comment lire et comprendre le + source de la documentation et décrit la façon d'utiliser le SGML que vous + recontrerez dans la documentation.</para> + + <para>Des parties de cette section se sont inspirées du livre de Mark + Galassi, <ulink + url="http://nis-www.lanl.gov/~rosalia/mydocs/docbook-intro/docbook-intro.html">“<foreignphrase>Get Going With DocBook</foreignphrase>”</ulink>.</para> + + <sect1> + <title>Introduction</title> + + <para>Il était autrefois facile de travailler sur des documents + électroniques. Vous n'aviez normalement à connaître que le jeu de + caractères utilisé (ASCII, EBCDIC, ou l'un des nombreux autres) et + c'était à peu près tout. Le texte était du texte, et vous voyiez + vraiment ce que vous obteniez. Pas de sophistication, pas de formatage, + pas d'intelligence.</para> + + <para>Cela devint inévitablement insuffisant. Une fois que vous avez du + texte qu'une machine peut lire, vous vous attendez à ce que la machine + puisse l'utiliser et le manipuler intelligemment. Vous aimeriez pouvoir + préciser que certaines phrases sont accentuées, y ajouter un glossaire + ou des hyper-liens. Vous voulez que les noms de fichiers apparaissent + en police “machine à écrire” à l'écran et en italique à + l'impression, et tout un tas d'autres options de présentation + encore.</para> + + <para>Il fut un temps où l'on pensait que l'Intelligence Artificielle (IA) + rendrait cela facile. Votre ordinateur pourrait lire le document et + identifier les phrases clés, les noms de fichiers, le texte que + l'utilisateur devait taper, et d'autres encore. Malheureusement, la + réalité est un peu différente, et il faut aider nos ordinateurs à + manipuler intelligemment notre texte.</para> + + <para>Plus précisement, il faut les aider à indentifier ce qui est quoi. + Vous et moi, à la vue de :</para> + + <blockquote> + <para>Pour effacer <filename>/tmp/foo</filename>, utilisez + &man.rm.1; :</para> + + <screen>&prompt.user; <command>rm /tmp/foo</command></screen> + </blockquote> + + <para>distinguons facilement ce qui est nom de fichier, commande à + taper, référence aux pages de manuel, et ainsi de suite. Mais + l'ordinateur lui ne le peut pas. Pour cela, Nous avons besoin des + marques.</para> + + <para>Le “marquage” est communément qualifié de “valeur + ajoutée” ou “coût augmenté”. Le terme prend ces deux + sens quand il s'applique au texte. La marquage est du texte en + supplément dans le document, distinct par un moyen ou un autre du + contenu du document, de façon à ce que les programmes qui traitent le + document puisse le lire et l'utiliser pour prendre des décisions. Les + éditeurs peuvent masquer le marquage à l'utilisateur, de façon à ce + qu'il ne soit pas perturbé par ces marques.</para> + + <para>L'information supplémentaire donnée avec les marques + <emphasis>ajoute de la valeur</emphasis> au document. Le marquage doit + habituellement être manuel - après tout, si les ordinateurs + pouvait analyser suffisamment le texte pour ajouter les marques, il n'y + en aurait alors en fait pas besoin. Cela <emphasis>augment le + coût</emphasis> du document.</para> + + <para>L'exemple précédent est codé comme suit dans le présent + document :</para> + + <programlisting><![ CDATA [ +<para>Pour effacer <filename>/tmp/foo</filename>, utilisez + &man.rm.1;.</para> + +<para><command>rm /tmp/foo</command></para>]]></programlisting> + + <para>Comme vous pouvez le constater, le marquage est clairement séparé du + contenu.</para> + + <para>Bien évidemment, si vous devez utiliser des marques, vous devrez + définir ce que les marques veulent dire et comment elles doivent être + traitées. Il vous faudra un language de marquage auquel vous référer + pour marquer vos documents.</para> + + <para>Un seul language de marquage peut bien sûr ne pas suffire. Les + besoins de marquage d'une documentation technique diffèrent énormément + de ceux de recettes de cuisines. ces derniers seront à leur tour + différents de ceux d'un language de marquage pour de la poésie. Vous + avez en fait besoin d'un language qui vous permette de définir ces + autres languages de marquage. Un <emphasis>méta-language de + marquage</emphasis>.</para> + + <para>C'est exactement ce qu'est <foreignphrase>Standard Generalised + Markup Language (SGML)</foreignphrase> - Language de Marquage + Standard Généralisé. De nombreux languages de marquage sont écrits en + SGML, dont les deux languages les plus utilisés par le FDP, HTML et + DocBook.</para> + + <para>Chaque définition d'un language s'appelle plus exactement une + <foreignphrase>Document Type Definition + (DTD)</foreignphrase> - Définition de Type de Document. La DTD + définit les noms des éléments utilisables, leur ordre d'apparition (et + leur hiérarchie) et les informations qui s'y rapportent. Une DTD est + parfois désignée comme une <emphasis>application</emphasis> de + SGML.</para> + + <para id="sgml-primer-validating">Une DTD est une spécification + <emphasis>complète</emphasis> de tous les éléments autorisés, de l'ordre + dans lequel ils doivent être utilisés, quels sont ceux qui sont + obligatoires, quels sont ceux qui sont facultatifs, et ainsi de suite. + Il est alors possible d'écrire un <emphasis>analyseur</emphasis> qui + lise et la DTD et le document qui prétend s'y conformer. L'analyseur + peut alors vérifier si tous les éléments requis sont bien présents dans + l'ordre voulu dans le document et s'il y a des erreurs dans le marquage. + On appelle habituellement cela <quote>valider le + document</quote>.</para> + + <note> + <para>Ce traitement ne valide uniquement que le choix des éléments, leur + ordre, et ainsi de suite, se conforme à ce que définit la DTD. Il ne + vérifie <emphasis>pas</emphasis> que vous avez utilisé les marques + <emphasis>appropriées</emphasis> au document. Si vous marquez tous les + noms de fichiers de votre document comme des noms de fonctions, + l'analyseur ne le signalera pas comme une erreur (en supposant, bien + sûr, que votre DTD définisse des éléments pour les noms de fichiers et + de fonctions et qu'ils aient le droit d'apparaître aux mêmes + endroits).</para> + </note> + + <para>Il est probable que vos contributions au Projet de Documentation + consiste en documents marqués soit en HTML soit en DocBook, plutôt qu'en + modifications aux DTDs. Pour cette raison, cet ouvrage n'abordera pas la + façon d'écrire une DTD.</para> + </sect1> + + <sect1 id="sgml-primer-elements"> + <title>Eléments, marques et attributs</title> + + <para>Toutes les DTDs écrites en HTML ont des caractéristiques communes. + Ce n'est guère surprenant comme le montre inévitablement la philosophie + qui sous-tend SGML. Une des manifestations les plus visibles de cette + philosophie est la caractérisation en <emphasis>contenu</emphasis> et + <emphasis>éléments</emphasis>.</para> + + <para>Votre documentation (que ce soit une seule page Web ou un ouvrage + volumineux) est vue comme étant un contenu. Ce contenu est alors divisé + (et ensuite subdivisé) en éléments. L'objectif de l'ajout de marques est + de nommer et de définir le début et la fin de ces éléments pour + traitement ultérieur.</para> + + <para>Considérez par exemple un livre type. Au plus haut niveau, ce livre + lui-même est un élément. Cet élément “livre” contient + évidemment des chapitres, qui peuvent aussi être légitimement considérés + comme des éléments. Chaque chapitre contiendra à son tour des éléments, + tels que des paragraphes, des citations et de notes de bas de page. + Chaque paragraphe peut lui-même contenir encore des éléments, pour + identifier le texte parlé par exemple, ou les noms des personnages de + l'histoire.</para> + + <para>Vous pouvez si vous le voulez voir cela comme un + “morcelement” du contenu. A la racine, vous avez un morceau, + le livre. Un niveau en dessous, vous avez plus de morceaux, les + chapitres individuels. Ils sont à leur tour morcelés en pargraphes, + notes de bas de page, noms des personnages, et ainsi de suite.</para> + + <para>Remarquez que vous pouvez différencier les éléments sans utiliser + la terminologie SGML. C'est vraiment immédiat. Vous pouvez le faire avec + un surligneur et un livre imprimé, en utilisant des couleurs différentes + pour chaque type d'élément.</para> + + <para>Nous n'avons bien sûr pas de surligneur électronique, il nous faut + donc un autre moyen d'indiquer à quel élément appartient chaque morceau + du contenu. Dans les languages écrits avec SGML ,(HTML, DocBook, et + al.), cela se fait avec des <emphasis>marques</emphasis>.</para> + + <para>Une marque sert à dire où commence et où finit un élément. + <emphasis>La marque ne fait pas partie de l'élément lui-même</emphasis>. + Comme chaque DTD est habituellement écrite pour marquer des types + d'informations spécifiques, chacune reconnaîtra des éléments différents, + et aura donc des noms différents pour les marques.</para> + + <para>Pour un élément appelé <replaceable>nom-de-l'élément</replaceable>, + la marque de début sera normalement + <literal><<replaceable>nom-de-l'élément</replaceable>></literal>. + La marque de fin correspondante sera + <literal></<replaceable>nom-de-l'élément</replaceable>></literal>.</para> + + <example> + <title>Utiliser un élément (marques de début et de fin)</title> + + <para>HTML dispose d'un élément pour indiquer que le contenu inclus est + un paragraphe, appelé <literal>p</literal>. Cet élément a une marque + de début et une de fin.</para> + + <programlisting> +<![ CDATA [<p>C'est un paragraphe. Il commence avec la marque de début pour + l'élément 'p', et se terminera avec la marque de fin pour + l'élément 'p'</p> + +<p>C'est un autre paragraphe. Mais il est beaucoup plus + court.</p>]]></programlisting> + </example> + + <para>Tous les éléments n'ont pas besoin d'une marque de fin. Certains + n'ont pas de contenu. En HTML, par exemple, vous pouvez indiquer que + vous voulez avoir une ligne horizontal dans votre document. Cette ligne + n'a bien sûr aucun contenu, vous n'avez donc besoin que de la marque de + début pour cet élément.</para> + + <example> + <title>Utiliser un élément (marque de début uniquement)</title> + + <para>HTML dispose d'un élément pour inclure une ligne horizontale, + appelé <literal>hr</literal>. C'est un élément sans contenu, il n'a + donc qu'une marque de début.</para> + + <programlisting> +<![ CDATA [<p>C'est un paragraphe.</p> + +<hr> + +<p>C'est un autre paragraphe. Une ligne horizontale le sépare + du précédent.</p>]]></programlisting> + </example> + + <para>Si ce n'était pas encore clair, les éléments peuvent contenir + d'autres éléments. Dans l'exemple du livre plus haut, ce livre contenait + tous les chapitres, qui à leur tour contenaient tous les paragraphes, et + ainsi de suite.</para> + + <example> + <title>Eléments dans des éléments ; <sgmltag>em</sgmltag></title> + + <programlisting> +<![ CDATA [<p>C'est un <em>paragraphe</em> simple où certains + <em>mots</em> ont été <em>mis en valeur</em>.</p>]]></programlisting> + </example> + + <para>La DTD définira les règles qui disent quels éléments peuvent être + inclus dans quels autres éléments, et ce qu'ils peuvent précisement + contenir.</para> + + <important> + <para>Les gens confondent souvent marques et éléments comme si c'étaient + des termes interchangeables. Ce n'est pas le cas.</para> + + <para>Un élément est une partie de la structure d'un document. Un + élément a un début et une fin. Les marques définissent où commence et + où finit le document.</para> + + <para>Quand le présent document (ou quelqu'un d'autre qui connait le + SGML) parle de la marque “the <p> tag”, cela se + rapporte au texte composé des trois caractères + <literal><</literal>, <literal>p</literal> + et <literal>></literal>. Mais la phrase “l'élément + <p>” désigne tout l'élément.</para> + + <para>Cette distinction <emphasis>est</emphasis> très subtile. Mais + gardez la à l'esprit.</para> + </important> + + <para>Les éléments peuvent avoir des attributs. Un attribut a un nom et + une valeur, et sert à donner des informations supplémentaires + concernant l'élément. Ce peuvent être des informations qui précisent + comment l'élément doit être formaté, ou un identifiant unique pour cette + occurrence de l'élément, ou autre chose encore.</para> + + <para>Les attributs d'un élément sont donnés <emphasis>dans</emphasis> la + marque de début de l'élément et ont la forme + <literal><replaceable>nom-de-l'attribut</replaceable>="<replaceable>valeur-de-l'attribut</replaceable>"</literal>.</para> + + <para>Dans les versions récentes d'HTML, l'élément <sgmltag>p</sgmltag> a + un attribut appelé <literal>align</literal>, qui suggère un alignement + (justification) du paragraphe au programme affichant l'HTML.</para> + + <para>L'attribut <literal>align</literal> peut prendre l'une des quatre + valeurs prédéfinies, <literal>left</literal>, <literal>center</literal>, + <literal>right</literal> et <literal>justify</literal>. Si l'attribut + n'est pas précise, la valeur par défaut est + <literal>left</literal>.</para> + + <example> + <title>Utiliser un élément avec un attribut</title> + + <programlisting> +<![ CDATA [<p align="left">L'attribut align est superflus pour ce paragraphe, + puisque 'left' est la valeur par défaut.</p> + +<p align="center">Ce paragraphe sera peut-être centré.</p>]]></programlisting> + </example> + + <para>Certains attributs ne prennent que des valeurs prédéfinies, comme + <literal>left</literal> ou <literal>justify</literal>. D'autres peuvent + prendre les valeurs que vous voulez. Si vous avez besoin de quotes + (<literal>"</literal>) dans un attribut, mettez la valeur de l'attribut + entre simples quotes.</para> + + <example> + <title>Simples quotes dans un attribut</title> + + <programlisting> +<![ CDATA [<p align='right'>Je suis à droite !</p>]]></programlisting> + </example> + + <para>Vous n'avez pas toujours besoin de mettre la valeur de l'attribut + entre simples quotes. Les régles à ce sujet sont cependant subtiles, et + il est beaucoup plus simple de <emphasis>toujours</emphasis> mettre + entre simples quotes les valeurs des attributs.</para> + + <sect2> + <title>A faire…</title> + + <para>Pour tester les exemples donnés dans ce document, vous devrez + installer des logiciels sur votre système et vérifiez qu'une variable + d'environnement est correctement définie.</para> + + <procedure> + <step> + <para>Téléchargez et installez <filename>textproc/docproj</filename> + du catalogue des logiciels portés de FreeBSD. C'est un + <emphasis>méta-port</emphasis> qui doit télécharger et installer + tous les programmes et fichiers utilisés par le Projet de + Documentation.</para> + </step> + + <step> + <para>Ajoutez les lignes pour définir + <envar>SGML_CATALOG_FILES</envar> à vos procédures + d'initialisation de l'interpréteur de commandes.</para> + + <example id="sgml-primer-envars"> + <title><filename>.profile</filename>, pour les utilisateurs de + &man.sh.1; et &man.bash.1;</title> + + <programlisting> +SGML_ROOT=/usr/local/share/sgml +SGML_CATALOG_FILES=${SGML_ROOT}/jade/catalog +SGML_CATALOG_FILES=${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES +SGML_CATALOG_FILES=${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES +SGML_CATALOG_FILES=${SGML_ROOT}/docbook/catalog:$SGML_CATALOG_FILES +export SGML_CATALOG_FILES</programlisting> + </example> + + <example> + <title><filename>.login</filename>, pour les utilisateurs de + &man.csh.1; et &man.tcsh.1;</title> + + <programlisting> +setenv SGML_ROOT /usr/local/share/sgml +setenv SGML_CATALOG_FILES ${SGML_ROOT}/jade/catalog +setenv SGML_CATALOG_FILES ${SGML_ROOT}/iso8879/catalog:$SGML_CATALOG_FILES +setenv SGML_CATALOG_FILES ${SGML_ROOT}/html/catalog:$SGML_CATALOG_FILES +setenv SGML_CATALOG_FILES ${SGML_ROOT}/docbook/catalog:$SGML_CATALOG_FILES</programlisting> + </example> + + <para>Déconnectez-vous et reconnectez-vous ensuite, ou exécutez ces + commandes pour définir la variable d'environnement.</para> + </step> + + <step> + <para>Créez un fichier <filename>exemple.sgml</filename>, où vous + mettrez :</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 + Transitional//EN"> + +<html> + <head> + <title>Exemple de fichier HTML</title> + </head> + + <body> + <p>C'est un paragraphe avec du texte.</p> + + <p>C'est encore un paragraphe avec du texte.</p> + + + <p align="right">Ce paragraphe sera peut-être justifié à + droite.</p> + </body> +</html>]]></programlisting> + </step> + + <step> + <para>Essayez de le valider avec un analyseur syntaxique + SGML.</para> + + <para><link linkend="sgml-primer-validating">L'analyseur + syntaxique</link> &man.nsgmls.1; fait partie de + <filename>textproc/docproj</filename>. &man.nsgmls.1; lit + normalement un document marqué en utilisant une DTD SGML et génère + l'<foreignphrase>Element Structure Information Set + (ESIS)</foreignphrase> - Informations sur la + Structuration en Eléments - mais cela ne nous concerne + pas pour le moment.</para> + + <para>Néanmoins, avec le paramètre <option>-s</option>, + &man.nsgmls.1; ne génère rien mais affiche simplement les messages + d'erreurs éventuels. C'est utile pour vérifier si votre document + est correct ou non.</para> + + <para>Utilisez &man.nsgmls.1; pour vérifier si votre document est + valide :</para> + + <screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput></screen> + + <para>Vous constaterez que &man.nsgmls.1; n'affiche rien. Cela + signifie qu'il a validé votre document.</para> + </step> + + <step> + <para>Voyez ce qui ce passe si vous oubliez un élément requis. + Supprimez les marques <sgmltag>title</sgmltag> et + <sgmltag>/title</sgmltag> et relancer la validation.</para> + + <screen>&prompt.user; <userinput>nsgmls -s example.sgml</userinput> +nsgmls:example.sgml:5:4:E: character data is not allowed here +nsgmls:example.sgml:6:8:E: end tag for "HEAD" which is not finished</screen> + + <para>Les messages d'erreur de &man.nsgmls.1; sont structurés en + colonnes séparés par des deux-points ou des + points-virgules.</para> + + <informaltable frame="none"> + <tgroup cols="2"> + <thead> + <row> + <entry>Colonne</entry> + <entry>Signification</entry> + </row> + </thead> + + <tbody> + <row> + <entry>1</entry> + <entry>Nom du programme qui a généré l'erreur. Ce sera + toujours <literal>nsgmls</literal>.</entry> + </row> + + <row> + <entry>2</entry> + <entry>Nom du fichier où se trouve l'erreur.</entry> + </row> + + <row> + <entry>3</entry> + <entry>Numéro de la ligne où se trouve l'erreur.</entry> + </row> + + <row> + <entry>4</entry> + <entry>Numéro de la colonne où se trouve l'erreur.</entry> + </row> + + <row> + <entry>5</entry> + <entry>Une lettre donnant le type de message d'erreur. + <literal>I</literal> pour un message d'information, + <literal>W</literal> pour un message d'avertissement, + <literal>E</literal> pour un message d'erreur et + <literal>X</literal> pour les références croisées. (Ce + n'est cependant pas toujours la cinquième colonne. + <command>nsgmls -sv</command> affiche + <literal>nsgmls:I: SP version + "1.3"</literal> - selon la version installée. + Comme vous pouvez le constater, c'est un message + d'information.) Vous voyez donc que nous avons dans notre + exemple des messages d'erreurs.</entry> + </row> + + <row> + <entry>6</entry> + <entry>Le texte du message d'erreur.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + + <para><ulink + url="http://www.cs.duke.edu/~dsb/kgv-faq/errors.html">Vous + aurez plus d'informations sur les erreurs de + &man.nsgmls.1;</ulink> dans la <ulink + url="http://www.cs.duke.edu/~dsb/kgv-faq/">Unofficial 'Kindler, + Gentler HTML Validator' FAQ</ulink>.</para> + + <para>Ne pas mettre les marques <sgmltag>title</sgmltag> a généré + 2 erreurs différentes.</para> + + <para>La première erreur indique que l'analyseur SGML a rencontré un + contenu (ici, des caractères, au lieu d'une marque de début + d'élément) alors qu'il attendait autre chose. Dans le cas présent, + l'analyseur attendait une marque de début pour un élément valide + à l'intérieur de <sgmltag>head</sgmltag> + (<sgmltag>title</sgmltag> par exemple).</para> + + <para>La deuxième erreur est due au fait que les éléments + <sgmltag>head</sgmltag> doivent contenir un élément + <sgmltag>title</sgmltag>. &man.nsgmls.1; considère alors que + l'élément n'est pas complet. La marque de fin indique donc que + l'élément se termine alors qu'il n'est pas correctement + renseigné.</para> + </step> + + <step> + <para>Remettez l'élément <literal>title</literal> en place.</para> + </step> + </procedure> + </sect2> + </sect1> + + <sect1 id="sgml-primer-doctype-declaration"> + <title>La déclaration DOCTYPE</title> + + <para>Au début de chaque document que vous rédigez, vous devez préciser le + nom de la DTD à laquelle le document se conforme. Cela pour que les + analyseurs syntaxiques SGML la connaissent et puissent valider le + document.</para> + + <para>Cette information est habituellement donnée sur une seule ligne, + dans la déclaration DOCTYPE.</para> + + <para>Voici une déclaration typique pour un document conforme à la version + 4.0 de la DTD HTML :</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN">]]></programlisting> + + <para>Cette ligne a plusieurs composants distincts :</para> + + <variablelist> + <varlistentry> + <term><literal><!</literal></term> + + <listitem> + <para>C'est l'<emphasis>indicateur</emphasis> qui dit que c'est une + déclaration SGML. Cette ligne définit le type de document.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>DOCTYPE</literal></term> + + <listitem> + <para>Précise que c'est la déclaration SGML du type de + document.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>html</literal></term> + + <listitem> + <para>Définit le premier <link + linkend="sgml-primer-elements">élément</link> qui apparaîtra + dans le document.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>PUBLIC "-//W3C//DTD HTML 4.0//EN"</literal></term> + + <listitem> + <para>Donne le <foreignphrase>Formal Public Identifier + (FPI)</foreignphrase> - Identifiant Public + Officiel - de la DTD à laquelle le document se + conforme.</para> + + <para><literal>PUBLIC</literal> n'appartient pas au FPI, mais + indique au processeur SGML comment trouver la DTD référencée par + le FPI. Les autres façons de dire à l'analyseur SGML comment + trouver la DTD sont données <link + linkend="sgml-primer-fpi-alternatives">plus loin</link>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><literal>></literal></term> + + <listitem> + <para>Retour au document.</para> + </listitem> + </varlistentry> + </variablelist> + + <sect2> + <title><foreignphrase>Formal Public Identifiers + (FPIs)</foreignphrase> - Identifiants Publics + Officiels</title> + + <note> + <para>Vous n'avez pas besoin de connaître ce qui suit, mais ce n'est + n'est pas inutile, et cela peut vous aider à résoudre des problèmes, + si votre processeur SGML ne trouve pas la DTD que vous + utilisez.</para> + </note> + + <para>Les FPIs doivent respecter une syntaxe précise. La + voici :</para> + + <programlisting> +"<replaceable>Propriétaire</replaceable>//<replaceable>Mot-Clé</replaceable> <replaceable>Description</replaceable>//<replaceable>Langue</replaceable>"</programlisting> + + <variablelist> + <varlistentry> + <term><replaceable>Propriétaire</replaceable></term> + + <listitem> + <para>Indique qui détient le FPI.</para> + + <para>Si la chaîne de caractères commence par “ISO”, + c'est un FPI ISO. Par exemple, le FPI <literal>"ISO + 8879:1986//ENTITIES Greek Symbols//EN"</literal> donne + <literal>ISO 8879:1986</literal> comme propriétaire du jeu + d'entités pour les lettres grecques. ISO 8879:1986 est le + numéro ISO du standard SGML.</para> + + <para>Sinon, cette chaîne sera de la forme + <literal>-//<replaceable>Propriétaire</replaceable></literal> ou + <literal>+//<replaceable>Propriétaire</replaceable></literal> + (remarquez que la seule différence est le <literal>+</literal> + ou <literal>-</literal> du début).</para> + + <para>Si la chaîne commence par un <literal>-</literal>, c'est que + le propriétaire n'est pas enregistré, il l'est si elle commence + par un <literal>+</literal>.</para> + + <para>L'ISO 9070:1991 définit comment sont générés les noms + enregistrés ; ils peuvent dériver du numéro d'une + publication ISO, d'un code ISBN ou d'un code d'organisation + affecté selon l'ISO 6523. De plus, il pourrait y avoir une + autorité d'enregistrement pour l'affectation de ces noms. Le + conseil ISO a délégué cela à l'<foreignphrase>American National + Standards Institute (ANSI)</foreignphrase> - Institut + National Américain des Standards.</para> + + <para>Comme le Projet FreeBSD n'est pas enregistré, la chaîne + utilisée est <literal>-//FreeBSD</literal>. Comme vous pouvez + vous en rendre compte, le W3C n'est pas non plus un propriétaire + enregistré.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>Mot-Clé</replaceable></term> + + <listitem> + <para>Il y a plusieurs mots-clés qui définissent le type + d'information dans le fichier. Les mots-clés les plus courants + sont : <literal>DTD</literal>, <literal>ELEMENT</literal>, + <literal>ENTITIES</literal> et <literal>TEXT</literal>. + <literal>DTD</literal> ne sert que pour les DTD, + <literal>ELEMENT</literal> sert habituellement pour les extraits + de DTD qui ne contiennent que des entités ou des déclarations + d'éléments. <literal>TEXT</literal> sert pour le contenu SGML + (texte et marques).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>Description</replaceable></term> + + <listitem> + <para>La description que vous souhaitez donner du contenu du + fichier. Cela peut inclure des numéros de version et n'importe + quel texte court qui ait un sens et soit unique au système + SGML.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable>Langue</replaceable></term> + + <listitem> + <para>C'est une code ISO de deux caractères qui identifie la + langue utilisée dans le fichier. Pour l'anglais, c'est + <literal>EN</literal>.</para> + </listitem> + </varlistentry> + </variablelist> + + <sect3> + <title>Fichiers <filename>catalog</filename></title> + + <para>Si vous avez utilisé la syntaxe décrite plus haut et essayé + d'utiliser un processeur SGML pour traiter votre document, il aura + besoin de convertir le FPI en un nom de fichier sur votre ordinateur + qui décrive la DTD.</para> + + <para>Vous pouvez pour cela vous servir d'un fichier catalogue + (habituellement appelé <filename>catalog</filename>). Il contient + des lignes qui donnent les correspondances entre FPIs et noms de + fichiers. Par exemple, s'il y a la ligne :</para> + + <programlisting> +PUBLIC "-//W3C//DTD HTML 4.0//EN" "4.0/strict.dtd"</programlisting> + + <para>le processeur SGML cherchera la DTD dans le fichier + <filename>strict.dtd</filename> du sous-répertoire + <filename>4.0</filename> où se trouve le fichier + <filename>catalog</filename> qui comporte cette ligne.</para> + + <para>Jettez un oeil au fichier + <filename>/usr/local/share/sgml/html/catalog</filename>. C'est le + fichier catalogue pour les DTDs HTML qui ont été installées par le + logiciel porté <filename>textproc/docproj</filename>.</para> + </sect3> + + <sect3> + <title><envar>SGML_CATALOG_FILES</envar></title> + + <para>Pour trouver un fichier <filename>catalog</filename>, votre + processeur SGML doit savoir où chercher. La plupart d'entre eux ont + des paramètres de leur ligne de commande pour donner le chemin + d'accès à un ou plusieurs catalogues.</para> + + <para>Vous pouvez par ailleurs définir + <envar>SGML_CATALOG_FILES</envar> pour désigner ces fichiers. Cette + variable d'environnement doit contenir une liste de fichiers + catalogues (donnés par leurs chemins d'accès complets) séparés par + des points-virgules.</para> + + <para>Habituellement, vous incluerez les fichiers + suivants :</para> + + <itemizedlist> + <listitem> + <para><filename>/usr/local/share/sgml/docbook/catalog</filename></para> + </listitem> + + <listitem> + <para><filename>/usr/local/share/sgml/html/catalog</filename></para> + </listitem> + + <listitem> + <para><filename>/usr/local/share/sgml/iso8879/catalog</filename></para> + </listitem> + + <listitem> + <para><filename>/usr/local/share/sgml/jade/catalog</filename></para> + </listitem> + </itemizedlist> + +<!-- + <para>Vous devriez <link linkend="sgml-primer-envars">déjà l'avoir + fait</link>.</para> +--> + </sect3> + </sect2> + + <sect2 id="sgml-primer-fpi-alternatives"> + <title>Alternatives aux FPIs</title> + + <para>Au lieu d'utiliser un FPI pour préciser la DTD utilisée (et donc + le fichier qui contient la DTD), il est possible de donner + explicitement le nom du fichier.</para> + + <para>La syntaxe pour le faire est légèrement différente :</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html SYSTEM "/path/to/file.dtd">]]></programlisting> + + <para>Le mot-clé <literal>SYSTEM</literal> indique que le processeur + SGML doit localiser le fichier d'une façon qui dépend du système. Cela + signifie habituellement (mais pas toujours) que la DTD sera définie + par un nom de fichier.</para> + + <para>Il est préférable d'utiliser des FPIs pour des raisons de + portabilité. Vous ne voulez pas livrer un exemplaire de la DTD avec + votre document, et si vous avez utilisé l'identifiant + <literal>SYSTEM</literal>, il faudra que chacun ait ses DTDs aux mêmes + endroits.</para> + </sect2> + </sect1> + + <sect1 id="sgml-primer-sgml-escape"> + <title>Revenir au SGML</title> + + <para>On a dit plus haut dans cette introduction que le SGML n'était + utilisé que pour écrire les DTDs. Ce n'est pas tout à fait vrai. Il y a + des éléments de la syntaxe SGML que vous voudrez pouvoir utiliser dans + vos documents. Par exemple, vous pouvez y inclure des commentaires, qui + seront ignorés par les analyseurs. Les commentaires sont inclus en + utilisant une syntaxe SGML. D'autres utilisations du SGML dans les + documents seront mentionnées plus loin.</para> + + <para>Il vous faut évidemment un moyen d'indiquer au processeur SGML que + ce qui va suivre n'est pas constitué d'éléments du document, mais est du + SGML que le processeur doit prendre en compte.</para> + + <para>Ces sections sont marqués avec <literal><! ... ></literal> + dans votre document. Tout ce qui se trouve entre ces délimiteurs est du + code SGML comme on en trouve dans les DTDs.</para> + + <para>Comme vous venez peut-être de vous en rendre compte, la <link + linkend="sgml-primer-doctype-declaration">déclaration DOCTYPE</link> + est un exemple de syntaxe SGML que vous devez inclure dans votre + document…</para> + </sect1> + + <sect1> + <title>Commentaires</title> + &sgml.todo; + + <para>Les commentaires suivent une syntaxe SGML et ne sont normalement + autorisés que dans une DTD. Cependant comme la + <xref linkend="sgml-primer-sgml-escape"> le montre, il est possible + d'inclure du SGML dans vos documents.</para> + + <para>Les délimiteurs pour les commentaires SGML sont constitués de la + chaîne de caractères “<literal>--</literal>”. Une première + occurence ouvre le commentaire, et la seconde le ferme.</para> + + <example> + <title>Commentaire SGML générique</title> + + <programlisting> +<!-- commentaire de test --></programlisting> + + <programlisting><![ CDATA [ +<!-- C'est le texte du commentaire --> + +<!-- C'est un autre commentaire --> + +<!-- Voici une façon de mettre un commentaire + sur plusieurs lignes --> + +<!-- Voici une autre façon -- + -- de le faire -->]]></programlisting> + </example> + + <![ %output.print; [ + <important> + <title>Utilisez 2 tirets</title> + + <para>Vous aurez un problème avec les versions PostScript et PDF de ce + document. Les exemples précédents n'auront probablement qu'un simple + tiret, <literal>-</literal> après <literal><!</literal> et avant + <literal>></literal>.</para> + + <para>Il <emphasis>faut</emphasis> utiliser deux <literal>-</literal>, + et <emphasis>non</emphasis> un seul. Les versions PostScript et PDF + ont converti les deux <literal>-</literal> de l'original en un seul + <emphasis>double tiret</emphasis> plus professionnel, et déformé + l'exemple au passage.</para> + + <para>Les versions HTML, texte et RTF de ce document ne sont pas + sujettes à ce problème.</para> + </important> + ]]> + + <para>Si vous avez déjà utilisé HTML auparavant, on vous a peut-être + donné des règles différentes pour les commentaires. En particulier, vous + pensez peut-être qu'ils commencent par <literal><!--</literal> et + ne se terminent qu'avec <literal>--></literal>.</para> + + <para>Ce n'est <emphasis>pas</emphasis> le cas. Les analyseurs syntaxiques + de nombreux navigateurs sont défectueux et acceptent cette syntaxe. Ceux + qu'utilisent le Projet de Documentation sont plus rigoureux et + rejetteront les documents qui comportent cette erreur.</para> + + <example> + <title>Commentaires SGML erronnés</title> + + <programlisting><![ CDATA [ +<!-- C'est en commentaire -- + + CE N'EST PAS EN COMMENTAIRE! + + -- retour au commentaire -->]]></programlisting> + + <para>L'analyseur SGML traitera cela comme s'il trouvait :</para> + + <programlisting> +<!CE N'EST PAS EN COMMENTAIRE></programlisting> + + <para>Ce qui n'est pas du SGML valide et donnera des messages d'erreur + source de confusion.</para> + + <programlisting> +<![ CDATA [<!--------------- C'est un très mauvaise idée --------------->]]></programlisting> + + <para>Comme l'exemple le suggère, ne mettez <emphasis>pas</emphasis> de + commentaires de ce type.</para> + + <programlisting> +<![ CDATA [<!--===================================================-->]]></programlisting> + + <para>C'est une (légèrement) meilleure idée, mais c'est toute de même + une source de confusion potentielle pour les débutants en SGML.</para> + </example> + + <sect2> + <title>A faire…</title> + + <procedure> + <step> + <para>Ajoutez des commentaires à <filename>exemple.sgml</filename> + et validez vos modifications avec &man.nsgmls.1;</para> + </step> + + <step> + <para>Ajoutez des commentaires incorrects à + <filename>exemple.sgml</filename>, pour voir quels messages + d'erreur produit alors &man.nsgmls.1;.</para> + </step> + </procedure> + </sect2> + </sect1> + + <sect1> + <title>Entités</title> + + <para>Les entités fournissent un mécanisme pour désigner des parties d'un + contenu. Lorsque l'analyseur SGML traite votre document, il remplace les + entités qu'il rencontre par le contenu de ces entités.</para> + + <para>C'est un bon moyen pour avoir du texte réutilisable et facile à + modifier. C'est aussi le seul moyen d'inclure, en utilisant SGML, un + fichier marqué dans un autre.</para> + + <para>Il y a deux sortes d'entités SGML qui s'utilisent dans des + situations différentes : les <emphasis>entités générales</emphasis> + et les <emphasis>entités paramètres</emphasis>.</para> + + <sect2 id="sgml-primer-general-entities"> + <title>Entités Générales</title> + + <para>Vous ne pouvez pas employer les entités générales dans un contexte + SGML (bien que ce soit là que vous les définissiez). Elles ne peuvent + être utilisées que dans votre document. Comparez cela au cas des + <link linkend="sgml-primer-parameter-entities">entités + paramètres</link>.</para> + + <para>Chaque entité générale a un nom. Quand vous voulez y faire + référence (et donc inclure le texte qu'elle contient dans votre + document), vous mettez + <literal>&<replaceable>nom-de-l'entité</replaceable>;</literal>. + Supposons par exemple que vous ayez une entité appelée + <literal>version.courante</literal> qui contienne le numéro de version + courante de votre produit. Vous pourriez écrire :</para> + + <programlisting> +<![ CDATA [<para>La version courante de notre produit est la + &version.courante;.</para>]]></programlisting> + + <para>Quand le numéro de version change, il vous suffit de modifier la + définition de l'entité générale et de recompiler votre + document.</para> + + <para>Vous pouvez aussi vous servir d'entités générales pour représenter + des caractères que vous ne pouvez pas inclure autrement dans un + document SGML. < et &, par exemple, ne doivent normalement pas + apparaître dans un document SGML. Quand l'analyseur SGML rencontre un + symbole <, il suppose qu'il précède une marque (de début ou de + fin), et quand il rencontre un symbole &, il suppose que le texte + qui le suit est le nom d'une entité.</para> + + <para>Heureusement, il y a deux entités générales, &lt; et + &amp; pour le cas où vous auriez besoin d'inclure l'un ou l'autre + de ces symboles.</para> + + <para>Une entité générale ne peut être définie que dans un contexte + SGML. On le fait habituellement immédiatement après la déclaration + DOCTYPE.</para> + + <example> + <title>Définition d'entités générales</title> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY version.courante "3.0-RELEASE"> +<!ENTITY derniere.version "2.2.7-RELEASE"> +]>]]></programlisting> + + <para>Remarquez que la déclaration DOCTYPE est suivie d'un crochet + ouvrant à la fin de la première ligne. Les deux entités sont + définies aux deux lignes suivantes, avant le crochet fermant. La + déclaration DOCTYPE se termine ensuite.</para> + + <para>Les crochets sont nécessaires pour dire que nous ajoutons un + complément à la DTD mentionnée par la déclaration DOCTYPE.</para> + </example> + </sect2> + + <sect2 id="sgml-primer-parameter-entities"> + <title>Entités paramètres</title> + + <para>Comme les <link linkend="sgml-primer-general-entities">entités + générales</link>, les entités paramètres servent à nommer des + parties réutilisables du texte. Cependant, alors que les entités + générales peuvent être utilisées dans le corps du document, les + entités paramètres ne peuvent être employées que dans un + <link linkend="sgml-primer-sgml-escape">contexte SGML</link>.</para> + + <para>Les entités paramètres sont définies de la même manière que les + entités générales. Sinon qu'au lieu de vous servir de + <literal>&<replaceable>inomd-de-l'entité</replaceable>;</literal> + pour y faire référence, vous utiliserez + <literal>%<replaceable>nom-de-l'entité</replaceable>;</literal><footnote> + <para>Les entités <emphasis>P</emphasis>aramètres employent le + symbole <emphasis>P</emphasis>ourcent.</para> + </footnote>. Leur définition comporte aussi un <literal>%</literal> + entre le mot-clé <literal>ENTITY</literal> et le nom de + l'entité.</para> + + <example> + <title>Définition d'entités paramètres</title> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY % param.du "du"> +<!ENTITY % param.texte "text"> +<!ENTITY % param.encore "encore %param.du more %param.texte"> + +<!-- %param.encore contient maintenant "encore du texte" --> +]>]]></programlisting> + </example> + + <para>Cela ne paraît peut être pas très utile. On verra pourtant que ça + l'est.</para> + </sect2> + + <sect2> + <title>A faire…</title> + + <procedure> + <step> + <para>Définissez un entité générale dans + <filename>exemple.sgml</filename>.</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" [ +<!ENTITY version "1.1"> +]> + +<html> + <head> + <title>Exemple de fichier HTML</title> + </head> + + <!-- Vous pourriez aussi mettre des commentaires ici --> + + <body> + <p>C'est un paragraphe avec du texte.</p> + + <p>C'est encore un paragraphe avec du texte.</p> + + <p align="right">Ce paragraphe sera peut-être justifié à + droite</p> + + <p>La version courante de ce document est : &version;</p> + </body> +</html>]]></programlisting> + </step> + + <step> + <para>Validez le document avec &man.nsgmls.1;</para> + </step> + + <step> + <para>Chargez <filename>exemple.sgml</filename> avec votre + navigateur (vous devrez peut-être le recopier dans + <filename>exemple.html</filename> pour que votre navigateur le + reconnaisse comme un document HTML).</para> + + <para>A moins que votre navigateur ne soit très évolué, il ne + remplacera pas la référence <literal>&version;</literal> + à l'entité par le numéro de version. Les analyseurs de la plupart + des navigateurs sont élémentaires et ne gèrent pas correctement + le SGML<footnote><para>C'est tout à fait dommage. Imaginez les + problèmes et bricolages (comme les <foreignphrase>Server Side + Includes</foreignphrase>) que cela + éviterait.</para></footnote>.</para> + </step> + + <step> + <para>La solution est de <emphasis>normaliser</emphasis> votre + document avec un outil de normalisation du SGML. Ce type d'outil + lit un document SGML valide et le transforme en un autre document + SGML tout aussi valide. En particulier, il y remplace les + références aux entités par leur contenu.</para> + + <para>Vous pouvez le faire avec &man.sgmlnorm.1;.</para> + + <screen>&prompt.user; <userinput>sgmlnorm exemple.sgml > exemple.html</userinput></screen> + + <para><filename>exemple.html</filename> doit maintenant contenir une + version normalisée (i.e., où les références aux entités ont été + remplacées par leur contenu) de votre document, prête à être + affichée par votre navigateur.</para> + </step> + + <step> + <para>Si vous jetez un oeil au résultat de &man.sgmlnorm.1;, vous + verrez qu'il ne comporte pas de déclaration DOCTYPE au début. Pour + qu'elle y soit, utilisez l'option + <option>-d</option> :</para> + + <screen>&prompt.user; <userinput>sgmlnorm -d exemple.sgml > exemple.html</userinput></screen> + </step> + </procedure> + </sect2> + </sect1> + + <sect1> + <title>Utiliser les entités pour inclure des fichiers</title> + + <para>Les entités (<link + linkend="sgml-primer-general-entities">générales</link> et <link + linkend="sgml-primer-parameter-entities">paramètres</link>) sont + particulièrement utiles pour inclure un fichier dans un autre.</para> + + <sect2 id="sgml-primer-include-using-gen-entities"> + <title>Utiliser les entités générales pour inclure des fichiers</title> + + <para>Supposons que le contenu d'un livre SGML soit découpé en fichiers, + à raison d'un fichier par chapitre, appelés + <filename>chaptitre1.sgml</filename>, + <filename>chapitre2.sgml</filename>, et ainsi de suite, et que le + fichier <filename>livre.sgml</filename> inclue ces chapitres.</para> + + <para>Pour que vos entités aient pour valeur le contenu de ces fichiers, + vous les déclarerez avec le mot-clé <literal>SYSTEM</literal>. Cela + indique à l'analyseur SGML qu'il doit utiliser le contenu du fichier + mentionné comme valeur de l'entité.</para> + + <example> + <title>Utiliser les entités générales pour inclure des + fichiers</title> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY chapitre.1 SYSTEM "chapitre1.sgml"> +<!ENTITY chapitre.2 SYSTEM "chapitre2.sgml"> +<!ENTITY chapitre.3 SYSTEM "chapitre3.sgml"> +<!-- Et ainsi de suite --> +]> + +<html> + <!-- Utilisation des entités pour inclure les chapitres --> + + &chapitre.1; + &chapitre.2; + &chapitre.3; +</html>]]></programlisting> + </example> + + <warning> + <para>Quand vous vous servez d'entités générales pour inclure d'autres + fichiers dans un document, les fichiers inclus + (<filename>chapitre1.sgml</filename>, + <filename>chapitre2.sgml</filename>, et ainsi de suite) ne doivent + <emphasis>pas</emphasis> commencer par une déclaration DOCTYPE. Ce + serait une erreur de syntaxe.</para> + </warning> + </sect2> + + <sect2> + <title>Utiliser les entités paramètres pour inclure des fichiers</title> + + <para>Rappelez-vous que les entités paramètres ne peuvent être utilisées + que dans un contexte SGML. Quand aurez-vous besoin d'inclure un + fichier dans un contexte SGML ?</para> + + <para>Vous pouvez vous en servir pour être sûr de pouvoir réutiliser vos + entités générales.</para> + + <para>Supposons que votre document comporte de nombreux chapitres, et + que vous réutilisiez ces chapitres dans deux livres différents, chacun + organisant ces chapitres de façon différente.</para> + + <para>Vous pourriez donner la liste des entités en tête de chaque livre, + mais cela pourrait rapidement devenit fastidieux à gérer.</para> + + <para>Mettez, au lieu de cela, les définitions des entités générales + dans un fichier, et utilisez une entité paramètre pour inclure ce + fichier dans votre document.</para> + + <example> + <title>Utiliser les entités paramètres pour inclure des + fichiers</title> + + <para>Mettez d'abord les définitions de vos entités dans un fichier + séparé, appelé <filename>chapitres.ent</filename>. Voici ce qu'il + contiendra :</para> + + <programlisting> +<![ CDATA [<!ENTITY chapitre.1 SYSTEM "chapitre1.sgml"> +<!ENTITY chapitre.2 SYSTEM "chapitre2.sgml"> +<!ENTITY chapitre.3 SYSTEM "chapitre3.sgml">]]></programlisting> + + <para>Créez maintenant une entité paramètre qui fasse référence au + contenu de ce fichier. Utilisez ensuite cette entité pour inclure + le fichier dans votre document, vous pourrez alors y utiliser les + entités générales. Ce que vous faites de la même façon que + précédemment :</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!-- + Définissez une entité paramètre pour inclure le fichier + des entités générales pour les chapitres +--> +<!ENTITY % chapitres SYSTEM "chapitres.ent"> + +<!-- Utilisez maintenant l'entité générale pour inclure ce fichier --> +%chapitres; +]> + +<html> + &chapitre.1; + &chapitre.2; + &chapitre.3; +</html>]]></programlisting> + </example> + </sect2> + + <sect2> + <title>A faire…</title> + + <sect3> + <title>Utiliser les entités générales pour inclure des fichiers</title> + + <procedure> + <step> + <para>Créez trois fichiers, <filename>para1.sgml</filename>, + <filename>para2.sgml</filename> et + <filename>para3.sgml</filename>.</para> + + <para>Mettez-y quelque chose qui ressemble à ceci :</para> + + <programlisting> +<![ CDATA [<p>C'est le premier paragraphe.</p>]]></programlisting> + </step> + + <step> + <para>Modifiez <filename>exemple.sgml</filename> de la façon + suivante :</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY version "1.1"> +<!ENTITY para1 SYSTEM "para1.sgml"> +<!ENTITY para2 SYSTEM "para2.sgml"> +<!ENTITY para3 SYSTEM "para3.sgml"> +]> + +<html> + <head> + <title>Exemple de fichier HTML</title> + </head> + + <body> + <p>La version courante de ce document est : &version;</p> + + ¶1; + ¶2; + ¶3; + </body> +</html>]]></programlisting> + </step> + + <step> + <para>Générez <filename>exemple.html</filename> en normalisant + <filename>exemple.sgml</filename>.</para> + + <screen>&prompt.user; <userinput>sgmlnorm -d exemple.sgml > exemple.html</userinput></screen> + </step> + + <step> + <para>Affichez <filename>exemple.html</filename> avec votre + navigateur Web et vérifiez que les fichiers + <filename>para<replaceable>n</replaceable>.sgml</filename> ont + bien été inclus dans <filename>exemple.html</filename>.</para> + </step> + </procedure> + </sect3> + + <sect3> + <title>Utiliser les entités paramètres pour inclure des + fichiers</title> + + <note> + <para>Vous devez d'abord avoir mis en pratique l'exemple + précédent.</para> + </note> + + <procedure> + <step> + <para>Modifiez comme ceci + <filename>exemple.sgml</filename> :</para> + + <programlisting> +<![ CDATA [<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY % entites SYSTEM "entites.sgml"> %entites; +]> + +<html> + <head> + <title>Exemple de fichier HTML</title> + </head> + + <body> + <p>La version courant de ce document est : &version;</p> + + ¶1; + ¶2; + ¶3; + </body> +</html>]]></programlisting> + </step> + + <step> + <para>Créez un nouveau fichier, <filename>entites.sgml</filename>, + qui contienne :</para> + + <programlisting> +<![ CDATA [<!ENTITY version "1.1"> +<!ENTITY para1 SYSTEM "para1.sgml"> +<!ENTITY para2 SYSTEM "para2.sgml"> +<!ENTITY para3 SYSTEM "para3.sgml">]]></programlisting> + </step> + + <step> + <para>Générez <filename>exemple.html</filename> en normalisant + <filename>exemple.sgml</filename>.</para> + + <screen>&prompt.user; <userinput>sgmlnorm -d exemple.sgml > exemple.html</userinput></screen> + </step> + + <step> + <para>Affichez <filename>exemple.html</filename> avec votre + navigateur Web et vérifiez que les fichiers + <filename>para<replaceable>n</replaceable>.sgml</filename> ont + bien été inclus dans <filename>example.html</filename>.</para> + </step> + </procedure> + </sect3> + </sect2> + </sect1> + + <sect1 id="sgml-primer-marked-sections"> + <title>Sections marquées</title> + + <para>SGML fournit un mécanisme pour définir quelles parties d'un document + doivent être traitées de façon particulière. On appelle cela des + “sections marquées”.</para> + + <example> + <title>Structure d'une section marquée</title> + + <programlisting> +<![ <replaceable>MOT-CLE</replaceable> [ + Contenu de la section marquée +]]></programlisting> + </example> + + <para>Comme vous pouviez vous y attendre, une section marquée est une + fonctionnalité SGML et commence donc par <literal><!</literal>.</para> + + <para>Le premier crochet ouvrant délimite la section marquée.</para> + + <para>Le <replaceable>MOT-CLE</replaceable> définit comment cette section + marquée doit être traitée par l'analyseur.</para> + + <para>Le second crochet ouvrant indique que le contenu de la section + marquée commence là.</para> + + <para>La section marquée se termine par deux crochets fermants, puis un + <literal>></literal> pour indiquer que l'on quitte le contexte SGML + et que l'on revient au document.</para> + + <sect2> + <title>Mots-clés pour les sections marquées</title> + + <sect3> + <title><literal>CDATA</literal>, <literal>RCDATA</literal></title> + + <para>Ces deux mots-clés définissent des sections marquées comme + <emphasis>modèle de contenu</emphasis> et vous permettent de + modifier sa valeur par défaut.</para> + + <para>Quand un analyseur SGML traite un docuemnt, il mémorise ce que + l'on appelle le “modèle de contenu”.</para> + + <para>En bref, le modèle de contenu décrit ce que l'analyseur doit + s'attendre à trouver comme contenu, et ce qu'il doit en faire quand + il le rencontre.</para> + + <para>Les deux modèles de contenu que vous trouverez certainement les + plus utiles sont <literal>CDATA</literal> et + <literal>RCDATA</literal>.</para> + + <para><literal>CDATA</literal> signifie + “<foreignphrase>Character + Data</foreignphrase>” - données caractères. Si + l'analyseur est à l'intérieur de ce modèle de contenu, il s'attend + à trouver des caractères, et uniquement des caractères. Les + symboles < et & perdent alors leur signification particulière + et sont traités comme de simples caractères.</para> + + <para><literal>RCDATA</literal> signifie “Références à des + entités et données caractères”. Si l'analyseur est à + l'intérieur de ce modèle de contenu, il s'attend à trouver des + caractères <emphasis>et</emphasis> des entités. < perd sa + signification particulière, mais & est toujours compris comme le + début d'une entité générale.</para> + + <para>C'est particulièrement utile si vous incluez du texte qui + contient de nombreux caractères < et &. Vous pourriez bien + sûr contrôler que dans votre texte tous les < sont écrits + &lt; et tous les & &amp;, il peut être plus facile + de marquer la section comme ne contenant que des + “CDATA”. Quand SGML rencontre l'instruction + correspondante, il ignorera les symboles < et & qui + apparaîtront dans le contenu.</para> + + <!-- The nesting of CDATA within the next example is disgusting --> + + <example> + <title>Utiliser une section marquée CDATA</title> + + <programlisting> +<para>Voici un exemple de la façon dont vous pourriez inclure + un texte comportant de nombreux &lt; et &amp;. L'exemple + lui-même est en HTML. Le texte qui l'encadre (<para> et + <programlisting>) est du DocBook.</para> + +<programlisting> + <![ CDATA [ <![ CDATA [ + <p>Cet exemple vous montre quelques éléments de HTML. Comme les + caractères < et > y sont si fréquemment utilisés, il est plus + facile de marquer tout l'exemple comme CDATA plutôt que de se + servir des entités à la place de ces caractères dans tout le + texte.</p> + + <ul> + <li>C'est un élément de liste</li> + <li>C'est un second élément de liste</li> + <li>C'est un troisième élément de liste</li> + </ul> + + <p>C'est la fin de l'exemple.</p>]]> + ]]> +</programlisting></programlisting> + + <para>Si vous consultez le source de ce document, vous verrez qu'il + utilise constamment cette technique.</para> + </example> + </sect3> + + <sect3> + <title><literal>INCLUDE</literal> et <literal>IGNORE</literal></title> + + <para>Si le mot-clé est <literal>INCLUDE</literal>, alors le contenu + de la section marquée sera pris en compte. Si le mot-clé est + <literal>IGNORE</literal>, alors la section marquée sera ignorée. Il + n'apparaîtra pas dans les sorties.</para> + + <example> + <title>Utiliser <literal>INCLUDE</literal> et + <literal>IGNORE</literal> dans les sections marquées</title> + + <programlisting> +<![ INCLUDE [ + Ce texte sera traité et inclus. +]]> + +<![ IGNORE [ + Ce texte ne sera pas traité ou inclus. +]]></programlisting> + </example> + + <para>En soi, cela ne sert pas à grand-chose. Si vous vouliez + supprimer du texte de votre document, vous auriez pu l'enlever ou le + mettre en commentaires.</para> + + <para>Cela devient plus utile quand vous comprenez que vous pouvez + vous servir des <link + linkend="sgml-primer-parameter-entities">entités paramètres</link> + pour contrôler ces sections. Rappelez-vous que les entités + paramètres ne peuvent être utilisées que dans un contexte SGML, et + une section marquée <emphasis>est</emphasis> un contexte SGML.</para> + + <para>Si par exemple, vous générez une version imprimée et une version + électronique de votre document, vous pourriez vouloir inclure dans + la version électronique un contenu supplémentaire qui ne devra pas + apparaître dans la version imprimée.</para> + + <para>Créez une entité paramètre et donnez lui comme contenu + <literal>INCLUDE</literal>. Rédigez votre document en utilisant des + sections marquées pour délimiter le contenu qui ne doit apparaître + que dans la version électronique. Dans ces sections marquées, + servez-vous de l'entité paramètre au lieu du mot-clé.</para> + + <para>Lorsque vous voulez générer la version électronique, changez la + valeur de l'entité paramètre en <literal>IGNORE</literal> et + retraitez le document.</para> + + <example> + <title>Utiliser une entité paramètre pour contrôler une section + marquée</title> + + <programlisting> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY % version.electronique "INCLUDE"> +]]> + +... + +<![ %version.electronique [ + Ce texte ne doit apparaître que dans + la version électronique du document. +]]></programlisting> + + <para>Pour générer la version imprimée, changez la définition de + l'entité en :</para> + + <programlisting> +<!ENTiTY % version.electronique "IGNORE"></programlisting> + + <para>A la seconde passe sur le document, les sections marquées qui + utilisent <literal>%version.electronique</literal> comme mot-clé + seront ignorées.</para> + </example> + </sect3> + </sect2> + + <sect2> + <title>A faire…</title> + + <procedure> + <step> + <para>Créez un nouveau fichier, <filename>section.sgml</filename>, + qui contienne :</para> + + <programlisting> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0//EN" [ +<!ENTITY % text.output "INCLUDE"> +]> + +<html> + <head> + <title>Exemple d'utilisation des sections marquées</title> + </head> + + <body> + <p>Ce paragraphe <![ CDATA [contient de nombreux + caractères < (< < < < <) il est donc + plus facile de l'inclure dans une section marquée + CDATA ]]></p> + + <![ IGNORE [ + <p>Ce paragraphe n'apparaîtra jamais dans les + sorties.</p> + ]]> + + <![ <![ CDATA [%sortie.texte]]> [ + <p>Ce paragraphe apparaîtra peut-être dans les + sorties.</p> + + <p>Cela dépend de l'entité paramètre + <![CDATA[%sortie.texte]]>.</p> + ]]> + </body> +</html></programlisting> + </step> + + <step> + <para>Normalisez le fichier avec &man.sgmlnorm.1; et examinez le + résultat. Notez quels paragraphes ont été conservés et quels + paragraphes ont été supprimés, et ce qu'est devenu le contenu des + sections marquées CDATA.</para> + </step> + + <step> + <para>Modifiez la définition de l'entité + <literal>sortie.texte</literal> de <literal>INCLUDE</literal> en + <literal>IGNORE</literal>. Normalisez de nouveau le fichier et + regardez ce qui a changé dans le résultat.</para> + </step> + </procedure> + </sect2> + </sect1> + + <sect1> + <title>Conclusion</title> + + <para>Ici se termine cette introduction à SGML. Pour des raisons de place + et de complexité, de nombreux points ont été survolés (voire omis). + Les sections qui précédent décrivent néanmoins suffisamment d'éléments + du SGML pour vous permettre de comprendre comment est organisée la + documentation du FDP.</para> + </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: +--> diff --git a/fr_FR.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml new file mode 100644 index 0000000000..3506d81960 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/stylesheets/chapter.sgml @@ -0,0 +1,72 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:47 gioria Exp $ +--> + +<chapter id="stylesheets"> + + <title>* Feuilles de style</title> + + <para>SGML ne décrit pas comment un document doit être affiché ou imprimé. + A cet effet, différents langages ont été conçus pour définir des feuilles + de style, dont DynaText, Panorama, SPICE, + JSSS, FOSI, CSS, et DSSSL.</para> + + <para>Pour DocBook, nous utilisons des feuilles de style écrites en DSSSL. + Pour le HTML, nous utilisons CSS.</para> + + <sect1> + <title>* DSSSL</title> + + <para>Le Projet de Documentation utilise une version un minimum + personnalisée des feuilles de style DocBook modulaires de Norm + Walsh.</para> + + <para>Vous les trouverez dans + <filename>textproc/dsssl-docbook-modular</filename>.</para> + </sect1> + + <sect1> + <title>* CSS</title> + + <para></para> + </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: +--> diff --git a/fr_FR.ISO8859-1/books/fdp-primer/the-faq/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/the-faq/chapter.sgml new file mode 100644 index 0000000000..1fe894630f --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/the-faq/chapter.sgml @@ -0,0 +1,49 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:49 gioria Exp $ +--> + +<chapter id="the-faq"> + <title>* La Foire Aux Questions</title> + + <para></para> +</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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/the-handbook/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/the-handbook/chapter.sgml new file mode 100644 index 0000000000..8af35251fe --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/the-handbook/chapter.sgml @@ -0,0 +1,282 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:54 gioria Exp $ +--> + +<chapter id="the-handbook"> + <title>* Le Manuel de Référence</title> + + <sect1> + <title>Organisation logique</title> + + <para>Le Manuel de Référence est rédigé en conformité avec la DTD DocBook + étendue de FreeBSD.</para> + + <para>Le Manuel de Référence est un <sgmltag>book</sgmltag> DocBook. Il + est ensuite divisé en <sgmltag>part</sgmltag>s, qui contiennent + elles-mêmes plusieurs <sgmltag>chapter</sgmltag>s. Les + <sgmltag>chapter</sgmltag>s sont eux-mêmes composés de sections + (<sgmltag>sect1</sgmltag>) et sous-sections + (<sgmltag>sect2</sgmltag>, <sgmltag>sect3</sgmltag>) et ainsi de + suite.</para> + </sect1> + + <sect1> + <title>Organisation physique</title> + + <para>Le Manuel de Référence (et ses traductions) sont dans le + sous-répertoire + <filename>doc/<replaceable>langue</replaceable>/handbook</filename> + des archives CVS principales. <replaceable>langue</replaceable> est le + code ISO pour la langue, <literal>en</literal>, pour l'Anglais, + <literal>ja</literal> pour le Japonais, et ainsi de suite.</para> + + <para>Il y a un certain nombre de fichiers et répertoires dans le + répertoire <filename>handbook</filename>.</para> + + <note> + <para>L'organisation du Manuel de Référence sera peut-être modifiée avec + le temps, et le présent document peut ne pas être en phase avec ces + changements. Si vous avez des questions sur la façon dont le Manuel de + Référence est organisé, contactez s'il vous plaît le Projet de + Documentation de FreeBSD, <email>doc@FreeBSD.ORG</email>.</para> + </note> + + <sect2> + <title><filename>Makefile</filename></title> + + <para>Le <filename>Makefile</filename> décrit les règles utilisées pour + convertir le Manuel de Référence à partir du source (DocBook) dans + plusieurs formats cibles (dont HTML, PostScript, et texte).</para> + + <para>Le <filename>Makefile</filename> est décrit plus en détail à la + <xref linkend="the-handbook-converting">.</para> + </sect2> + + <sect2> + <title><filename>handbook.sgml</filename></title> + + <para>C'est la racine du Manuel de Référence. Il contient la + <link linkend="sgml-primer-doctype-declaration">déclaration + DOCTYPE</link> du Manuel, ainsi que les éléments qui décrivent sa + structure.</para> + + <para><filename>handbook.sgml</filename> utilise des <link + linkend="sgml-primer-parameter-entities">entités paramètres</link> + pour charger les fichiers d'extensions <filename>.ent</filename>. Ces + fichiers (décrits plus loin) définissent à leur tour des + <link linkend="sgml-primer-general-entities">entités générales</link> + qui sont elles-mêmes employées dans le reste du Manuel.</para> + </sect2> + + <sect2> + <title><filename><replaceable>répertoire</replaceable>/chapter.sgml</filename></title> + + <para>Chaque chapitre du manuel est composé d'un fichier + <filename>chapter.sgml</filename> dans un sous-répertoire séparé pour + chaque chapitre. Chaque répertoire prend le nom de l'attribut + <literal>id</literal> de l'élément <sgmltag>chapter</sgmltag>.</para> + + <para>Si par exemple, un des chapitres contient :</para> + + <programlisting><![ CDATA [ +<chapter id="kernelconfiguration"> +... +</chapter>]]></programlisting> + + <para>il s'appelera alors <filename>chapter.sgml</filename> dans le + répertoire <filename>kernelconfiguration</filename>. Habituellement, + il y aura un seul fichier pour tout le chapitre.</para> + + <para>A la génération de la version HTML du Manuel, on obtiendra un + <filename>kernelconfiguration.html</filename>. C'est dû à la valeur + du <literal>id</literal>, et non au nom du répertoire.</para> + + <para>Dans les versions précédentes du Manuel, ces fichiers étaient dans + le même répertoire que <filename>handbook.sgml</filename>, avec le + même nom que l'attribut <literal>id</literal> de l'élément + <sgmltag>chapter</sgmltag> du fichier. Ils ont été déplacés dans des + répertoires séparés en prévision des évolutions à venir du Manuel. Il + sera en particulier bientôt possible d'inclure des images dans chaque + chapitre. Il est donc plus logique que celles-ci soient rangées dans + un répertoire où se trouve aussi le texte du chapitre plutôt que de + mettre le texte de chaque chapitre, et donc toutes les images dans un + même répertoire. Il y aurait fatalement des conflits de nom, alors + qu'il est plus facile de travailler avec plusieurs répertoires + contenant quelques fichiers qu'avec un seul répertoire dans lequel il + y a beaucoup de fichiers.</para> + + <para>Un bref coup d'oeil montre qu'il y a de nombreux répertoires avec + chacun un fichier <filename>chapter.sgml</filename> dont + <filename>basics/chapter.sgml</filename>, + <filename>introduction/chapter.sgml</filename> et + <filename>printing/chapter.sgml</filename>.</para> + + <important> + <para>Les noms des chapitres et/ou répertoires ne doivent pas faire + réference à leur place dans le Manuel. Cet ordre peut changer quand + le contenu du Manuel est réorganisé ; ce type de réorganisation + ne devrait (normalement) pas entraîner de modification des noms des + fichiers (à moins que des chapitres entiers ne changent de niveau + dans la hiérarchie).</para> + </important> + + <para>Chaque fichier <filename>chapter.sgml</filename> n'est pas un + document SGML intégral. Ils n'ont en particulier pas de déclaration + DOCTYPE en tête du fichier.</para> + + <para>C'est dommage pour deux raisons :</para> + + <itemizedlist> + <listitem> + <para>Il n'est pas possible de les traiter comme des fichiers SGML + et de les convertir en HTML, RTF, PS et autres formats de la même + manière que le Manuel. Cela vous <emphasis>oblige</emphasis> à + recompiler tout le Manuel chaque fois que vous voulez vérifier les + effets d'une modification d'un seul chapitre.</para> + </listitem> + + <listitem> + <para>Le <literal>sgml-mode</literal> d'Emacs ne peut pas s'en + servir pour déterminer quelle DTD utiliser, ce qui fait perdre les + bénéfices de fonctionnalités utiles du + <literal>sgml-mode</literal> (complétion des éléments, validation + automatique, et ainsi de suite).</para> + </listitem> + </itemizedlist> + </sect2> + </sect1> + + <sect1> + <title>Guide de style</title> + + <para>Respectez s'il vous plaît les conventions de style ci-dessous pour + garder aux sources du Manuel une consistance malgré les nombreuses + personnes qui interviennent dessus.</para> + + <sect2> + <title>Majuscules et minuscules</title> + + <para>Les marques doivent être en minuscules + <literal><para></literal> et <emphasis>non</emphasis> + <literal><PARA></literal>.</para> + + <para>Le texte dans les contextes SGML est normalement en majuscules, + <literal><!ENTITY…></literal> ou + <literal><!DOCTYPE…></literal> et + <emphasis>non</emphasis> <literal><!entity…></literal> + ou <literal><!doctype…></literal>.</para> + </sect2> + + <sect2> + <title>Indentation</title> + + <para>Chaque fichier est indenté à partir de la colonne 0, + <emphasis>quel que soit</emphasis> le niveau d'indentation dans le + fichier où il est inclus.</para> + + <para>Chaque marque de début augmente l'indentation de 2 blancs et + chaque marque de fin la décrémente d'autant. Le contenu des éléments + doit être indenté de 2 blancs s'il court sur plusieurs lignes.</para> + + <para>A titre d'exemple, voici à quoi ressemble le source de cette + section :</para> + + <programlisting> +<![ CDATA [+--- C'est la colonne 0 + +<chapter> + <title>...</title> + + <sect1> + <title>...</title> + + <sect2> + <title>Indentation</title> + + <para>Chaque fichier est indenté à partir de la colonne 0, + <emphasis>quel que soit</emphasis> le niveau d'indentation dans le + fichier où il est inclus.</para> + + <para>Chaque marque de début augmente l'indentation de 2 blancs et + chaque marque de fin la décrémente d'autant. Le contenu des éléments + doit être indenté de 2 blancs s'il court sur plusieurs lignes.</para> + + ... + </sect2> + </sect1> +</chapter>]]></programlisting> + + <para>Si vous vous servez d'<application>Emacs</application> ou + <application>Xemacs</application> pour éditer les fichiers, le + <literal>sgml-mode</literal> doit être chargé automatiquement, et les + variables Emacs locales en fin de chaque fichier doivent mettre ces + indentations en pratique.</para> + </sect2> + + <sect2> + <title>Modifications de présentation des sources</title> + + <para>Quand vous intégrez des modifications, <emphasis>ne faites pas en + même temps de modification de contenu et de présentation des + sources</emphasis>.</para> + + <para>Cela pour que les équipes de traductions du Manuel puissent + rapidement voir les modifications de contenu que vous avez intégrées, + sans avoir à se demander si une ligne a changé de contenu ou + simplement de présentation.</para> + + <para>Si vous avez par exemple ajouté deux phrases à un paragraphe, de + sorte que les lignes du paragraphe débordent maintenant des 80 + colonnes, intégrez d'abord la modification avec les lignes trop + longues. Puis corrigez ensuite ce problème, en précisant qu'il ne + s'agit que d'une modification de présentation, dont les équipes de + traduction n'ont pas à se soucier.</para> + </sect2> + </sect1> + + <sect1 id="the-handbook-converting"> + <title>* Conversion du Manuel dans d'autres formats</title> + + <para></para> + </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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/the-website/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/the-website/chapter.sgml new file mode 100644 index 0000000000..90517e2677 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/the-website/chapter.sgml @@ -0,0 +1,49 @@ +<!-- 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:46:59 gioria Exp $ +--> + +<chapter id="the-website"> + <title>* Le site Web</title> + + <para></para> +</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: +--> + diff --git a/fr_FR.ISO8859-1/books/fdp-primer/tools/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/tools/chapter.sgml new file mode 100644 index 0000000000..378957ec2b --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/tools/chapter.sgml @@ -0,0 +1,301 @@ +<!-- 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 + + $Id: chapter.sgml,v 1.1 2000-06-12 15:47:01 gioria Exp $ + 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: +--> diff --git a/fr_FR.ISO8859-1/books/fdp-primer/translations/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/translations/chapter.sgml new file mode 100644 index 0000000000..ed8537589c --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/translations/chapter.sgml @@ -0,0 +1,497 @@ +<!-- Copyright (c) 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:47:06 gioria Exp $ +--> + +<chapter id="translations"> + <title>Traductions</title> + + <para>Ceci est la Foire aux Questions pour les gens qui traduisent la + documentation de FreeBSD (FAQ, Manuel de Référence, guides, pages de + manuel et autres) en différentes langues.</para> + + <para>Elle est <emphasis>très</emphasis> largement basée sur la FAQ du + Projet Allemand de Documentation de FreeBSD, rédigée à l'origine par + Frank Grnder <email>elwood@mc5sys.in-berlin.de</email> et traduite en + Anglais par Bernd Warken <email>bwarken@mayn.de</email>.</para> + + <para>Nik Clayton <email>nik@FreeBSD.org</email> maintient cette FAQ.</para> + + <qandaset> + <qandaentry> + <question> + <para>Pourquoi une FAQ ?</para> + </question> + + <answer> + <para>De plus en plus de gens s'adressent à la &a.doc; et se proposent + de traduire en d'autres langues la documentation de FreeBSD. Le but + de cette FAQ est de répondre à leurs questions de façon à ce qu'ils + puissent commencer le plus rapidement possible à traduire la + documentation.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Que signfient <phrase>i18n</phrase> et + <phrase>l10n</phrase> ?</para> + </question> + + <answer> + <para><phrase>i18n</phrase> veut dire + <phrase>internationalisation</phrase> et <phrase>l10n</phrase> + <phrase>localisation</phrase>. Ce ne sont que des abréviations + commodes.</para> + + <para><phrase>i18n</phrase> se lit “i” suivi de 18 + lettres, suivies d'un “n”. De la même façon, + <phrase>l10n</phrase> se lit “l” suivi de 10 lettres, + suivies d'un “n”.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Y-a-t-il une liste de diffusion pour les + traducteurs ?</para> + </question> + + <answer> + <para>Oui, <email>freebsd-translate@ngo.org.uk</email>. Inscrivez-vous + en envoyant un message à + <email>freebsd-translate-request@ngo.org.uk</email> avec le mot + <literal>subscribe</literal> dans le texte du message.</para> + + <para>Vous recevrez une réponse vous demandant de confirmer votre + inscription (de la même façon que pour les listes de FreeBSD sur + <hostid role="domainname">FreeBSD.org</hostid>).</para> + + <para>La langue de base sur la liste est l'Anglais, mais les messages + en d'autres langues sont acceptés. La liste n'est pas modérée, mais + vous devez vous y être inscrit avant d'y adresser des + messages.</para> + + <para>La liste est archivée, mais il n'est pas actuellement possible + d'y faire des recherches. Vous aurez en retour des explications sur + la façon d'accéder aux archives en envoyant le message + <literal>help</literal> à + <email>majordomo@ngo.org.uk</email>.</para> + + <para>Il est prévue que la liste de diffusion soit transférée sur + <hostid role="domainname">FreeBSD.org</hostid> et devienne donc + <emphasis>officielle</emphasis> dans un avenir proche.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>A-t-on besoin de nouveaux traducteurs ?</para> + </question> + + <answer> + <para>Oui. Plus il y a de gens qui travaillent aux traductions, plus + vite elles sont réalisées, et synchronisées avec les modifications + de la version anglaise.</para> + + <para>Il n'est pas nécessaire que vous soyez traducteur professionnel + pour pouvoir contribuer.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Quelle langue faut-il que je connaisse ?</para> + </question> + + <answer> + <para>Dans l'idéal, il faudrait que vous ayez une bonne connaissance + de l'anglais écrit et bien sûr, il faut que vous pratiquiez + couramment la langue dans laquelle vous traduisez.</para> + + <para>L'anglais n'est pas strictement indispensable. Vous pourriez par + exemple effectuez une traduction en Hongrois, à partir de la + traduction espagnole de la FAQ.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Quels logiciels faut-il que je connaisse ?</para> + </question> + + <answer> + <para>Il est fortement recommandé que vous teniez à jour une copie + locale des archives CVS de FreeBSD (au moins de la documentation), + soit à l'aide de <application>CTM</application>, soit en utilisant + <application>CVSup</application>. Le chapitre “Se synchroniser + avec la version <literal>-current</literal> de FreeBSD” du + Manuel de Référence vous explique comment utiliser ces + logiciels.</para> + + <para>Il faudra que vous soyiez à l'aise avec + <application>CVS</application>. Cela vous permettra de suivre les + modifications apportées entre les différentes versions des + fichiers qui constituent la documentation.</para> + + <para>[A Faire -- écrire un mode d'emploi qui explique comment + utiliser <application>CVSup</application> pour ne récupérer que la + documentation, et voir ce qui a évolué entre deux versions + données]</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Comment savoir qui d'autre traduit la documentation dans la + même langue ?</para> + </question> + + <answer> + <para>La <ulink + url="http://www.freebsd.org/docproj/translations.html">page des + traductions du Projet de Documentation</ulink> liste les traductions + en cours déjà connues. S'il y a déjà d'autres personnes qui + travaillent à la traduction de documentation dans votre langue, s'il + vous plaît, ne faites pas le même travail qu'eux en double. Au lieu + de cela, prenez contact avec eux, pour savoir comment vous pouvez + les aider.</para> + + <para>S'il la page n'indique personne qui travaille dans votre langue, + envoyez un message à la &a.doc; au cas où quelqu'un aurait déjà + envisagé de commencer une traduction, mais que ne ce soit pas encore + signalé.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Il n'y a personne d'autre qui traduise dans ma langue. Que + faire ?</para> + </question> + + <answer> + <para>Félicitations, vous venez juste de lancer le “Projet de + Documentation <replaceable>dans-votre-langue</replaceable> de + FreeBSD. Bien venu à bord.</para> + + <para>Commencez par vous assurer que vous avez bien du temps + disponible. Comme vous êtes pour le moment le seul volontaire pour + la traduction dans votre langue, il sera de votre responsabilité + de publier votre travail et de coordonner celui d'autres personnes + qui voudraient y collaborer.</para> + + <para>Envoyez un courrier électronique à la &a.doc; pour annoncer que + vous allez traduire la documentation de façon à ce que la pages des + traductions du Projet de Documentation puisse être tenue à + jour.</para> + + <para>Il faudra vous inscrire à la liste de diffusion + <email>freebsd-translate@ngo.org.uk</email> (comme expliqué plus + haut).</para> + + <para>S'il y a déjà dans votre pays quelqu'un qui maintienne un site + miroir de FreeBSD, vous devriez le contacter et voir s'il peut vous + fournir un hébergement pour votre projet et, si possible, une + adresse de courrier électronique et la possibilité de mettre en + place une liste de diffusion.</para> + + <para>Choisissez ensuite une documentation et commencez la traduction. + Il vaut mieux commencer par quelque chose de pas trop + volumineux—soit la FAQ, soit l'un des guides.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>J'ai traduit une documentation, à qui dois-je + l'envoyer ?</para> + </question> + + <answer> + <para>Cela dépend. Si vous travaillez déjà au sein d'une équipe de + traduction (comme l'équipe Japonaise ou l'équipe Allemande), elle + aura ses propres procédures pour gérer la documentation soumise, qui + seront décrites dans ses pages Web.</para> + + <para>Si vous êtes la seule personne à travailler dans une langue + donnée (ou si vous êtes responsable d'un projet de traduction et + voulez soumettre votre travail au Projet FreeBSD), vous devez alors + l'envoyer au Projet FreeBSD (voir la question suivante).</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Je suis la seule personne à traduire dans cette langue, comment + soumettre mes traductions ?</para> + + <para>ou</para> + + <para>Nous sommes une équipe de traduction et voulons soumettre les + traductions de nos membres ?</para> + </question> + + <answer> + <para>Commencez par vérifier que vos traductions sont correctement + structurées. C'est-à-dire qu'elles doivent s'intégrer à + l'arborescence des documentations existantes et compiler sans + problèmes.</para> + + <para>La documentation de FreeBSD est actuellement archivée dans les + répertoires en dessous de <filename>doc/</filename>. Les + sous-répertoires de celui-ci prennent le nom codifiant la langue + dans laquelle les documentations sont écrites, selon la norme + ISO639 (<filename>/usr/share/misc/iso639</filename>, pour les + versions de FreeBSD postérieures au 20 Janvier 1999).</para> + + <para>S'il ya a différentes codifications pour votre langue + (le Chinois,par exemple), il y aura au niveau en-dessous plusieurs + sous-répertoires, un pour chacun des formats de codage que vous + aurez fournis.</para> + + <para>Vous aurez enfin des sous-répertoires pour chaque + document.</para> + + <para>Une éventuelle traduction en Suédois ressemblerait par exemple + à ce qui suit :</para> + + <programlisting> doc/ + sv/ + Makefile + FAQ/ + Makefile + *.sgml</programlisting> + + <para><literal>sv</literal> est le code ISO639 pour le Suédois. + Remarquez les deux <filename>Makefile</filename>s, qui servent à + compiler la documentation. Il n'y a qu'une seule façon de coder le + Suédois, il n'y a donc pas de niveau intermédiaire entre + les répertoires <filename>sv</filename> et + <filename>FAQ</filename><footnote><para>Cette organisation va + radicalement changer très bientôt. Suivez ce qui ce dit sur la + &a.doc; pour plus d'information.</para></footnote>.</para> + + <para>Utilisez &man.tar.1; et &man.gzip.1; pour compresser votre + documentation, et envoyez-la au projet.</para> + + <screen>&prompt.user; <userinput>cd doc</userinput> +&prompt.user; <userinput>tar cf swedish-docs.tar sv</userinput> +&prompt.user; <userinput>gzip -9 swedish-docs.tar</userinput></screen> + + <para>Mettez <filename>swedish-docs.tar.gz</filename> quelque part. Si + vous ne disposez pas d'espace sur le Web (votre fournisseur d'accès + n'en met peut-être pas à votre disposition), vous pouvez envoyer un + courrier électronique à &a.nik;, pour vous mettre d'accord sur une + date pour les lui envoyer par courrier.</para> + + <para>De quelque façon que vous procédiez, il faudra que vous utilisez + &man.send-pr.1; pour envoyer un rapport signalant que vous avez + soumis de la documentation. Il serait très utile que d'autres + puissent relire votre traduction d'abord, parce qu'il y a peu de + chances que la personne qui l'intégrera connaisse bien votre + langue.</para> + + <para>Quelqu'un (probablement le Responsbale du Projet de + Documentation, &a.nik; actuellement), récupérera votre traduction et + s'assurera qu'elle compile. En particulier, les points suivants + seront examinés :</para> + + <orderedlist> + <listitem> + <para>Tous vos fichiers utilisent-ils de chaînes RCS (comme + “ID”).</para> + </listitem> + + <listitem> + <para><command>make all</command> fonctionne-t-il correctement + dans le répertoire <filename>sv</filename>.</para> + </listitem> + + <listitem> + <para><command>make install</command> fonctionne-t-il + correctement.</para> + </listitem> + </orderedlist> + + <para>S'il y a des problèmes, la personne qui examine votre soumission + vous en fera part pour que vous essayiez de les régler.</para> + + <para>S'il n'y a pas de problèmes, votre traduction sera intégrée + aussi vite que possible.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Puis-je inclure dans mon texte des considérations propres à la + langue ou au pays ?</para> + </question> + + <answer> + <para>Nous préférerions que vous ne le fassiez pas.</para> + + <para>Supposons par exemple que vous traduisiez le Manuel de Référence + en Coréen et que vous vouliez inclure une section sur les revendeurs + en Corée dans votre Manuel.</para> + + <para>Il n'y a pas vraiment de raison pour que cette information + ne soit pas aussi présente dans la version anglaise (ou allemande, + espagnole, …). Il se peut qu'un anglophone ait besoin d'un + exemplaire de FreeBSD alors qu'il se trouve en Corée. Cela permet + aussi de mettre en avant la pénétration de FreeBSD dans le monde + entier, ce qui n'est pas une mauvaise chose.</para> + + <para>Si vous avez des informations propres à un pays donné, + soumettez-les d'abord sous forme de modifications à la version + anglaise du Manuel de Référence (avec &man.send-pr.1;) et + traduisez-les ensuite dans votre langue dans le Manuel de + Référence dans cette langue.</para> + + <para>Merci.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Comment faut-il coder les caractères propres à une + langue ?</para> + + <para>Dans les documentations, les caractères Non-ASCII doivent + apparaître sous forme d'entités SGML.</para> + + <para>Brièvement, celles-ci sont constituées d'une perluette (&), + du nom de l'entité, et d'un point-virgule (;).</para> + + <para>Les noms des entités sont définis par la norme ISO8879, que vous + trouverez dans le catalogue des logiciels portés, sous + <filename>textproc/iso8879</filename>.</para> + + <para>Voici quelques examples :</para> + + <segmentedlist> + <seglistitem> + <seg>&eacute;</seg> + <seg>é</seg> + <seg>“e” accent aigu minuscule</seg> + </seglistitem> + + <seglistitem> + <seg>&Eacute;</seg> + <seg>É</seg> + <seg>“e” accent aigu majuscule</seg> + </seglistitem> + + <seglistitem> + <seg>&uuml;</seg> + <seg>ü</seg> + <seg>“u” tréma minuscule</seg> + </seglistitem> + </segmentedlist> + + <para>Après installation du logiciel porté “iso8879”, le + fichier <filename>/usr/local/share/sgml/iso8879</filename> en donne + la liste complète.</para> + </question> + </qandaentry> + + <qandaentry> + <question> + <para>Comment doit-on s'adresser au lecteur ?</para> + </question> + + <answer> + <para>Dans les documents anglais, le + “<foreignphrase>you</foreignphrase>” est employé, il n'y + a qu'une seule forme, à l'inverse d'autres langues.</para> + + <para>Si vous traduisez dans une langue qui dispose de plusieurs + formes, utilisez celle que l'on emploie habituellement dans les + documentations techniques. En cas de doute, servez-vous d'une forme + de politesse courante.</para> + </answer> + </qandaentry> + + <qandaentry> + <question> + <para>Y'a-t-il des informations supplémentaires à inclure dans les + traductions ?</para> + </question> + + <answer> + <para>Oui.</para> + + <para>Les en-têtes de la version anglaise du document ressembleront à + ceci :</para> + + <programlisting><![ CDATA [<!-- + The FreeBSD Documentation Project + + $Id: chapter.sgml,v 1.11 1999/06/20 21:18:57 billf Exp $ +-->]]></programlisting> + + <para>La forme exacte peut changer, mais elles comporteront toujours + la ligne “Id” et la phrase <literal>The FreeBSD + Documentation Project</literal>.</para> + + <para>Vos traductions doivent comporter leur propre ligne + “Id” et <literal>FreeBSD Documentation Project</literal> + doit être remplacé par <literal>The FreeBSD + <replaceable>Langue</replaceable> Documentation + Project</literal>.</para> + + <para>Vous devrez aussi ajouter une troisième ligne qui donne la + version anglaise d'origine sur laquelle est basée la + traduction.</para> + + <para>Donc, la version espagnole du présent fichier commencerait + par :</para> + + <programlisting><![ CDATA [<!-- + The FreeBSD Spanish Documentation Project + + $Id: chapter.sgml,v 1.3 1999/06/24 19:12:32 jesusr Exp $ + Original revision: 1.11 +-->]]></programlisting> + </answer> + </qandaentry> + </qandaset> +</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: +--> diff --git a/fr_FR.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml b/fr_FR.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml new file mode 100644 index 0000000000..1deacf9502 --- /dev/null +++ b/fr_FR.ISO8859-1/books/fdp-primer/writing-style/chapter.sgml @@ -0,0 +1,149 @@ +<!-- Copyright (c) 1998 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. + + $Id: chapter.sgml,v 1.1 2000-06-12 15:47:08 gioria Exp $ +--> + +<chapter id="writing-style"> + <title> Style</title> + + <para>Pour conserver une certaine cohérence entre le travail des nombreux + rédacteurs de la documentation de FreeBSD, on a défini quelques règles à + suivre.</para> + + <variablelist> + <varlistentry> + <term>N'utilisez pas de formes contractées</term> + + <listitem> + <para>N'utilisez pas de formes contractées. Utilisez toujours les mots + entiers. “<foreignphrase>Don't use + contractions</foreignphrase>” n'est pas + correct<footnote><para>N.d.T.: Ceci s'applique bien sûr aux textes + rédigés en anglais.</para></footnote>.</para> + + <para>Ne pas contracter donne au texte un ton plus formel, est plus + précis, et facilite la tâche des traducteurs.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term>Utilisez la virgule dans les énumérations</term> + + <listitem> + <para>Dans une énumération au sein d'un paragraphe, séparez avec des + virgules les éléments les uns des autres. Mettez aussi un virgule et + la conjonction “et” avant le dernier élément.</para> + + <para>Examinez par exemple la phrase suivante :</para> + + <blockquote> + <para>C'est une liste d'un, deux et trois éléments.</para> + </blockquote> + + <para>Est-ce une liste de trois éléments, “un”, + “deux”, et “trois”, ou une liste de deux + éléments, “un” et “deux et + trois” ?</para> + + <para>Il vaut mieux être explicite et ajouter la dernière + virgule :</para> + + <blockquote> + <para>C'est une liste d'un, deux, et trois éléments.</para> + </blockquote> + </listitem> + </varlistentry> + + <varlistentry> + <term>Evitez les redondances</term> + + <listitem> + <para>Evitez les redondances. En particulier, “la + commande”, “le fichier”, et “man + commande” sont probablement redondants.</para> + + <para>Voici deux exemples pour ce qui concerne les commandes. Il est + préférable d'utiliser le second.</para> + + <informalexample> + <para>Utilisez la commande <command>cvsup</command> pour mettre à + jour vos sources.</para> + </informalexample> + + <informalexample> + <para>Utilisez <command>cvsup</command> pour mettre à jour vos + sources.</para> + </informalexample> + + <para>Voici deux exemples pour ce qui concerne les noms de fichiers. + Il est préférable d'utiliser le second.</para> + + <informalexample> + <para>… dans le fichier + <filename>/etc/rc.local</filename>…</para> + </informalexample> + + <informalexample> + <para>… dans + <filename>/etc/rc.local</filename>…</para> + </informalexample> + + <para>Voici enfin deux exemples pour les références aux pages de + manuel. Il est préférable d'utiliser le second (il emploie + <sgmltag>citerefentry</sgmltag>).</para> + + <informalexample> + <para>Voyez <command>man csh</command> pour plus + d'information.</para> + </informalexample> + + <informalexample> + <para>Voyez &man.csh.1;</para> + </informalexample> + </listitem> + </varlistentry> + </variablelist> + + <para>Pour des détails sur le style, consultez les <ulink + url="http://www.columbia.edu/acis/bartleby/strunk/"><foreignphrase>Eléments + de Style</foreignphrase></ulink>, de William Strunk.</para> +</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: +--> + |