size: 3 KiB


  

1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html>
4<head>
5    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6    <title>Reference</title>
7    <link rel="stylesheet" href="../ldoc.css" type="text/css" />
8</head>
9<body>
10
11<div id="container">
12
13<div id="product">
14	<div id="product_logo"></div>
15	<div id="product_name"><big><b></b></big></div>
16	<div id="product_description"></div>
17</div> <!-- id="product" -->
18
19<div id="main">
20
21
22<!-- Menu -->
23
24
25
26<div id="navigation">
27<h1>djot</h1>
28<ul>
29  <li><a href="../index.html">Index</a></li>
30</ul>
31
32<hr/>
33<ul>
34    <li><a href="#parse">parse&nbsp;(input, sourcepos, warn)</a></li>
35    <li><a href="#parse_events">parse_events&nbsp;(input, warn)</a></li>
36    <li><a href="#render_ast_pretty">render_ast_pretty&nbsp;(doc)</a></li>
37    <li><a href="#render_ast_json">render_ast_json&nbsp;(doc)</a></li>
38    <li><a href="#render_html">render_html&nbsp;(doc)</a></li>
39    <li><a href="#render_event">render_event&nbsp;(startpos, endpos, annotation)</a></li>
40    <li><a href="#parse_and_render_events">parse_and_render_events&nbsp;(input, warn)</a></li>
41    <li><a href="#version">version</a></li>
42</ul>
43
44</div>
45
46<div id="content">
47
48
49<h1>Module <code>djot</code></h1>
50
51<p>
52
53</p>
54<p> Parse and render djot light markup format. See https://djot.net.</p>
55
56<br/>
57<br/>
58
59    <dl class="function">
60    <dt>
61    <a name = "parse"></a>
62    <strong>parse&nbsp;(input, sourcepos, warn)</strong>
63    </dt>
64    <dd>
65    Parse a djot text and construct an abstract syntax tree (AST)
66 representing the document.
67     object with <code>pos</code> and <code>message</code> fields.
68
69
70</dd>
71    <dt>
72    <a name = "parse_events"></a>
73    <strong>parse_events&nbsp;(input, warn)</strong>
74    </dt>
75    <dd>
76    Parses a djot text and returns an iterator over events, consisting
77 of a start position (bytes), and an position (bytes), and an
78 annotation.
79
80
81<p> object with <code>pos</code> and <code>message</code> fields.</p>
82
83<pre><code> for startpos, endpos, annotation in djot.parse_events("hello *world") do
84 ...
85 end
86</code></pre>
87
88
89
90</dd>
91    <dt>
92    <a name = "render_ast_pretty"></a>
93    <strong>render_ast_pretty&nbsp;(doc)</strong>
94    </dt>
95    <dd>
96    Render a document's AST in human-readable form.
97
98
99
100
101
102</dd>
103    <dt>
104    <a name = "render_ast_json"></a>
105    <strong>render_ast_json&nbsp;(doc)</strong>
106    </dt>
107    <dd>
108    Render a document's AST in JSON.
109
110
111
112
113
114</dd>
115    <dt>
116    <a name = "render_html"></a>
117    <strong>render_html&nbsp;(doc)</strong>
118    </dt>
119    <dd>
120    Render a document as HTML.
121
122
123
124
125
126</dd>
127    <dt>
128    <a name = "render_event"></a>
129    <strong>render_event&nbsp;(startpos, endpos, annotation)</strong>
130    </dt>
131    <dd>
132    Render an event as a JSON array.
133
134
135
136
137
138</dd>
139    <dt>
140    <a name = "parse_and_render_events"></a>
141    <strong>parse_and_render_events&nbsp;(input, warn)</strong>
142    </dt>
143    <dd>
144    Parse a document and render as a JSON array of events.
145     an object with fields 'message' and 'pos'
146
147
148</dd>
149</dl>
150    <dl class="function">
151    <dt>
152    <a name = "version"></a>
153    <strong>version</strong>
154    </dt>
155    <dd>
156    djot version (string)
157
158
159
160
161
162</dd>
163</dl>
164
165
166</div> <!-- id="content" -->
167</div> <!-- id="main" -->
168<div id="about">
169</div> <!-- id="about" -->
170</div> <!-- id="container" -->
171</body>
172</html>
173