git.iko.soy/typeable/pandoc
on master help sign in
Lua filters doc: fix and add more links to types
e3b8551Albert Krewinkel
doc/lua-filter-types-and-objects.md+48−45
compare with master
unifiedsplit
@@ -4,8 +4,10 @@
4
4
5## Pandoc
5## Pandoc
6
6
7+Pandoc document
8+
7`blocks`
9`blocks`
8−: document content ([list] of [blocks])
10+: document content ([list] of [Block]s)
9
11
10`meta`
12`meta`
11: document meta information ([Meta] object)
13: document meta information ([Meta] object)
@@ -14,9 +16,7 @@
14## Meta
16## Meta
15
17
16Meta information on a document; string-indexed collection of
18Meta information on a document; string-indexed collection of
17−[meta values](#metavalue). This is represented as a
19+[MetaValue]s.
18−string-indexed table containing [meta values](#MetaValue).
19−
20
20
21## MetaValue
21## MetaValue
22
22
@@ -24,7 +24,7 @@ Document meta information items.
24
24
25### MetaBlocks
25### MetaBlocks
26
26
27−A list of blocks usable as meta value ([list] of [blocks])
27+A list of blocks usable as meta value ([list] of [Block]s)
28
28
29Fields:
29Fields:
30
30
@@ -37,7 +37,7 @@ Plain Lua boolean value (boolean)
37
37
38### MetaInlines
38### MetaInlines
39
39
40−List of inlines used in metadata ([list] of [inline]s)
40+List of inlines used in metadata ([list] of [Inline]s)
41
41
42Fields:
42Fields:
43
43
@@ -46,7 +46,7 @@ Fields:
46
46
47### MetaList
47### MetaList
48
48
49−A list of other [meta value]s. ([list])
49+A list of other [MetaValue]s. ([list])
50
50
51Fields:
51Fields:
52
52
@@ -77,7 +77,7 @@ Plain Lua string value (string)
77A block quote element
77A block quote element
78
78
79content:
79content:
80−: block content ([list] of [blocks])
80+: block content ([list] of [Block]s)
81
81
82`tag`, `t`
82`tag`, `t`
83: the literal `BlockQuote` (string)
83: the literal `BlockQuote` (string)
@@ -87,7 +87,7 @@ content:
87A bullet list
87A bullet list
88
88
89`content`
89`content`
90−: list of items ([list] of [blocks])
90+: list of items ([list] of [Block]s)
91
91
92`tag`, `t`
92`tag`, `t`
93: the literal `BulletList` (string)
93: the literal `BulletList` (string)
@@ -100,7 +100,7 @@ Block of code.
100: code string (string)
100: code string (string)
101
101
102`attr`
102`attr`
103−: element attributes (Attr)
103+: element attributes ([Attr])
104
104
105`identifier`
105`identifier`
106: alias for `attr.identifier` (string)
106: alias for `attr.identifier` (string)
@@ -129,10 +129,10 @@ Definition list, containing terms and their explanation.
129Generic block container with attributes
129Generic block container with attributes
130
130
131`content`
131`content`
132−: block content ([list] of [blocks])
132+: block content ([list] of [Block]s)
133
133
134`attr`
134`attr`
135−: element attributes (Attr)
135+: element attributes ([Attr])
136
136
137`identifier`
137`identifier`
138: alias for `attr.identifier` (string)
138: alias for `attr.identifier` (string)
@@ -154,10 +154,10 @@ Creates a header element.
154: header level (integer)
154: header level (integer)
155
155
156`content`
156`content`
157−: inline content ([list] of [inlines])
157+: inline content ([list] of [Inline]s)
158
158
159`attr`
159`attr`
160−: element attributes (Attr)
160+: element attributes ([Attr])
161
161
162`identifier`
162`identifier`
163: alias for `attr.identifier` (string)
163: alias for `attr.identifier` (string)
@@ -205,10 +205,10 @@ An ordered list.
205Parameters:
205Parameters:
206
206
207`items`
207`items`
208−: list items ([list] of [blocks])
208+: list items ([list] of [Block]s)
209
209
210`listAttributes`
210`listAttributes`
211−: list parameters (ListAttributes)
211+: list parameters ([ListAttributes])
212
212
213`start`
213`start`
214: alias for `listAttributes.start` (integer)
214: alias for `listAttributes.start` (integer)
@@ -227,7 +227,7 @@ Parameters:
227A paragraph
227A paragraph
228
228
229`content`
229`content`
230−: inline content ([list] of [inlines])
230+: inline content ([list] of [Inline]s)
231
231
232`tag`, `t`
232`tag`, `t`
233: the literal `Para` (string)
233: the literal `Para` (string)
@@ -237,7 +237,7 @@ A paragraph
237Plain text, not a paragraph
237Plain text, not a paragraph
238
238
239`content`
239`content`
240−: inline content ([list] of [inlines])
240+: inline content ([list] of [Inline]s)
241
241
242`tag`, `t`
242`tag`, `t`
243: the literal `Plain` (string)
243: the literal `Plain` (string)
@@ -260,7 +260,7 @@ Raw content of a specified format.
260A table.
260A table.
261
261
262`caption`
262`caption`
263−: table caption ([list] of [inlines])
263+: table caption ([list] of [Inline]s)
264
264
265`aligns`
265`aligns`
266: column alignments ([list] of [Alignment]s)
266: column alignments ([list] of [Alignment]s)
@@ -269,30 +269,33 @@ A table.
269: column widths (number)
269: column widths (number)
270
270
271`headers`
271`headers`
272−: header row ([list] of [table cells](#table-cell))
272+: header row ([list] of [table cells])
273
273
274`rows`
274`rows`
275−: table rows ([list] of [list]s of [table cells](#table-cell))
275+: table rows ([list] of [list]s of [table cells])
276
276
277`tag`, `t`
277`tag`, `t`
278: the literal `Table` (string)
278: the literal `Table` (string)
279
279
280A [table cell]{#table-cell} is a list of blocks.
280A [table cell]{#table-cell} is a list of blocks.
281
281
282−[Alignment]{#Alignment} is a string value indicating the
282+*[Alignment]{#Alignment}* is a string value indicating the
283horizontal alignment of a table column. `AlignLeft`,
283horizontal alignment of a table column. `AlignLeft`,
284`AlignRight`, and `AlignCenter` leads cell content tob be
284`AlignRight`, and `AlignCenter` leads cell content tob be
285left-aligned, right-aligned, and centered, respectively. The
285left-aligned, right-aligned, and centered, respectively. The
286default alignment is `AlignDefault` (often equivalent to
286default alignment is `AlignDefault` (often equivalent to
287centered).
287centered).
288
288
289+[Alignment]: #Alignment
290+[table cells]: #table-cell
291+
289## Inline
292## Inline
290
293
291### Cite
294### Cite
292Citation
295Citation
293
296
294`content`
297`content`
295−: ([list] of [inlines])
298+: ([list] of [Inline]s)
296
299
297`citations`
300`citations`
298: citation entries ([list] of [citations])
301: citation entries ([list] of [citations])
@@ -325,7 +328,7 @@ Inline code
325Emphasized text
328Emphasized text
326
329
327`content`
330`content`
328−: inline content ([list] of [inlines])
331+: inline content ([list] of [Inline]s)
329
332
330`tag`, `t`
333`tag`, `t`
331: the literal `Emph` (string)
334: the literal `Emph` (string)
@@ -337,7 +340,7 @@ Image: alt text (list of inlines), target
337: attributes ([Attr])
340: attributes ([Attr])
338
341
339`caption`
342`caption`
340−: text used to describe the image ([list] of [inlines])
343+: text used to describe the image ([list] of [Inline]s)
341
344
342`src`
345`src`
343: path to the image file (string)
346: path to the image file (string)
@@ -370,7 +373,7 @@ Hyperlink: alt text (list of inlines), target
370: attributes ([Attr])
373: attributes ([Attr])
371
374
372`content`
375`content`
373−: text for this link ([list] of [inlines])
376+: text for this link ([list] of [Inline]s)
374
377
375`target`
378`target`
376: the link target (string)
379: the link target (string)
@@ -405,7 +408,7 @@ TeX math (literal)
405Footnote or endnote
408Footnote or endnote
406
409
407`content`
410`content`
408−: ([list] of [blocks])
411+: ([list] of [Block]s)
409
412
410`tag`, `t`
413`tag`, `t`
411: the literal `Note` (string)
414: the literal `Note` (string)
@@ -418,7 +421,7 @@ Quoted text
418 `DoubleQuote` (string)
421 `DoubleQuote` (string)
419
422
420`content`
423`content`
421−: quoted text ([list] of [inlines])
424+: quoted text ([list] of [Inline]s)
422
425
423`tag`, `t`
426`tag`, `t`
424: the literal `Quoted` (string)
427: the literal `Quoted` (string)
@@ -439,7 +442,7 @@ Raw inline
439Small caps text
442Small caps text
440
443
441`content`
444`content`
442−: ([list] of [inlines])
445+: ([list] of [Inline]s)
443
446
444`tag`, `t`
447`tag`, `t`
445: the literal `SmallCaps` (string)
448: the literal `SmallCaps` (string)
@@ -463,7 +466,7 @@ Generic inline container with attributes
463: attributes ([Attr])
466: attributes ([Attr])
464
467
465`content`
468`content`
466−: wrapped content ([list] of [inlines])
469+: wrapped content ([list] of [Inline]s)
467
470
468`identifier`
471`identifier`
469: alias for `attr.identifier` (string)
472: alias for `attr.identifier` (string)
@@ -490,7 +493,7 @@ Text
490Strikeout text
493Strikeout text
491
494
492`content`
495`content`
493−: inline content ([list] of [inlines])
496+: inline content ([list] of [Inline]s)
494
497
495`tag`, `t`
498`tag`, `t`
496: the literal `Strikeout` (string)
499: the literal `Strikeout` (string)
@@ -499,7 +502,7 @@ Strikeout text
499Strongly emphasized text
502Strongly emphasized text
500
503
501`content`
504`content`
502−: inline content ([list] of [inlines])
505+: inline content ([list] of [Inline]s)
503
506
504`tag`, `t`
507`tag`, `t`
505: the literal `Strong` (string)
508: the literal `Strong` (string)
@@ -508,7 +511,7 @@ Strongly emphasized text
508Subscripted text
511Subscripted text
509
512
510`content`
513`content`
511−: inline content ([list] of [inlines])
514+: inline content ([list] of [Inline]s)
512
515
513`tag`, `t`
516`tag`, `t`
514: the literal `Subscript` (string)
517: the literal `Subscript` (string)
@@ -517,7 +520,7 @@ Subscripted text
517Superscripted text
520Superscripted text
518
521
519`content`
522`content`
520−: inline content ([list] of [inlines])
523+: inline content ([list] of [Inline]s)
521
524
522`tag`, `t`
525`tag`, `t`
523: the literal `Superscript` (string)
526: the literal `Superscript` (string)
@@ -554,10 +557,10 @@ Single citation entry
554 `NormalCitation` (string)
557 `NormalCitation` (string)
555
558
556`prefix`
559`prefix`
557−: citation prefix ([list] of [inlines])
560+: citation prefix ([list] of [Inline]s)
558
561
559`suffix`
562`suffix`
560−: citation suffix ([list] of [inlines])
563+: citation suffix ([list] of [Inline]s)
561
564
562`note_num`
565`note_num`
563: note number (integer)
566: note number (integer)
@@ -583,7 +586,7 @@ List attributes
583## Hierarchical Element {#Element}
586## Hierarchical Element {#Element}
584
587
585Hierarchical elements can be either *Sec* (sections) or *Blk*
588Hierarchical elements can be either *Sec* (sections) or *Blk*
586−(blocks). *Blk* elements are treated like [block]s.
589+(blocks). *Blk* elements are treated like [Block]s.
587
590
588### Sec
591### Sec
589
592
@@ -602,14 +605,16 @@ document contents.
602: header attributes ([Attr])
605: header attributes ([Attr])
603
606
604`label`
607`label`
605−: header content ([list] of [inlines])
608+: header content ([list] of [Inline]s)
606
609
607`contents`
610`contents`
608−: list of contents in this section ([list] of hierarchical elements)
611+: list of contents in this section ([list] of [hierarchical element]s)
609
612
610`tag`, `t`
613`tag`, `t`
611: constant `Sec` (string)
614: constant `Sec` (string)
612
615
616+[hierarchical element]: #Element
617+
613## ReaderOptions
618## ReaderOptions
614
619
615Pandoc reader options
620Pandoc reader options
@@ -646,12 +651,10 @@ Pandoc reader options
646: track changes setting for docx; one of `AcceptChanges`,
651: track changes setting for docx; one of `AcceptChanges`,
647 `RejectChanges`, and `AllChanges` (string)
652 `RejectChanges`, and `AllChanges` (string)
648
653
649−[block]: #block
654+[Block]: #Block
650−[blocks]: #block
651−[list]: #list
655+[list]: #List
652−[meta value]: #metavalue
656+[MetaValue]: #MetaValue
653−[inline]: #inline
657+[Inline]: #Inline
654−[inlines]: #inline
655[Attr]: #attr
658[Attr]: #attr
656[Attributes]: #attributes
659[Attributes]: #attributes
657[citations]: #citation
660[citations]: #citation