diff --git a/fr/docproj/sgml.sgml b/fr/docproj/sgml.sgml index 44e282cb7a..7fada29046 100644 --- a/fr/docproj/sgml.sgml +++ b/fr/docproj/sgml.sgml @@ -1,176 +1,169 @@ - + %navincludes; %includes; ]> &header;

Le Projet de Documentation FreeBSD utilise SGML comme format standard pour créer des documents.

-

SGML est le Standard Generalised Markup +

SGML est le Standard Generalized Markup Language (Langage de Balisage Standard Généralisé).

En un mot, avec toutes nos excuses pour oser choquer ainsi les puristes dans l'assistance, SGML est un langage conçu pour en écrire d'autres.

Vous avez probablement déjà utilisé sans le savoir du SGML. HTML, le langage qui sert à la rédaction des pages web, est défini formellement. Sa définition est justement rédigée en SGML. Lorsque vous écrivez du HTML, vous n'écrivez pas du SGML tel quel, mais vous utilisez un langage qui est défini à partir de SGML.

Il existe de très, très nombreux langages de balisage définis à partir de - SGML. HTML en est un. "LinuxDoc" en est un autre. Comme vous vous en doutez, - il fut conçu à l'origine par le groupe de documentation Linux pour écrire - leurs textes, et le Projet de Documentation FreeBSD l'a également adopté.

- -

Un autre langage de balisage défini à partir de SGML est "DocBook". C'est un + SGML. HTML en est un. "DocBook" en est un autre. C'est un langage spécifiquement conçu pour la mise en forme de documentation technique - et, en tant que tel, dispose de nombreux tags (les choses entre <...>) - pour décrire les particularités des documents techniques.

+ et, en tant que tel, dispose de nombreux tags (les balises de la forme <tag contenu>) + pour décrire les particularités des documents techniques avant un formatage. + Le Projet de Documentation FreeBSD l'a adopté et l'a enrichi de nouveaux éléments + pour le rendre plus précis.

Voici un exemple de ce à quoi peut ressembler un bref paragraphe écrit en HTML (ne vous souciez pas du contenu, mais seulement des tags) :

Les mots de passe du système sont stockés dans /etc/passwd.
        Pour modifier ce fichier, vous devez utiliser vipw.
        Toutefois, si vous souhaitez simplement ajouter un nouvel utilisateur
        vous pouvez utiliser adduser.

 ]]>

Le même extrait, écrit en DocBook, ressemblerait à ceci :

Les mots de passe du système sont stockés dans
       /etc/passwd. Pour modifier ce fichier, vous devez utiliser
       vipw. Toutefois, si vous souhaitez simplement ajouter un nouvel utilisateur
        vous pouvez utiliser adduser.
     
 ]]>

Comme vous le voyez, DocBook est beaucoup plus "significatif" que HTML. Dans l'exemple HTML, le nom du fichier est marqué comme devant être affiché en une police "machine à écrire". En DocBook, le nom du fichier est justement désigné par la balise "filename", son apparence finale n'étant pas décrite.

Il y a de nombreux avantages à cette forme plus significative de balisage :

-

C'est un peu comme les feuilles de style de Microsoft® Word, que vous - êtes peut-être habitué à utiliser. C'est simplement beaucoup plus puissant.

+

C'est un peu comme les feuilles de style de Microsoft® Word, + simplement beaucoup plus puissant.

Bien sûr, cette performance a un prix :

-

Actuellement, le Projet utilise toujours LinuxDoc pour le Manuel et la FAQ. - Ceci est en train de changer, et il y a notamment un projet en cours pour - convertir la documentation en DocBook.

- -

Et si je ne connais ni LinuxDoc, ni DocBook ? Puis-je quand même +

Et si je ne connais pas DocBook ? Puis-je quand même participer ?

Bien sûr ! N'importe quelle documentation vaut mieux que rien du tout. Si vous avez à fournir quelque chose, même non formaté en - LinuxDoc ou en DocBook, ne vous faites pas de souci.

+ DocBook, ne vous faites pas de souci.

Soumettez la documentation comme d'habitude. Quelqu'un d'autre du Projet marquera votre documentation pour vous et la soumettra à son tour. Avec un peu de chance, ils vous renverront le texte formaté. C'est commode, puisque vous pouvez ainsi avoir un aperçu - "avant" et "après" du texte formaté, et peut-être en apprendrez-vous encore un peu + "avant et après" du texte formaté, et peut-être en apprendrez-vous encore un peu plus sur l'étape de marquage.

De toute évidence, ceci ralentit le processus de participation au Projet, - puisque votre documentation doit être marquée, ce qui peut prendre un soir - ou deux. Mais elle rejoindra les autres.

+ puisque votre documentation doit être marquée. Ceci peut prendre quelques heures + réparties sur quelques jours. Mais elle rejoindra les autres.

Plus d'informations sur SGML et DocBook ?

-

Vous devriez tout d'abord lire le Commencez par lire le Documentation Project Primer. Il se veut être une explication pédagogique de tout ce que - vous avez besoin de connaître pour travailler avec la Documentation FreeBSD.

- -

C'est un long document, divisé en de nombreux petits fichiers. Vous pouvez également + vous avez besoin de connaître pour travailler avec la Documentation FreeBSD. + C'est un long document, divisé en de nombreuses pages courtes. Vous pouvez également le trouver sous la forme d'un - seul gros fichier.

+ href="&enbase;/doc/&url.doc.langcode;/books/fdp-primer/book.html">une + seule longue page.

http://www.oasis-open.org/cover/sgml-xml.html

LA page web SGML/XML. Contient d'innombrables liens vers de l'information sur SGML.

http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html

L'"Introduction progressive à SGML". Recommandée pour toute personne désirant aborder SGML avec une approche de débutant.

http://www.oasis-open.org/docbook/

La DTD DocBook est suivie par OASIS. Ces pages sont destinées aux utilisateurs déjà à l'aise en SGML, et qui désirent apprendre DocBook.

Projet de Documentation FreeBSD : Accueil &footer;