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
363
364
365
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 10.0.0a2" />
<title>AsciiDoc API</title>
<link rel="stylesheet" href="./asciidoc.css" type="text/css" />
<link rel="stylesheet" href="./layout2.css" type="text/css" />
<script type="text/javascript" src="./asciidoc.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install(1);
/*]]>*/
</script>
</head>
<body style="max-width:70em">
<div id="layout-menu-box">
<div id="layout-menu">
<div>»<a href="index.html">Home</a></div>
<div>»<a href="userguide.html">User Guide</a></div>
<div>»<a href="INSTALL.html">Installation</a></div>
<div>»<a href="faq.html">FAQ</a></div>
<div>»<a href="manpage.html">asciidoc(1)</a></div>
<div>»<a href="a2x.1.html">a2x(1)</a></div>
<div>»<a href="asciidocapi.html">API</a></div>
<div>»<a href="plugins.html">Plugins</a></div>
<div>»<a href="http://powerman.name/doc/asciidoc">Cheatsheet</a></div>
<div>»<a href="testasciidoc.html">Tests</a></div>
<div>»<a href="CHANGELOG.html">ChangeLog</a></div>
<div>»<a href="support.html">Support</a></div>
<div id="page-source">»<a href="asciidocapi.txt">Page Source</a></div>
</div>
</div>
<div id="layout-content-box">
<div id="layout-banner">
<div id="layout-title">AsciiDoc</div>
<div id="layout-description">Text based document generation</div>
</div>
<div id="layout-content">
<div id="header">
<h1>AsciiDoc API</h1>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<div class="paragraph"><p><em>asciidocapi</em> — a Python API module for <em>AsciiDoc</em>.</p></div>
</div>
</div>
<div class="sect1">
<h2 id="_introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <em>asciidocapi</em> module implements a Python API for AsciiDoc. It
allows you to set <code>asciidoc(1)</code> program options, compile an AsciiDoc
source file and then interrogate the results. The <code>asciidocapi.py</code>
module file contains the <code>AsciiDocAPI</code> wrapper class for
<code>asciidoc.py</code>.</p></div>
<div class="ulist"><div class="title">Benefits</div><ul>
<li>
<p>
Stable API Shields the user from the undocumented and possibly
volatile <code>asciidoc.py</code> internals.
</p>
</li>
<li>
<p>
Easier to use and more flexible than the alternative of running
<code>asciidoc(1)</code> as a separate process.
</p>
</li>
<li>
<p>
Executes inside your application (better performance than running
separate <code>asciidoc(1)</code> command processes).
</p>
</li>
</ul></div>
</div>
</div>
<div class="sect1">
<h2 id="_using_asciidocapi">Using asciidocapi</h2>
<div class="sectionbody">
<div class="paragraph"><p>To use the API just drop the <code>asciidocapi.py</code> file into your
application directory, import it and use the <code>AsciiDocAPI</code> class. The
only requirement is that a compatible version of <em>AsciiDoc</em> is already
installed — simple, no setuptools to run, no Eggs to install, no
non-standard library dependencies.</p></div>
<div class="paragraph"><p>You can find <code>asciidocapi.py</code> in the AsciiDoc
<a href="https://asciidoc.org/INSTALL.html#X1">distribution
archives</a> (version 8.4.1 or better).</p></div>
<div class="paragraph"><p>Once you have <code>asciidocapi.py</code> Verify everything is working by running
the module doctests:</p></div>
<div class="literalblock">
<div class="content">
<pre><code>python asciidocapi.py</code></pre>
</div></div>
<div class="paragraph"><p>If there are no messages then all is well.</p></div>
<div class="paragraph"><p>The following minimal example compiles <code>mydoc.txt</code> to <code>mydoc.html</code>:</p></div>
<div class="listingblock">
<div class="content">
<pre><code><span style="color:#000000; font-weight:bold">from</span> asciidocapi <span style="color:#000000; font-weight:bold">import</span> AsciiDocAPI
asciidoc <span style="color:#000000">=</span> <span style="color:#010181">AsciiDocAPI</span><span style="color:#000000">()</span>
asciidoc<span style="color:#000000">.</span><span style="color:#010181">execute</span><span style="color:#000000">(</span><span style="color:#bf0303">'mydoc.txt'</span><span style="color:#000000">)</span></code></pre>
</div></div>
<div class="paragraph"><p>The next interactive example uses file-like objects for input and output:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>$ python
Python 2.5.2 (r252:60911, Jul 31 2008, 17:28:52)
[GCC 4.2.3 (Ubuntu 4.2.3-2ubuntu7)] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from asciidocapi import AsciiDocAPI
>>> import StringIO
>>> infile = StringIO.StringIO('Hello *{author}*')
>>> outfile = StringIO.StringIO()
>>> asciidoc = AsciiDocAPI()
>>> asciidoc.options('--no-header-footer')
>>> asciidoc.attributes['author'] = 'Joe Bloggs'
>>> asciidoc.execute(infile, outfile, backend='html4')
>>> print outfile.getvalue()
<p>Hello <strong>Joe Bloggs</strong></p>
>>></code></pre>
</div></div>
</div>
</div>
<div class="sect1">
<h2 id="_implementation_rationale">Implementation Rationale</h2>
<div class="sectionbody">
<div class="paragraph"><div class="title">Leverage existing knowledge</div><p>The API maps directly onto the <code>asciidoc(1)</code> command — this is
deliberate — if you know the <code>asciidoc(1)</code> command learning the API
will be trivial. A nice side effect of this goal is that API and
command-line modes share the same code — virtually no <code>asciidoc(1)</code>
code is specific to API usage.</p></div>
<div class="paragraph"><div class="title">Simplicity</div><p>Implemented with a single Python module file (<code>asciidocapi.py</code>)
containing the <em>AsciiDocAPI</em> API class. <em>AsciiDocAPI</em> contains just
one method plus a few attributes for processing options and result
messages. No external setup tools and no non-standard library
dependencies are used or required.</p></div>
<div class="paragraph"><div class="title">Loose coupling</div><p>The dependency between <code>asciidocapi.py</code> and <code>asciidoc.py</code> is minimal — the current <code>asciidocapi.py</code> module uses only two attributes and
one function from the <code>asciidoc.py</code> module.</p></div>
<div class="olist arabic"><div class="title">Why isn’t the API baked right into the asciidoc.py command script?</div><ol class="arabic">
<li>
<p>
You can’t just drop <code>asciidoc.py</code> into your application because it
requires all the related config files and filters — complex and
unnecessary since all this was already done when you installed
AsciiDoc.
</p>
</li>
<li>
<p>
This scheme separates the API from the AsciiDoc application — the
API implementation can be extended or replaced independently of
AsciiDoc.
</p>
</li>
</ol></div>
</div>
</div>
<div class="sect1">
<h2 id="_api_reference">API reference</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="X2">Class <code>AsciiDocAPI(object)</code></h3>
<div class="paragraph"><p>This is the <em>AsciiDoc</em> API class.</p></div>
<div class="sect3">
<h4 id="_instance_attributes">Instance attributes</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>asciidoc</code>
</dt>
<dd>
<p>
The imported <code>asciidoc.py</code> module.
</p>
</dd>
<dt class="hdlist1">
<code>attributes</code>
</dt>
<dd>
<p>
A dictionary of AsciiDoc attribute values passed to AsciiDoc.
</p>
<div class="ulist"><ul>
<li>
<p>
Setting an attribute value to <code>None</code> (<code>name: None</code>) will undefine
(delete) the attribute (this in addition to the <code>name!</code> attribute
name format that the <code>asciidoc(1)</code> command uses).
</p>
</li>
<li>
<p>
To simply define an attribute set the attribute value to a blank
string (<code>name: ''</code>)
</p>
</li>
</ul></div>
</dd>
<dt class="hdlist1">
<code>cmd</code>
</dt>
<dd>
<p>
The file path of the <code>asciidoc.py</code> script. Set by the <code>__init__</code>
method.
</p>
</dd>
<dt class="hdlist1">
<code>messages</code>
</dt>
<dd>
<p>
A chronologically ordered list of message strings generated during
AsciiDoc execution (last message at the end of the list).
</p>
</dd>
<dt class="hdlist1">
<code>options</code>
</dt>
<dd>
<p>
An instance of the <a href="#X1">Options class</a>. Contains a list of command
options passed to AsciiDoc.
</p>
</dd>
</dl></div>
</div>
<div class="sect3">
<h4 id="_instance_methods">Instance methods</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>__init__(self, asciidoc_py=None)</code>
</dt>
<dd>
<p>
Locate and import <code>asciidoc.py</code> module and verify API compatibility.
Initialize instance attributes. A search for the <code>asciidoc</code> module is
made in the following order:
</p>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Use the <code>ASCIIDOC_PY</code> environment variable if it is set.
</p>
</li>
<li>
<p>
Use the <code>asciidoc_py</code> argument if it is set.
</p>
</li>
<li>
<p>
Search the environment <em>PATH</em> for <code>asciidoc.py</code>, <code>asciidoc.pyc</code> and
<code>asciidoc</code> (in that order).
</p>
</li>
<li>
<p>
Finally repeat the previous search in the current working directory.
</p>
</li>
</ol></div>
</dd>
<dt class="hdlist1">
<code>execute(self, infile, outfile=None, backend=None)</code>
</dt>
<dd>
<p>
Compile <code>infile</code> to <code>outfile</code> using <code>backend</code> format. <code>infile</code> and
<code>outfile</code> can be file path strings or file-like objects. <code>backend</code> is
name of <em>AsciiDoc</em> backend (takes same values as <code>asciidoc(1)</code> command
<code>--backend</code> option). If <code>outfile</code> or <code>backend</code> are <code>None</code> then their
respective <code>asciidoc(1)</code> defaults are used.
</p>
</dd>
</dl></div>
</div>
</div>
<div class="sect2">
<h3 id="X1">Class <code>Options(object)</code></h3>
<div class="paragraph"><p>Stores <code>asciidoc(1)</code> command options. You can use any <code>asciidoc(1)</code>
options with the exception of the <code>--doctest</code> and <code>--filter</code> options.</p></div>
<div class="sect3">
<h4 id="_instance_attributes_2">Instance attributes</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>values</code>
</dt>
<dd>
<p>
The list of <code>(name,value)</code> command option tuples.
</p>
</dd>
</dl></div>
</div>
<div class="sect3">
<h4 id="_instance_methods_2">Instance methods</h4>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>__call__(self, name, value=None)</code>
</dt>
<dd>
<p>
A shortcut for the <code>append</code> method. Example:
</p>
<div class="literalblock">
<div class="content">
<pre><code>opts = Options()
opts('--verbose')</code></pre>
</div></div>
</dd>
<dt class="hdlist1">
<code>append(self, name, value=None)</code>
</dt>
<dd>
<p>
Append <code>(name,value)</code> to the options list. Example:
</p>
<div class="literalblock">
<div class="content">
<pre><code>opts = Options()
opts.append('--conf-file', 'blog.conf')</code></pre>
</div></div>
</dd>
</dl></div>
</div>
</div>
<div class="sect2">
<h3 id="_class_code_asciidocerror_exception_code">Class <code>AsciiDocError(Exception)</code></h3>
<div class="paragraph"><p>Thrown by the <a href="#X2">AsciiDocAPI class</a> when an <em>AsciiDoc</em> execution
error occurs.</p></div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Version 9.0.5<br />
Last updated 2021-02-06 05:19:15 UTC<br />
AsciiDoc is a trademark of the Eclipse Foundation, Inc.
</div>
<div id="footer-badges">
<a href="https://validator.w3.org/check?uri=referer">
<img style="border:0;width:88px;height:31px"
src="https://www.w3.org/Icons/valid-xhtml11-blue"
alt="Valid XHTML 1.1" height="31" width="88" />
</a>
<a href="https://jigsaw.w3.org/css-validator/">
<img style="border:0;width:88px;height:31px"
src="https://jigsaw.w3.org/css-validator/images/vcss-blue"
alt="Valid CSS!" />
</a>
</div>
</div>
</div>
</div>
</body>
</html>
|
