logilab/doctools

view doc/manuel_utilisateur.txt @ 0:cc367abb080e

find changesets by author, revision, files, or words in the commit message
forget the past. forget the past.
author root
date Wed, 26 Apr 2006 10:48:09 +0000
parents
children
line source
1 Manuel utilisateur
2 ==================
3
4 :Author: Sylvain Thénault
5 :Organization: Logilab
6 :Version: $Revision: 1.1 $
7 :Date: $Date: 2005-03-29 14:24:04 $
8 :Abstract:
9 Manuel pour l'utilisateur des outils de documentations de
10 Logilab.
11
12
13 py2dbk
14 ------
15
16 Description
17 ```````````
18 Formate un script Python afin de pouvoir l'inclure dans un document Docbook.
19
20 Synopsis
21 ````````
22 ::
23
24 USAGE: py2dbk [OPTIONS] <input.py>...
25
26 OPTIONS:
27 -h / --help
28 display this help message and exit
29
30 -r / --root "rootstring"
31 insert "rootstring" as root
32
33 -f / --format <OUTPUT_FORMAT>
34 set output format. Default to docbook.
35 Available formats are docbook, extended-docbook.
36
37 -s / --stdout
38 write results to standard output
39
40 Exemple
41 ```````
42 ::
43
44 py2dbk --format extended-docbook monfichier.py
45
46 Cet exemple produira en sortie un fichier monfichier.xml.
47
48
49 xml2dbk
50 -------
51
52 Description
53 ```````````
54 Formatte un fichier XML afin de pouvoir l'inclure dans un document Docbook. Il
55 est également possible d'obtenir une sortie HTML (colorisée)
56
57 Synopsis
58 ````````
59 ::
60
61 USAGE: xml2dbk [OPTIONS] <input.xml>...
62
63 OPTIONS:
64 -h / --help
65 display this help message and exit
66
67 -o / --output <OUTPUT_FILE>
68 write results in file <OUTPUT_FILE>.
69 -s / --stdout
70 write results to standard output.
71 -e / --encoding iso-8859-1
72 specify encoding to use in outputs.
73
74 -n / --no-head
75 do not insert output headers.
76
77 -f / --format <OUTPUT_FORMAT>
78 set output format. Default to docbook.
79 Available formats are docbook, extended-docbook, html.
80
81 Exemple
82 ```````
83 ::
84
85 xml2dbk --format extended-docbook monfichier.xml
86
87 Cet exemple produira en sortie un fichier monfichier_dcbk.xml.
88
89
90 mkdoc
91 -----
92
93 Description
94 ```````````
95 Convertit des fichiers au format ReST_ (Restructured Text) ou Docbook_ dans
96 divers formats tels que html ou pdf.
97
98 Synopsis
99 ````````
100 ::
101
102 USAGE: mkdoc [OPTIONS] <input file>...
103
104 OPTIONS:
105 -h / --help
106 display this help message and exit
107
108 -f / --format <OUTPUT_FORMAT>
109 set output format. Default to html.
110 Available formats are docbook, html, multi_html, pdf, pdf_ao, pdf_iup, pdf_manual, pdf_psyc, site_html.
111
112 -n / --noverif
113 doesn't verify XML correctness.
114 -k / --keep-tmp
115 doesn't remove temporary directory where transforms are done.
116
117 -p / --parameter <NAME>:<VALUE>
118 sets the <NAME> stylesheet parameter to <VALUE>. You may set this option
119 multiple times. Parameters are given to the xslt processor.
120
121 Exemple
122 ```````
123 ::
124
125 mkdoc --format pdf monfichier.rst unautrefichier.xml
126
127 Cet exemple produira en sortie 2 fichiers : monfichier.pdf et
128 unautrefichier.pdf.
129
130
131
132 .. _ReST: http://docutils.sourceforge.net/rst.html
133 .. _Docbook: http://www.docbook.org