| /DocBook /LinuxDoc |
Contents
Pages de manuels
- Vérifier l'orthographe :
aspell --mode=nroff check ma_page.1
- Vérifier le rendu du document :
man -l ma_page.1
- Documentation du format des pages de manuels (hors BSD) :
man 7 man
- Documentation du format des pages de manuels (BSD) :
man 7 mdoc
SGML et XML
Reconnaître les formats DocBook et LinuxDoc
Les deux principaux formats source que nous utilisons pour la documentation sont les format DocBook (XML et SGML) et LinuxDoc (SGML).
Le format DocBook est reconnaissable car il commence soit par une ligne du type (SGML DocBook) :
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.3//EN">
soit par une ligne du type (XML DocBook) :
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
Le format SGML LinuxDoc commence toujours par une ligne du type :
<!doctype linuxdoc system>
Pour plus d'informations, consultez les pages dédiées à /LinuxDoc et à /DocBook.
Vérifier l'orthographe d'un document XML (ou SGML) avec aspell
Si les outils de correction orthographique ne sont pas parfaits, ils permettent de corriger les plus grosses erreurs. L'utilisation d'un correcteur orthographique est donc en général une étape indispensable à la réalisation d'une bonne traduction.
Aspell permet de vérifier un texte XML (ou SGML) balisé en faisant abstraction des balises, ce qui facilite grandement le travail.
Il vous suffit de lancer la commande suivante :
aspell -H mon_document.xml
