Docbook semble très utilisé pour les outils Linux (GNOME, Gimp, et plein d’autres). J’ai juste fait quelques essais pour l’instant, mais je suis un peu réticente à écrire directement en XML, même si c’est l’idéal pour séparer vraiment la forme du fond.
Mini-exemple
Un exemple de fichier doc.xml
:
<?xml version="1.0" encoding="utf-8"?>
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2003/XInclude"
version="5.0">
<title>LE manuel</title>
<xi:include href="start.xml">
<xi:fallback>Désolé : cette partie est manquante !</xi:fallback>
</xi:include>
</book>
et le fichier inclus start.xml
:
<chapter xml:id="start"><title>Par où commencer</title>
<para>TODO: expliquer comment on fait !
</para>
</chapter>
Commandes
Validation
xmlstarlet val --err --xsd /usr/share/xml/docbook/schema/xsd/5.0/docbook.xsd doc.xml
mais ne semble pas gérer XInclude
.
Génération HTML
xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/html/docbook.xsl doc.xml > doc.html
Attention, si on utilise XInclude
, il faut ajouter l’option -xinclude
à cette commande.
Génération PDF
xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/fo/docbook.xsl gui-doc.xml > book.fo
fop -fo book.fo -pdf book.pdf
Il semble qu’il existe aussi un outil dblatex
pour générer su LaTeX, mais je n’ai pas essayé.
Documentation
Références :
- le site officiel ;
- LE livre : DocBook 5.1: The Definitive Guide, mais se concentre sur le format sans trop parler des outils ;
- DocBook XSL: The Complete Guide : à l’air plus détaillé sur comment utiliser les outils ;
Voir aussi :
- Afficher un pourcentage dans une page HTML
- Emoticônes et autre binettes
- Ocaml pour lire un fichier XML
- XSLT pour mettre en relation deux documents
- XML : validation, transformations, etc.
- Sphinx pour générer une jolie doc en HTML
- Perl pour faire des scripts efficaces
- Txt2tags
- LaTeX : pour générer de jolis documents
- Filtrage de texte : sed, awk, etc.
- SVN : gestion de version
Table des matières
Tags
ack
acronymes
analyse_statique
android
apt-get
awk
bash
bits
boot
c
checksum
coq
couleurs
css
csv
cut
dessin
diff
disque
docbook
docker
documentation
dokuwiki
dot
développement
fenêtres
firefox
frama-c
fstab
ftp
gcc
gestion_de_projet
gestion_de_version
git
graph
graphe
grep
grub
gzip
heredoc
htaccess-réseau
html
ide
ikiwiki
imagemagick
images
imprimer
ip
jenkins
js-of-ocaml
langage
latex
linux
make
mercurial
merlin
nvidia
ocaml
ocamlfind
ocamlgraph
orthographe
outil
parallel
path
pdf
perl
pgp
preuve_formelle
regexp
réseau
script
sed
sphinx
sqlite
ssh
sudo
svg
svn
syncbox
syntastic
systeme
système
tableurs
tcp-ip
texte
thunderbird
tikz
time
trac
txt2tags
ubuntu
unix
usb
utf-8
vim
virtualbox
virtualisation
vnc
web
windows
xfce
xkcd
xml
xmlstarlet
xmodmap
xsd
xslt
xubuntu
zcat
zenity
éditeur
émoticône
Dernières notes
- Afficher un pourcentage dans une page HTML
- VNC : Virtual Network Computing
- Git : déménagement d'un dépôt
- Quelques liens au sujet de l'analyse statique
- Ocaml: mon principal langage de développement
- Disque dur externe
- Les profiles dans Firefox
- Cryptographie et mail sous Android
- Quelques liens au sujet du C
- Git rebase : pour diviser un commit