aboutsummaryrefslogtreecommitdiff
path: root/doc/lua-filter-types-and-objects.md
blob: f6d11a9289d75eb7cad770dd5097e52755883bfa (plain)
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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
% Lua filter types and objects
% Albert Krewinkel
% Oct 6, 2018

## Pandoc

blocks
:   document content ([list] of [blocks])

meta
:   document meta information ([Meta] object)


## Meta

Meta information on a document; string-indexed collection of [meta
values](#metavalue). This is represented as a string-indexed table containing
[meta values](#MetaValue).


## MetaValue

Document meta information items.

### MetaBlocks

blocks
:   a list of blocks usable as meta value ([list] of [blocks])


## Block

### BlockQuote

A block quote element

content:
:   block content ([list] of [blocks])

tag, t
:   the literal `BlockQuote` (string)

### BulletList

A bullet list

content
:   list of items ([list] of [blocks])

tag, t
:   the literal `BlockQuote` (string)

### CodeBlock

Block of code.

text
:   code string (string)

attr
:   element attributes (Attr)

identifier
:   alias for `attr.identifier` (string)

classes
:   alias for `attr.classes` ([list] of strings)

attributes
:   alias for `attr.attributes` ([attributes])

tag, t
:   the literal `CodeBlock` (string)

### DefinitionList

Definition list, containing terms and their explanation.

content
:   list of items

tag, t
:   the literal `DefinitionList` (string)

### Div

Generic block container with attributes

content
:   block content ([list] of [blocks])

attr
:   element attributes (Attr)

identifier
:   alias for `attr.identifier` (string)

classes
:   alias for `attr.classes` ([list] of strings)

attributes
:   alias for `attr.attributes` ([attributes])

tag, t
:   the literal `Div` (string)

### Header

Creates a header element.

level
:   header level (integer)

content
:   inline content ([list] of [inlines])

attr
:   element attributes (Attr)

identifier
:   alias for `attr.identifier` (string)

classes
:   alias for `attr.classes` ([list] of strings)

attributes
:   alias for `attr.attributes` ([attributes])

tag, t
:   the literal `Header` (string)


### HorizontalRule

A horizontal rule.

tag, t
:   the literal `HorizontalRule` (string)

### LineBlock

A line block, i.e. a list of lines, each separated from the next
by a newline.

content
:   inline content

tag, t
:   the literal `LineBlock` (string)

### Null

A null element; this element never produces any output in the
target format.

tag, t
:   the literal `Null` (string)

### OrderedList

An ordered list.

Parameters:

items
:   list items ([list] of [blocks])

listAttributes
:   list parameters

tag, t
:   the literal `OrderedList` (string)

### Para

A paragraph

content
:   inline content

tag, t
:   the literal `Para` (string)

### Plain

Plain text, not a paragraph

content
:   inline content

tag, t
:   the literal `Plain` (string)

### RawBlock

Raw content of a specified format.

format
:   format of content (string)

text
:   raw content (string)

tag, t
:   the literal `RawBlock` (string)

### Table

A table.

caption:
:   table caption

aligns:
:   alignments

widths:
:   column widths

headers
:   header row

rows:
:   table rows

tag, t
:   the literal `Table` (string)

## Inline

### Cite
Citation

content
:   ([list] of [inlines])

citations
:   citation entries ([list] of [citations])

tag, t
:   the literal `Cite` (string)

### Code
Inline code

text
:   code string (string)

attr
:   attributes ([Attr])

identifier
:   alias for `attr.identifier` (string)

classes
:   alias for `attr.classes` ([list] of strings)

attributes
:   alias for `attr.attributes` ([attributes])

tag, t
:   the literal `Code` (string)

### Emph
Emphasized text

content
:   inline content ([list] of [inlines])

tag, t
:   the literal `Emph` (string)

<!-- TODO -->

### Image
Image:  alt text (list of inlines), target

tag, t
:   the literal `Image` (string)

### Link
Hyperlink: alt text (list of inlines), target

tag, t
:   the literal `Link` (string)

### LineBreak
Hard line break

tag, t
:   the literal `LineBreak` (string)

### Math
TeX math (literal)

tag, t
:   the literal `Math` (string)

### Note
Footnote or endnote

tag, t
:   the literal `Note` (string)

### Quoted
Quoted text (list of inlines)

tag, t
:   the literal `Quoted` (string)

### RawInline
Raw inline

tag, t
:   the literal `RawInline` (string)

### SmallCaps
Small caps text (list of inlines)

tag, t
:   the literal `SmallCaps` (string)

### SoftBreak
Soft line break

tag, t
:   the literal `SoftBreak` (string)

### Space
Inter-word space

tag, t
:   the literal `Space` (string)

### Span
Generic inline container with attributes

attr
:   attributes ([Attr])

identifier
:   alias for `attr.identifier` (string)

classes
:   alias for `attr.classes` ([list] of strings)

attributes
:   alias for `attr.attributes` ([attributes])

tag, t
:   the literal `Span` (string)

### Str
Text (string)

tag, t
:   the literal `Str` (string)

### Strikeout
Strikeout text (list of inlines)

tag, t
:   the literal `Strikeout` (string)

### Strong
Strongly emphasized text (list of inlines)

tag, t
:   the literal `Strong` (string)

### Subscript
Subscripted text (list of inlines)

tag, t
:   the literal `Subscript` (string)

### Superscript
Superscripted text (list of inlines)

tag, t
:   the literal `Superscript` (string)

## Attributes

List of key/value pairs. Values can be accessed by using keys as indices to the
list table.


[block]: #block
[blocks]: #block
[list]: #list
[meta value]: #metavalue
[inline]: #inline
[inlines]: #inline
[Attr]: #attr
[attributes]: #attributes