MFen 1.23 --> 1.26
Submitted by: Antoine Brodin <antoine.brodin@laposte.net>
This commit is contained in:
Marc Fonvieille
parent
a6db1f2198
commit
d03280ad55
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/www/; revision=26172
1 changed files with 24 additions and 31 deletions
|
|
@ -1,7 +1,7 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" [
|
||||
<!ENTITY base CDATA "..">
|
||||
<!ENTITY enbase "../&base;">
|
||||
<!ENTITY date "$FreeBSD: www/fr/docproj/sgml.sgml,v 1.6 2004/10/06 14:12:50 stephane Exp $">
|
||||
<!ENTITY date "$FreeBSD: www/fr/docproj/sgml.sgml,v 1.8 2005/10/06 12:56:03 blackend Exp $">
|
||||
<!ENTITY title "Projet de documentation FreeBSD : SGML">
|
||||
<!ENTITY % navincludes SYSTEM "../includes.navdocs.sgml"> %navincludes;
|
||||
<!ENTITY % includes SYSTEM "../includes.sgml"> %includes;
|
||||
|
|
@ -9,7 +9,7 @@
|
|||
|
||||
<!--
|
||||
The FreeBSD French Documentation Project
|
||||
Original revision: 1.23
|
||||
Original revision: 1.26
|
||||
|
||||
Version francaise : Thomas Seyrat
|
||||
Version francaise (mise a jour) : Stephane Legrand <stephane@freebsd-fr.org>
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
<p>Le Projet de Documentation FreeBSD utilise SGML comme format
|
||||
standard pour créer des documents.</p>
|
||||
|
||||
<p>SGML est le <b>S</b>tandard <b>G</b>eneralised <b>M</b>arkup
|
||||
<p>SGML est le <b>S</b>tandard <b>G</b>eneralized <b>M</b>arkup
|
||||
<b>L</b>anguage (Langage de Balisage Standard Généralisé).</p>
|
||||
|
||||
<p>En un mot, avec toutes nos excuses pour oser choquer ainsi les puristes dans
|
||||
|
|
@ -36,14 +36,12 @@
|
|||
un langage qui est défini à partir de SGML.</p>
|
||||
|
||||
<p>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é.</p>
|
||||
|
||||
<p>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.</p>
|
||||
et, en tant que tel, dispose de nombreux tags (les balises de la forme <tt><tag contenu></tt>)
|
||||
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.</p>
|
||||
|
||||
<p>Voici un exemple de ce à quoi peut ressembler un bref paragraphe écrit en
|
||||
HTML (ne vous souciez pas du contenu, mais seulement des tags) :</p>
|
||||
|
|
@ -79,7 +77,7 @@
|
|||
au bon moment.</p>
|
||||
|
||||
<p>Le processus de conversion de DocBook en d'autres formats (HTML,
|
||||
Postscript®, etc.) s'assure que tous les <filename> ont bien
|
||||
Postscript®, etc.) s'assure que tous les éléments <filename> ont bien
|
||||
la même apparence.</p>
|
||||
</li>
|
||||
|
||||
|
|
@ -89,7 +87,7 @@
|
|||
|
||||
<li><p>Parce que la documentation ne doit pas être liée à un quelconque
|
||||
format de sortie, une seule et même source peut servir à produire
|
||||
de nombreux fichiers de types différents - texte pur, HTML, PostScript,
|
||||
de nombreux fichiers de types différents—texte pur, HTML, PostScript,
|
||||
RTF, PDF, etc.</p></li>
|
||||
|
||||
<li><p>La documentation est plus "intelligente", afin que plus de choses
|
||||
|
|
@ -98,8 +96,8 @@
|
|||
citées dans une documentation.</p></li>
|
||||
</ul>
|
||||
|
||||
<p>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.</p>
|
||||
<p>C'est un peu comme les feuilles de style de Microsoft® Word,
|
||||
simplement beaucoup plus puissant.</p>
|
||||
|
||||
<p>Bien sûr, cette performance a un prix :</p>
|
||||
|
||||
|
|
@ -108,46 +106,41 @@
|
|||
cela prend plus de temps pour les apprendre tous, et pour savoir les utiliser
|
||||
à bon escient.</p>
|
||||
|
||||
<p>Je me suis rendu compte que la meilleure manière d'apprendre est de lire la
|
||||
<p>Un bon moyen d'apprendre SGML et DocBook est de lire la
|
||||
source de nombreux textes, en étudiant la manière dont d'autres auteurs
|
||||
ont rédigé des documents similaires.</p></li>
|
||||
|
||||
<li><p>Le processus de reconversion n'est pas aisé.</p></li>
|
||||
<li><p>Le processus de conversion n'est pas aisé.</p></li>
|
||||
</ul>
|
||||
|
||||
<p>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.</p>
|
||||
|
||||
<h2>Et si je ne connais ni LinuxDoc, ni DocBook ? Puis-je quand même
|
||||
<h2>Et si je ne connais pas DocBook ? Puis-je quand même
|
||||
participer ?</h2>
|
||||
|
||||
<p>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.</p>
|
||||
DocBook, ne vous faites pas de souci.</p>
|
||||
|
||||
<p><a href="submitting.html">Soumettez</a> 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.</p>
|
||||
|
||||
<p>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.</p>
|
||||
puisque votre documentation doit être marquée. Ceci peut prendre quelques heures
|
||||
réparties sur quelques jours. Mais elle rejoindra les autres.</p>
|
||||
|
||||
<h2>Plus d'informations sur SGML et DocBook ?</h2>
|
||||
|
||||
<p>Vous devriez tout d'abord lire le <a
|
||||
<p>Commencez par lire le <a
|
||||
href="&enbase;/doc/&url.doc.langcode;/books/fdp-primer/index.html"><b>Documentation Project
|
||||
Primer</b></a>. Il se veut être une explication pédagogique de tout ce que
|
||||
vous avez besoin de connaître pour travailler avec la Documentation FreeBSD.</p>
|
||||
|
||||
<p>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'<a
|
||||
href="&enbase;/doc/&url.doc.langcode;/books/fdp-primer/book.html"><b>un
|
||||
seul gros fichier</b></a>.</p>
|
||||
href="&enbase;/doc/&url.doc.langcode;/books/fdp-primer/book.html"><b>une
|
||||
seule longue page</b></a>.</p>
|
||||
|
||||
<dl>
|
||||
<dt><a
|
||||
|
|
|
|||
Loading…
Reference in a new issue