1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
|
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!--
Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'. A manual page
<package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A
typical entry in a Makefile or Makefile.am is:
DB2MAN=/usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet
manpage.1: manpage.dbk
$(XP) $(DB2MAN) $<
The xsltproc binary is found in the xsltproc package. The
XSL files are in docbook-xsl. Please remember that if you
create the nroff version in one of the debian/rules file
targets (such as build), you will need to include xsltproc
and docbook-xsl in your Build-Depends control field.
-->
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
<!ENTITY dhfirstname "<firstname>Carl</firstname>">
<!ENTITY dhsurname "<surname>Fürstenberg</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
<!ENTITY dhdate "<date>2007-07-19</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
<!ENTITY dhemail "<email>azatoth@gmail.com</email>">
<!ENTITY dhusername "Carl Fürstenberg">
<!ENTITY dhucpackage "<refentrytitle>PLASTEX</refentrytitle>">
<!ENTITY dhpackage "plastex">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
]>
<refentry>
<refentryinfo>
<address>
&dhemail;
</address>
<author>
&dhfirstname;
&dhsurname;
<authorblurb>
<para>This manual page was written for
the &debian; system (but may be used by others), it borrows heavily on the documentation shipped with the plastex source package. Permission is granted to copy, distribute and/or modify this document under the terms of the &gnu; General Public License, Version 2 any later version published by the Free Software Foundation.
</para>
<para>
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.
</para>
</authorblurb>
</author>
<copyright>
<year>2007</year>
<holder>&dhusername;</holder>
</copyright>
&dhdate;
<productname>&dhpackage;</productname>
</refentryinfo>
<refmeta>
&dhucpackage;
&dhsection;
</refmeta>
<refnamediv>
<refname>&dhpackage;</refname>
<refpurpose>a collection of Python frameworks that allow you to process LaTeX documents</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>&dhpackage;</command>
<arg choice="plain"><replaceable>mylatex.tex</replaceable></arg>
<group>
<arg choice="plain"><option>--config=<replaceable>config-file</replaceable></option></arg>
<arg choice="plain"><option>-c <replaceable>config-file</replaceable></option></arg>
</group>
<arg><option>--kpsewhich=<replaceable>program</replaceable></option></arg>
<arg><option>--renderer=<replaceable>renderer-name</replaceable></option></arg>
<arg><option>--theme=<replaceable>theme-name</replaceable></option></arg>
<group>
<arg choice="plain"><option>--copy-theme-extras</option></arg>
<arg choice="plain"><option>--no-theme-extras</option></arg>
</group>
<arg><option>--base-url=<replaceable>url</replaceable></option></arg>
<arg><option>--index-columns=<replaceable>integer</replaceable></option></arg>
<arg><option>--title=<replaceable>string</replaceable></option></arg>
<arg><option>--toc-depth=<replaceable>integer</replaceable></option></arg>
<arg><option>--toc-non-files</option></arg>
<arg><option>--counter=[ </option><arg rep="repeat" choice="plain"><arg choice="req"><replaceable>counter-name</replaceable></arg><arg choice="req"><replaceable>initial-value</replaceable></arg></arg><option>]</option></arg>
<arg><option>--links=[ </option><arg choice="plain"><arg choice="req"><replaceable>key</replaceable></arg><arg><replaceable>url</replaceable></arg><arg choice="req"><replaceable>title</replaceable></arg></arg><option>]</option></arg>
<arg><option>--bad-filename-chars=<replaceable>string</replaceable></option></arg>
<arg><option>--bad-filename-chars-sub=<replaceable>string</replaceable></option></arg>
<group>
<arg choice="plain"><option>--dir=<replaceable>directory</replaceable></option></arg>
<arg choice="plain"><option>-d <replaceable>directory</replaceable></option></arg>
</group>
<arg><option>--escape-high-chars</option></arg>
<arg><option>--filename=<replaceable>filename</replaceable></option></arg>
<arg><option>--input-encoding=<replaceable>encoding</replaceable></option></arg>
<arg><option>--output-encoding=<replaceable>encoding</replaceable></option></arg>
<arg><option>--split-level=<replaceable>integer</replaceable></option></arg>
<arg><option>--image-base-url=<replaceable>url</replaceable></option></arg>
<arg><option>--image-compiler=<replaceable>program</replaceable></option></arg>
<group>
<arg choice="plain"><option>--enable-images</option></arg>
<arg choice="plain"><option>--disable-images</option></arg>
</group>
<group>
<arg choice="plain"><option>--enable-image-cache</option></arg>
<arg choice="plain"><option>--disable-image-cache</option></arg>
</group>
<arg><option>--imager=<replaceable>program</replaceable></option></arg>
<arg><option>--image-filenames=<replaceable>filename</replaceable></option></arg>
<arg><option>--vector-imager=<replaceable>program</replaceable></option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>This manual page documents the <command>&dhpackage;</command> command.</para>
<para>This manual page was written for the &debian; distribution
because the original program does not have a manual page.
</para>
<para><command>plasTeX</command> is a collection of Python frameworks that allow you to process LaTeX documents. This processing includes, but is not limited to, conversion of LaTeX documents to various document formats. Of course, it is capable of converting to HTML or XML formats such as DocBook and tBook, but it is an open framework that allows you to drive any type of rendering. This means that it could be used to drive a COM object that creates a MS Word Document.</para>
<para>The plasTeX framework allows you to control all of the processes including tokenizing, object creation, and rendering through API calls. You also have access to all of the internals such as counters, the states of “if” commands, locally and globally defined macros, labels and references, etc. In essence, it is a LaTeX document processor that gives you the advantages of an XML document in the context of a language as superb as Python.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`-'). A summary of
options is included below. For a complete description, see the
<application>Info</application> files.</para>
<variablelist>
<varlistentry>
<term><option>--config=<replaceable>config-file</replaceable></option>,
<option>-c <replaceable>config-file</replaceable></option>
</term>
<listitem>
<para>Specifies a configuration file to load. This should be the first option specified on the command-line.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--kpsewhich=<replaceable>program</replaceable></option>
</term>
<listitem>
<para>specifies the <command>kpsewhich</command> program to use to locate LaTeX files and packages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--renderer=<replaceable>renderer-name</replaceable></option>
</term>
<listitem>
<para>specifies which renderer to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--theme=<replaceable>theme-name</replaceable></option>
</term>
<listitem>
<para>specifies which theme to use.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--copy-theme-extras</option>,
<option>--no-theme-extras</option>
</term>
<listitem>
<para>indicates whether or not extra files that belong to a theme (if there are any) should be copied to the output directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--base-url=<replaceable>url</replaceable></option>
</term>
<listitem>
<para>specifies a base URL to prepend to the path of all links.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--index-columns=<replaceable>integer</replaceable></option>
</term>
<listitem>
<para>specifies the number of columns to group the index into.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--sec-num-depth=<replaceable>integer</replaceable></option>
</term>
<listitem>
<para>specifies the section level depth that should appear in section numbers. This value overrides the value of the secnumdepth counter in the document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--title=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>specifies a title to use for the document instead of the title given in the LaTeX source document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--toc-depth=<replaceable>integer</replaceable></option>
</term>
<listitem>
<para>specifies the number of levels to include in each table of contents.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--toc-non-files</option>
</term>
<listitem>
<para>specifies that sections that do not create files should still appear in the table of contents. By default, only sections that create files will show up in the table of contents.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--counter=[ <replaceable>counter-name</replaceable> <replaceable>initial-value</replaceable> ... ]</option>
</term>
<listitem>
<para>specifies the initial counter values.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--links=[ <replaceable>key</replaceable> <replaceable>optional-url</replaceable> <replaceable>title</replaceable> ]</option>
</term>
<listitem>
<para>specifies links to be included in the navigation object. Since at least two values are needed in the links (key and title, with an optional URL), the values are grouped in square brackets on the command-line (<parameter class="command">[ ]</parameter>).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--bad-filename-chars=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>specifies all characters that should not be allowed in a filename. These characters will be replaced by the value in <parameter class="option">--bad-filename-chars-sub</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--bad-filename-chars-sub=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>specifies a string to use in place of invalid filename characters (specified by the <parameter class="option">--bad-chars-sub</parameter> option).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--dir=<replaceable>directory</replaceable></option>,
<option>-d <replaceable>directory</replaceable></option>
</term>
<listitem>
<para>specifies a directory name to use as the output directory.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--escape-high-chars</option>
</term>
<listitem>
<para>some output types allow you to represent characters that are greater than 7-bits with an alternate representation to alleviate the issue of file encoding. This option indicates that these alternate representations should be used.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--filename=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>specifies the templates to use for generating filenames. The filename template is a list of space separated names. Each name in the list is returned once.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--input-encoding=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>specifies which encoding the LaTeX source file is in.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--output-encoding=<replaceable>string</replaceable></option>
</term>
<listitem>
<para>specifies which encoding the output files should use. Note: This depends on the output format as well. While HTML and XML use encodings, a binary format like MS Word, would not.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--split-level=<replaceable>integer</replaceable></option>
</term>
<listitem>
<para>specifies the highest section level that generates a new file. Each section in a LaTeX document has a number associated with its hierarchical level. These levels are -2 for the document, -1 for parts, 0 for chapters, 1 for sections, 2 for subsections, 3 for subsubsections, 4 for paragraphs, and 5 for subparagraphs. A new file will be generated for every section in the hierarchy with a value less than or equal to the value of this option. This means that for the value of 2, files will be generated for the document, parts, chapters, sections, and subsections.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--image-base-url=<replaceable>url</replaceable></option>
</term>
<listitem>
<para>specifies a base URL to prepend to the path of all images.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--image-compiler=<replaceable>program</replaceable></option>
</term>
<listitem>
<para>specifies which program to use to compile the images LaTeX document.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--enable-images</option>,
<option>--disable-images</option>
</term>
<listitem>
<para>indicates whether or not images should be generated.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--enable-image-cache</option>
<option>--disable-image-cache</option>
</term>
<listitem>
<para>indicates whether or not images should use a cache between runs.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--imager=<replaceable>program</replaceable></option>
</term>
<listitem>
<para>specifies which converter will be used to take the output from the LaTeX compiler and convert it to images. You can specify a space delimited list of names as well. If a list of names is specified, each one is verified in order to see if it works on the current machine. The first one that succeeds is used.</para>
<para>You can use the value of “none” to turn the imager off.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--image-filenames=<replaceable>filename-template</replaceable></option>
</term>
<listitem>
<para>specifies the image naming template to use to generate filenames. This template is the same as the templates used by the <parameter class="option">--filename</parameter> option</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--vector-imager=<replaceable>program</replaceable></option>
</term>
<listitem>
<para>specifies which converter will be used to take the output from the LaTeX compiler and convert it to vector images. You can specify a space delimited list of names as well. If a list of names is specified, each one is verified in order to see if it works on the current machine. The first one that succeeds is used.</para>
<para>You can use the value of “none” to turn the vector imager off.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>
|
