Adelmar Alain, aadelmar@free.fr
vers: 1.0 jeudi 11 Juillet 2002
le document SGML
le document POD (Plain Old Text traduit par:
"le bon vieux texte" ou "l'ancien pur texte".
la page de man
le document text-info
Comment éditer de la doc, comment l'adapter
depuis d'autres formats et comment la mettre en forme.
Ce document n'ai en rien pédagogique et
ne se veux pas de référence, il est conçu juste pour
éclairer la lanterne de certaines personnes qui aimeraient bien
coucher sur papier/fichier leurs idées sans ce prendre le choux
à décortiquer des tonnes de doc en VO. Car tout le monde
devrez pouvoir coucher ses expériences, idées ,traductions
dans un format visible par tous. Il n'y a qu'à ce prix que l'on
évoluera, en rendant le savoir acqui accessible à tous. Tous
le monde a sa pierre à apporter à l'édifice et heureusement
qu'il n'y à pas que des pros de l'éditions qui éditent
des documents, ci-non il y en aurai beaucoup moins sur la toile et moins
facilement accéssible.
aal
A l'heure ou je remplis ces pages, j'ai d'énormes lacunes dans
pas mal de domaines ayant trait à l'édition en général,
je ne suis pas un forcené, ni un puriste en la matière. J'ai
simplement ecris quelques documents originaux ainsi que quelques traductions,
j'éspére juste, avec ce document, enlever l'appréhension
à certain pour qu'il nous fassent profiter de leurs idées.
-----------------
J'ai perdu un temps précieux à décortiquer de
la doc US pour apprendre, souvent j'ai fais l'impasse au lieu de publier.
J'ai gacher aussi beaucoup de travail suite à des plantages et autre
perte totale de répértoire. Ne laissons pas le monopole du
savoir à quelque propriétaire, pour qu'il nous le revende
au détail.
------------------
Certaine documentation ont pour dessins le plus large auditoire possible,
comme les pages-perso, les traductions, etc.. Ces documentations doivent
étre lu par tous, donc il vaut mieux les faires dans un format ouvrable
de n'importe quel éditeur et facilement transformable en n'importe
quel autre format.
Ce format exsiste c'est le SGML, qui s'ouvre depuis n'importe quel
éditeur sur n'importe quel OS et peut être directement transformé
au format HTML ou RTF pour ne citer que les plus courants. Toutes
les sources de documentation sont d'abord sortie au format SGML avant de
ce retrouver sur le Net au format HTML.
D'autre documentations sont écrites pour documenter un programme personnel, un script interactif demandant des réponses calibrés ou une explication approfondi ou chaqu'un pourra trouver la réponse adapté à ses connaissances. Dans ce cas le POD ou le text-info sera le mieux addapté, le plus particuliérement bien conçu.
Cetaine documentation sont spéciale à un environement,
à un OS (Operating System). Par exemple pour une commande,
un alias ou un petit script la documentation portera sur une syntaxe, un
bref expliquatif sur la fonction rempli et/ou sur les manipulations à
efféctuer avant. Dans ce cas la page de man et un bon choix.
Le SGML (Standard Generalized Markup Language) est le format
idéal pour faire de la doc car il est trés facile de convertir
un texte, en document SGML et une fois cela fait, vous pouvez le
sortir sous moult formats différants, dont: HTML, RTF pour ne citer
que les plus utilisés. Sans comtper qu'un document au format SGML
est directement consultable à la console ou sur n'importe quel éditeur
sur n'importe quel systême. On va voir comment...
On peut grace à SGML définir un type de document, cette définition du type de document est appelé DTD (Document Type Definition) ce qui rend par la suite son répértoriage et l'accés par recherche plus facile.
C'est quoi le SGML?
Le SGML c'est un langage à balise, ou plutôt, c'est quelques
balises qui ajouter à votre document brut, le rende intelligent.
C'est à dire transformable directement en fichier HTML