logilab/doctools

view doc/user_manual.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.7 $
7 :Date: $Date: 2005-03-29 14:24:04 $
8 :Abstract:
9 Logilab documentation's tools user manual.
10
11
12 py2dbk
13 ------
14
15 Description
16 ```````````
17 Transform a Python_ module into a Docbook_ document to get it nicely
18 formated (and usually to include it from another Docbook document).
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 Example
41 ```````
42 ::
43
44 py2dbk --format extended-docbook myfile.py
45
46 This example should produce a **myfile.xml** file containing the Python
47 source code from *myfile.py* formatted as a XML Docbook document. The
48 extended-docbook format will use special roles that should be handled
49 by specifics FO (PDF) or CSS (HTML) stylesheets.
50
51
52
53 xml2dbk
54 -------
55
56 Description
57 ```````````
58 Transform any XML file into a Docbook_ or HTML document to get it nicely
59 formated (and usually to include it from another Docbook document).
60
61 Synopsis
62 ````````
63 ::
64
65 USAGE: xml2dbk [OPTIONS] <input.xml>...
66
67 OPTIONS:
68 -h / --help
69 display this help message and exit
70
71 -o / --output <OUTPUT_FILE>
72 write results in file <OUTPUT_FILE>.
73 -s / --stdout
74 write results to standard output.
75 -e / --encoding iso-8859-1
76 specify encoding to use in outputs.
77
78 -n / --no-head
79 do not insert output headers.
80
81 -f / --format <OUTPUT_FORMAT>
82 set output format. Default to docbook.
83 Available formats are docbook, extended-docbook, html.
84
85 Example
86 ```````
87 ::
88
89 xml2dbk --format extended-docbook myfile.xml
90
91 This example should produce a **myfile_dcbk.xml** file containing the
92 original XML document from *myfile.xml* formatted as a XML Docbook
93 document. The extended-docbook format will use special roles that
94 should be handled by specifics FO (PDF) or CSS (HTML) stylesheets.
95
96
97
98 mkdoc
99 -----
100
101 Description
102 ```````````
103 Transform ReST_ (Restructured Text) or Docbook_ files to html ou
104 pdf. You will need some external stylesheets not included in this
105 package to get the Docbook_ to HTML or PDF transformation done.
106
107 Available format depends on the installed transformation. FIXME: write
108 doc about this...
109
110 Synopsis
111 ````````
112 ::
113
114 USAGE: mkdoc [OPTIONS] <input file>...
115
116 OPTIONS:
117 -h / --help
118 display this help message and exit
119
120 -f / --format <OUTPUT_FORMAT>
121 set output format. Default to html.
122 Available formats are docbook, html, multi_html, pdf, pdf_ao, pdf_iup, pdf_manual, pdf_psyc, site_html.
123
124 -n / --noverif
125 doesn't verify XML correctness.
126 -k / --keep-tmp
127 doesn't remove temporary directory where transforms are done.
128
129 -p / --parameter <NAME>:<VALUE>
130 sets the <NAME> stylesheet parameter to <VALUE>. You may set this option
131 multiple times. Parameters are given to the xslt processor.
132
133 Example
134 ```````
135 ::
136
137 mkdoc --format pdf myfile.rst unautrefichier.xml
138
139 This example should produce **myfile.pdf** and **anotherfile.pdf**
140 files containing each original document (one in ReST and the other in
141 Docbook) formatted as a PDF file.
142
143
144 .. _ReST: http://docutils.sourceforge.net/rst.html
145 .. _Docbook: http://www.docbook.org
146 .. _Python: http://www.python.org