@@ -141,10 +141,10 @@ elements.
141141Element filter functions within a filter set are called in a
142142fixed order, skipping any which are not present:
143143
144− 1. functions for [*Inline* elements](#type-ref-Inline),
145− 2. functions for [*Block* elements](#type-ref-Block) ,
146− 3. the [*Meta*](#type-ref-Meta) filter function, and last
147− 4. the [*Pandoc*](#type-ref-Meta) filter function.
144+ 1. functions for [*Inline* elements](#type-inline),
145+ 2. functions for [*Block* elements](#type-block) ,
146+ 3. the [`Meta`](#type-meta) filter function, and last
147+ 4. the [`Pandoc`](#type-pandoc) filter function.
148148
149149It is still possible to force a different order by explicitly
150150returning multiple filter sets. For example, if the filter for
@@ -179,13 +179,12 @@ variables.
179179: Table of the options which were provided to the parser.
180180
181181`PANDOC_VERSION`
182−: Contains the pandoc version as a [Version
183− object](#type-ref-Version) which behaves like a numerically
184− indexed table, most significant number first. E.g., for
185− pandoc 2.7.3, the value of the variable is equivalent to a
186− table `{2, 7, 3}`. Use `tostring(PANDOC_VERSION)` to produce
187− a version string. This variable is also set in custom
188− writers.
182+: Contains the pandoc version as a [Version] object which
183+ behaves like a numerically indexed table, most significant
184+ number first. E.g., for pandoc 2.7.3, the value of the
185+ variable is equivalent to a table `{2, 7, 3}`. Use
186+ `tostring(PANDOC_VERSION)` to produce a version string. This
187+ variable is also set in custom writers.
189188
190189`PANDOC_API_VERSION`
191190: Contains the version of the pandoc-types API against which
@@ -204,7 +203,7 @@ variables.
204203`PANDOC_STATE`
205204: The state shared by all readers and writers. It is used by
206205 pandoc to collect and pass information. The value of this
207− variable is of type [CommonState](#type-ref-CommonState) and
206+ variable is of type [CommonState] and
208207 is read-only.
209208
210209# Pandoc Module
@@ -233,12 +232,12 @@ those elements accessible through the filter function parameter.
233232
234233Some pandoc functions have been made available in lua:
235234
236−- [`walk_block`](#walk_block) and
237− [`walk_inline`](#walk_inline) allow filters to be applied
235+- [`walk_block`](#pandoc.walk_block) and
236+ [`walk_inline`](#pandoc.walk_inline) allow filters to be applied
238237 inside specific block or inline elements;
239−- [`read`](#read) allows filters to parse strings into pandoc
238+- [`read`](#pandoc.read) allows filters to parse strings into pandoc
240239 documents;
241−- [`pipe`](#pipe) runs an external command with input from and
240+- [`pipe`](#pandoc.pipe) runs an external command with input from and
242241 output to strings;
243242- the [`pandoc.mediabag`](#module-pandoc.mediabag) module
244243 allows access to the "mediabag," which stores binary content
@@ -573,10 +572,10 @@ function CodeBlock(block)
573572end
574573```
575574
576−## Building images with tikz
575+## Building images with Ti*k*Z
577576
578−This filter converts raw LaTeX tikz environments into images. It
579−works with both PDF and HTML output. The tikz code is compiled
577+This filter converts raw LaTeX Ti*k*Z environments into images. It
578+works with both PDF and HTML output. The Ti*k*Z code is compiled
580579to an image using `pdflatex`, and the image is converted from
581580pdf to svg format using
582581[`pdf2svg`](https://github.com/dawbarton/pdf2svg), so both of
@@ -666,7 +665,7 @@ Example of use:
666665# Lua type reference
667666
668667This section describes the types of objects available to Lua
669−filters. See the [pandoc module](#module-pandoc%7D) for
668+filters. See the [pandoc module](#module-pandoc) for
670669functions to create these objects.
671670
672671## Shared Properties
@@ -683,70 +682,63 @@ Usage:
683682 local emph = pandoc.Emph {pandoc.Str 'important'}
684683 local cloned_emph = emph:clone() -- note the colon
685684
686−## Pandoc {#type-ref-pandoc}
685+## Pandoc {#type-pandoc}
687686
688687Pandoc document
689688
690−Object equality is determined via
691−[`pandoc.utils.equals`](#utils-equals).
689+Object equality is determined via [`pandoc.utils.equals`].
692690
693691`blocks`
694−: document content ([List](#module-pandoc.list) of
695− [Block](#type-ref-Block)s)
692+: document content ([List] of [Blocks])
696693
697694`meta`
698−: document meta information ([Meta](#Meta) object)
695+: document meta information ([Meta] object)
699696
700−## Meta {#type-ref-meta}
697+## Meta {#type-meta}
701698
702699Meta information on a document; string-indexed collection of
703−[MetaValue](#type-ref-MetaValue)s.
700+[MetaValues].
704701
705−Object equality is determined via
706−[`pandoc.utils.equals`](#utils-equals).
702+Object equality is determined via [`pandoc.utils.equals`].
707703
708−## MetaValue {#type-ref-MetaValue}
704+## MetaValue {#type-metavalue}
709705
710706Document meta information items.
711707
712−Object equality is determined via
713−[`pandoc.utils.equals`](#utils-equals).
708+Object equality is determined via [`pandoc.utils.equals`].
714709
715−### MetaBlocks {#type-ref-MetaBlocks}
710+### MetaBlocks {#type-metablocks}
716711
717−A list of blocks usable as meta value
718−([List](#module-pandoc.list) of [Block](#type-ref-Block)s)
712+A list of blocks usable as meta value ([List] of [Blocks])
719713
720714Fields:
721715
722716`tag`, `t`
723717: the literal `MetaBlocks` (string)
724718
725−### MetaBool {#type-ref-MetaBool}
719+### MetaBool {#type-metabool}
726720
727721Plain Lua boolean value (boolean)
728722
729−### MetaInlines {#type-ref-MetaInlines}
723+### MetaInlines {#type-metainlines}
730724
731−List of inlines used in metadata ([List](#module-pandoc.list) of
732−[Inline](#type-ref-Inline)s)
725+List of inlines used in metadata ([List] of [Inlines])
733726
734727Fields:
735728
736729`tag`, `t`
737730: the literal `MetaInlines` (string)
738731
739−### MetaList {#type-ref-iMetaList}
732+### MetaList {#type-metalist}
740733
741−A list of other [MetaValue](#type-ref-MetaValue)s.
742−([List](#module-pandoc.list))
734+A list of other [MetaValues]. ([List] of [MetaValues])
743735
744736Fields:
745737
746738`tag`, `t`
747739: the literal `MetaList` (string)
748740
749−### MetaMap {#type-ref-MetaMap}
741+### MetaMap {#type-metamap}
750742
751743A string-indexed map of meta-values. (table)
752744
@@ -758,38 +750,35 @@ Fields:
758750*Note*: The fields will be shadowed if the map contains a field
759751with the same name as those listed.
760752
761−### MetaString {#type-ref-MetaString}
753+### MetaString {#type-metastring}
762754
763755Plain Lua string value (string)
764756
765−## Block {#type-ref-Block}
757+## Block {#type-block}
766758
767−Object equality is determined via
768−[`pandoc.utils.equals`](#utils-equals).
759+Object equality is determined via [`pandoc.utils.equals`].
769760
770−### BlockQuote {#type-ref-BlockQuote}
761+### BlockQuote {#type-blockquote}
771762
772763A block quote element
773764
774765content:
775−: block content ([List](#module-pandoc.list) of
776− [Block](#type-ref-Block)s)
766+: block content ([List] of [Blocks])
777767
778768`tag`, `t`
779769: the literal `BlockQuote` (string)
780770
781−### BulletList {#type-ref-BulletList}
771+### BulletList {#type-bulletlist}
782772
783773A bullet list
784774
785775`content`
786−: list of items ([List](#module-pandoc.list) of
787− [Block](#type-ref-Block)s)
776+: list of items ([List] of [Blocks])
788777
789778`tag`, `t`
790779: the literal `BulletList` (string)
791780
792−### CodeBlock {#type-ref-CodeBlock}
781+### CodeBlock {#type-codeblock}
793782
794783Block of code.
795784
@@ -797,23 +786,21 @@ Block of code.
797786: code string (string)
798787
799788`attr`
800−: element attributes ([Attr](#type-ref-Attr))
789+: element attributes ([Attr])
801790
802791`identifier`
803792: alias for `attr.identifier` (string)
804793
805794`classes`
806−: alias for `attr.classes` ([List](#module-pandoc.list) of
807− strings)
795+: alias for `attr.classes` ([List] of strings)
808796
809797`attributes`
810−: alias for `attr.attributes`
811− ([Attributes](#type-ref-Attributes))
798+: alias for `attr.attributes` ([Attributes])
812799
813800`tag`, `t`
814801: the literal `CodeBlock` (string)
815802
816−### DefinitionList {#type-ref-DefinitionList}
803+### DefinitionList {#type-definitionlist}
817804
818805Definition list, containing terms and their explanation.
819806
@@ -823,32 +810,30 @@ Definition list, containing terms and their explanation.
823810`tag`, `t`
824811: the literal `DefinitionList` (string)
825812
826−### Div {#type-ref-Div}
813+### Div {#type-div}
827814
828815Generic block container with attributes
829816
830817`content`
831−: block content ([List](#module-pandoc.list) of
832− [Block](#type-ref-Block)s)
818+: block content ([List] of [Blocks])
833819
834820`attr`
835−: element attributes ([Attr](#type-ref-Attr))
821+: element attributes ([Attr])
836822
837823`identifier`
838824: alias for `attr.identifier` (string)
839825
840826`classes`
841−: alias for `attr.classes` ([List](#module-pandoc.list) of
827+: alias for `attr.classes` ([List] of
842828 strings)
843829
844830`attributes`
845−: alias for `attr.attributes`
846− ([Attributes](#type-ref-Attributes))
831+: alias for `attr.attributes` ([Attributes])
847832
848833`tag`, `t`
849834: the literal `Div` (string)
850835
851−### Header {#type-ref-Header}
836+### Header {#type-header}
852837
853838Creates a header element.
854839
@@ -856,34 +841,32 @@ Creates a header element.
856841: header level (integer)
857842
858843`content`
859−: inline content ([List](#module-pandoc.list) of
860− [Inline](#type-ref-Inline)s)
844+: inline content ([List] of [Inlines])
861845
862846`attr`
863−: element attributes ([Attr](#type-ref-Attr))
847+: element attributes ([Attr])
864848
865849`identifier`
866850: alias for `attr.identifier` (string)
867851
868852`classes`
869−: alias for `attr.classes` ([List](#module-pandoc.list) of
870− strings)
853+: alias for `attr.classes` ([List] of strings)
871854
872855`attributes`
873856: alias for `attr.attributes`
874− ([Attributes](#type-ref-Attributes))
857+ ([Attributes])
875858
876859`tag`, `t`
877860: the literal `Header` (string)
878861
879−### HorizontalRule {#type-ref-HorizontalRule}
862+### HorizontalRule {#type-horizontalrule}
880863
881864A horizontal rule.
882865
883866`tag`, `t`
884867: the literal `HorizontalRule` (string)
885868
886−### LineBlock {#type-ref-LineBlock}
869+### LineBlock {#type-lineblock}
887870
888871A line block, i.e. a list of lines, each separated from the next
889872by a newline.
@@ -894,7 +877,7 @@ by a newline.
894877`tag`, `t`
895878: the literal `LineBlock` (string)
896879
897−### Null {#type-ref-Null}
880+### Null {#type-null}
898881
899882A null element; this element never produces any output in the
900883target format.
@@ -902,16 +885,15 @@ target format.
902885`tag`, `t`
903886: the literal `Null` (string)
904887
905−### OrderedList {#type-ref-OrderedList}
888+### OrderedList {#type-orderedlist}
906889
907890An ordered list.
908891
909892`content`
910−: list items ([List](#module-pandoc.list) of
911− [Block](#type-ref-Block)s)
893+: list items ([List] of [List] of [Blocks])
912894
913895`listAttributes`
914−: list parameters ([ListAttributes](#ListAttributes))
896+: list parameters ([ListAttributes])
915897
916898`start`
917899: alias for `listAttributes.start` (integer)
@@ -925,29 +907,27 @@ An ordered list.
925907`tag`, `t`
926908: the literal `OrderedList` (string)
927909
928−### Para {#type-ref-Para}
910+### Para {#type-para}
929911
930912A paragraph
931913
932914`content`
933−: inline content ([List](#module-pandoc.list) of
934− [Inline](#type-ref-Inline)s)
915+: inline content ([List] of [Inlines])
935916
936917`tag`, `t`
937918: the literal `Para` (string)
938919
939−### Plain {#type-ref-Plain}
920+### Plain {#type-plain}
940921
941922Plain text, not a paragraph
942923
943924`content`
944−: inline content ([List](#module-pandoc.list) of
945− [Inline](#type-ref-Inline)s)
925+: inline content ([List] of [Inlines])
946926
947927`tag`, `t`
948928: the literal `Plain` (string)
949929
950−### RawBlock {#type-ref-RawBlock}
930+### RawBlock {#type-rawblock}
951931
952932Raw content of a specified format.
953933
@@ -960,62 +940,56 @@ Raw content of a specified format.
960940`tag`, `t`
961941: the literal `RawBlock` (string)
962942
963−### Table {#type-ref-Table}
943+### Table {#type-table}
964944
965945A table.
966946
967947`caption`
968−: table caption ([List](#module-pandoc.list) of
969− [Inline](#type-ref-Inline)s)
948+: table caption ([List] of [Inlines])
970949
971950`aligns`
972−: column alignments ([List](#module-pandoc.list) of
973− [Alignment](#type-ref-Alignment)s)
951+: column alignments ([List] of [Alignment]s)
974952
975953`widths`
976954: column widths (number)
977955
978956`headers`
979−: header row ([List](#module-pandoc.list) of [table
980− cells](#type-ref-table-cell))
957+: header row ([List] of [table cells](#type-table-cell))
981958
982959`rows`
983−: table rows ([List](#module-pandoc.list) of
984− [List](#module-pandoc.list)s of [table
985− cells](#type-ref-table-cell))
960+: table rows ([List] of [List]s of [table
961+ cells](#type-table-cell))
986962
987963`tag`, `t`
988964: the literal `Table` (string)
989965
990−A [table cell]{#table-cell} is a list of blocks.
966+A [table cell]{#type-table-cell} is a list of blocks.
991967
992−*[Alignment]{#Alignment}* is a string value indicating the
968+*[Alignment]{#type-alignment}* is a string value indicating the
993969horizontal alignment of a table column. `AlignLeft`,
994970`AlignRight`, and `AlignCenter` leads cell content tob be
995971left-aligned, right-aligned, and centered, respectively. The
996972default alignment is `AlignDefault` (often equivalent to
997973centered).
998974
999−## Inline {#type-ref-Inline}
975+## Inline {#type-inline}
1000976
1001−Object equality is determined via
1002−[`pandoc.utils.equals`](#utils-equals).
977+Object equality is determined via [`pandoc.utils.equals`].
1003978
1004−### Cite {#type-ref-Cite}
979+### Cite {#type-cite}
1005980
1006981Citation
1007982
1008983`content`
1009−: ([List](#module-pandoc.list) of [Inline](#type-ref-Inline)s)
984+: ([List] of [Inlines])
1010985
1011986`citations`
1012−: citation entries ([List](#module-pandoc.list) of
1013− [citations](#type-ref-Citation))
987+: citation entries ([List] of [Citations])
1014988
1015989`tag`, `t`
1016990: the literal `Cite` (string)
1017991
1018−### Code {#type-ref-Code}
992+### Code {#type-code}
1019993
1020994Inline code
1021995
@@ -1023,43 +997,39 @@ Inline code
1023997: code string (string)
1024998
1025999`attr`
1026−: attributes ([Attr](#type-ref-Attr))
1000+: attributes ([Attr])
10271001
10281002`identifier`
10291003: alias for `attr.identifier` (string)
10301004
10311005`classes`
1032−: alias for `attr.classes` ([List](#module-pandoc.list) of
1033− strings)
1006+: alias for `attr.classes` ([List] of strings)
10341007
10351008`attributes`
1036−: alias for `attr.attributes`
1037− ([Attributes](#type-ref-Attributes))
1009+: alias for `attr.attributes` ([Attributes])
10381010
10391011`tag`, `t`
10401012: the literal `Code` (string)
10411013
1042−### Emph {#type-ref-Emph}
1014+### Emph {#type-emph}
10431015
10441016Emphasized text
10451017
10461018`content`
1047−: inline content ([List](#module-pandoc.list) of
1048− [Inline](#type-ref-Inline)s)
1019+: inline content ([List] of [Inlines])
10491020
10501021`tag`, `t`
10511022: the literal `Emph` (string)
10521023
1053−### Image {#type-ref-Image}
1024+### Image {#type-image}
10541025
10551026Image: alt text (list of inlines), target
10561027
10571028`attr`
1058−: attributes ([Attr](#type-ref-Attr))
1029+: attributes ([Attr])
10591030
10601031`caption`
1061−: text used to describe the image ([List](#module-pandoc.list)
1062− of [Inline](#type-ref-Inline)s)
1032+: text used to describe the image ([List] of [Inlines])
10631033
10641034`src`
10651035: path to the image file (string)
@@ -1071,33 +1041,30 @@ Image: alt text (list of inlines), target
10711041: alias for `attr.identifier` (string)
10721042
10731043`classes`
1074−: alias for `attr.classes` ([List](#module-pandoc.list) of
1075− strings)
1044+: alias for `attr.classes` ([List] of strings)
10761045
10771046`attributes`
1078−: alias for `attr.attributes`
1079− ([Attributes](#type-ref-Attributes))
1047+: alias for `attr.attributes` ([Attributes])
10801048
10811049`tag`, `t`
10821050: the literal `Image` (string)
10831051
1084−### LineBreak {#type-ref-LineBreak}
1052+### LineBreak {#type-linebreak}
10851053
10861054Hard line break
10871055
10881056`tag`, `t`
10891057: the literal `LineBreak` (string)
10901058
1091−### Link {#type-ref-Link}
1059+### Link {#type-link}
10921060
10931061Hyperlink: alt text (list of inlines), target
10941062
10951063`attr`
1096−: attributes ([Attr](#type-ref-Attr))
1064+: attributes ([Attr])
10971065
10981066`content`
1099−: text for this link ([List](#module-pandoc.list) of
1100− [Inline](#type-ref-Inline)s)
1067+: text for this link ([List] of [Inlines])
11011068
11021069`target`
11031070: the link target (string)
@@ -1106,17 +1073,15 @@ Hyperlink: alt text (list of inlines), target
11061073: alias for `attr.identifier` (string)
11071074
11081075`classes`
1109−: alias for `attr.classes` ([List](#module-pandoc.list) of
1110− strings)
1076+: alias for `attr.classes` ([List] of strings)
11111077
11121078`attributes`
1113−: alias for `attr.attributes`
1114− ([Attributes](#type-ref-Attributes))
1079+: alias for `attr.attributes` ([Attributes])
11151080
11161081`tag`, `t`
11171082: the literal `Link` (string)
11181083
1119−### Math {#type-ref-Math}
1084+### Math {#type-math}
11201085
11211086TeX math (literal)
11221087
@@ -1131,17 +1096,17 @@ TeX math (literal)
11311096`tag`, `t`
11321097: the literal `Math` (string)
11331098
1134−### Note {#type-ref-Note}
1099+### Note {#type-note}
11351100
11361101Footnote or endnote
11371102
11381103`content`
1139−: ([List](#module-pandoc.list) of [Block](#type-ref-Block)s)
1104+: ([List] of [Blocks])
11401105
11411106`tag`, `t`
11421107: the literal `Note` (string)
11431108
1144−### Quoted {#type-ref-Quoted}
1109+### Quoted {#type-quoted}
11451110
11461111Quoted text
11471112
@@ -1150,13 +1115,12 @@ Quoted text
11501115 `DoubleQuote` (string)
11511116
11521117`content`
1153−: quoted text ([List](#module-pandoc.list) of
1154− [Inline](#type-ref-Inline)s)
1118+: quoted text ([List] of [Inlines])
11551119
11561120`tag`, `t`
11571121: the literal `Quoted` (string)
11581122
1159−### RawInline {#type-ref-RawInline}
1123+### RawInline {#type-rawinline}
11601124
11611125Raw inline
11621126
@@ -1169,56 +1133,53 @@ Raw inline
11691133`tag`, `t`
11701134: the literal `RawInline` (string)
11711135
1172−### SmallCaps {#type-ref-SmallCaps}
1136+### SmallCaps {#type-smallcaps}
11731137
11741138Small caps text
11751139
11761140`content`
1177−: ([List](#module-pandoc.list) of [Inline](#type-ref-Inline)s)
1141+: ([List] of [Inlines])
11781142
11791143`tag`, `t`
11801144: the literal `SmallCaps` (string)
11811145
1182−### SoftBreak {#type-ref-SoftBreak}
1146+### SoftBreak {#type-softbreak}
11831147
11841148Soft line break
11851149
11861150`tag`, `t`
11871151: the literal `SoftBreak` (string)
11881152
1189−### Space {#type-ref-Space}
1153+### Space {#type-space}
11901154
11911155Inter-word space
11921156
11931157`tag`, `t`
11941158: the literal `Space` (string)
11951159
1196−### Span {#type-ref-Span}
1160+### Span {#type-span}
11971161
11981162Generic inline container with attributes
11991163
12001164`attr`
1201−: attributes ([Attr](#type-ref-Attr))
1165+: attributes ([Attr])
12021166
12031167`content`
1204−: wrapped content ([List](#module-pandoc.list) of
1205− [Inline](#type-ref-Inline)s)
1168+: wrapped content ([List] of [Inlines])
12061169
12071170`identifier`
12081171: alias for `attr.identifier` (string)
12091172
12101173`classes`
1211−: alias for `attr.classes` ([List](#module-pandoc.list) of
1212− strings)
1174+: alias for `attr.classes` ([List] of strings)
12131175
12141176`attributes`
1215−: alias for `attr.attributes`
1216− ([Attributes](#type-ref-Attributes))
1177+: alias for `attr.attributes` ([Attributes])
12171178
12181179`tag`, `t`
12191180: the literal `Span` (string)
12201181
1221−### Str {#type-ref-Str}
1182+### Str {#type-str}
12221183
12231184Text
12241185
@@ -1228,60 +1189,56 @@ Text
12281189`tag`, `t`
12291190: the literal `Str` (string)
12301191
1231−### Strikeout {#type-ref-Strikeout}
1192+### Strikeout {#type-strikeout}
12321193
12331194Strikeout text
12341195
12351196`content`
1236−: inline content ([List](#module-pandoc.list) of
1237− [Inline](#type-ref-Inline)s)
1197+: inline content ([List] of [Inlines])
12381198
12391199`tag`, `t`
12401200: the literal `Strikeout` (string)
12411201
1242−### Strong {#type-ref-Strong}
1202+### Strong {#type-strong}
12431203
12441204Strongly emphasized text
12451205
12461206`content`
1247−: inline content ([List](#module-pandoc.list) of
1248− [Inline](#type-ref-Inline)s)
1207+: inline content ([List] of [Inlines])
12491208
12501209`tag`, `t`
12511210: the literal `Strong` (string)
12521211
1253−### Subscript {#type-ref-Subscript}
1212+### Subscript {#type-subscript}
12541213
12551214Subscripted text
12561215
12571216`content`
1258−: inline content ([List](#module-pandoc.list) of
1259− [Inline](#type-ref-Inline)s)
1217+: inline content ([List] of [Inlines])
12601218
12611219`tag`, `t`
12621220: the literal `Subscript` (string)
12631221
1264−### Superscript {#type-ref-Superscript}
1222+### Superscript {#type-superscript}
12651223
12661224Superscripted text
12671225
12681226`content`
1269−: inline content ([List](#module-pandoc.list) of
1270− [Inline](#type-ref-Inline)s)
1227+: inline content ([List] of [Inlines])
12711228
12721229`tag`, `t`
12731230: the literal `Superscript` (string)
12741231
12751232## Element components
12761233
1277−### Attr {#type-ref-Attr}
1234+### Attr {#type-attr}
12781235
12791236A set of element attributes. Values of this type can be created
1280−with the [`pandoc.Attr`](#Attr) constructor. For convenience, it
1281−is usually not necessary to construct the value directly if it is
1282−part of an element, and it is sufficient to pass an HTML-like
1283−table. E.g., to create a span with identifier "text" and classes
1284−"a" and "b", on can write:
1237+with the [`pandoc.Attr`](#pandoc.attr) constructor. For
1238+convenience, it is usually not necessary to construct the value
1239+directly if it is part of an element, and it is sufficient to
1240+pass an HTML-like table. E.g., to create a span with identifier
1241+"text" and classes "a" and "b", on can write:
12851242
12861243 local span = pandoc.Span('text', {id = 'text', class = 'a b'})
12871244
@@ -1290,30 +1247,27 @@ This also works when using the `attr` setter:
12901247 local span = pandoc.Span 'text'
12911248 span.attr = {id = 'text', class = 'a b', other_attribute = '1'}
12921249
1293−Object equality is determined via
1294−[`pandoc.utils.equals`](#utils-equals).
1250+Object equality is determined via [`pandoc.utils.equals`].
12951251
12961252`identifier`
12971253: element identifier (string)
12981254
12991255`classes`
1300−: element classes ([List](#module-pandoc.list) of strings)
1256+: element classes ([List] of strings)
13011257
13021258`attributes`
1303−: collection of key/value pairs
1304− ([Attributes](#type-ref-Attributes))
1259+: collection of key/value pairs ([Attributes])
13051260
1306−### Attributes {#type-ref-Attributes}
1261+### Attributes {#type-attributes}
13071262
13081263List of key/value pairs. Values can be accessed by using keys as
13091264indices to the list table.
13101265
1311−### Citation {#type-ref-Citation}
1266+### Citation {#type-citation}
13121267
13131268Single citation entry
13141269
1315−Object equality is determined via
1316−[`pandoc.utils.equals`](#utils-equals).
1270+Object equality is determined via [`pandoc.utils.equals`].
13171271
13181272`id`
13191273: citation identifier, e.g., a bibtex key (string)
@@ -1323,12 +1277,10 @@ Object equality is determined via
13231277 `NormalCitation` (string)
13241278
13251279`prefix`
1326−: citation prefix ([List](#module-pandoc.list) of
1327− [Inline](#type-ref-Inline)s)
1280+: citation prefix ([List] of [Inlines])
13281281
13291282`suffix`
1330−: citation suffix ([List](#module-pandoc.list) of
1331− [Inline](#type-ref-Inline)s)
1283+: citation suffix ([List] of [Inlines])
13321284
13331285`note_num`
13341286: note number (integer)
@@ -1336,12 +1288,11 @@ Object equality is determined via
13361288`hash`
13371289: hash (integer)
13381290
1339−### ListAttributes {#type-ref-ListAttributes}
1291+### ListAttributes {#type-listattributes}
13401292
13411293List attributes
13421294
1343−Object equality is determined via
1344−[`pandoc.utils.equals`](#utils-equals).
1295+Object equality is determined via [`pandoc.utils.equals`].
13451296
13461297`start`
13471298: number of the first list item (integer)
@@ -1355,7 +1306,7 @@ Object equality is determined via
13551306: delimiter of list numbers; one of `DefaultDelim`, `Period`,
13561307 `OneParen`, and `TwoParens` (string)
13571308
1358−## ReaderOptions {#type-ref-ReaderOptions}
1309+## ReaderOptions {#type-readeroptions}
13591310
13601311Pandoc reader options
13611312
@@ -1391,22 +1342,21 @@ Pandoc reader options
13911342: track changes setting for docx; one of `AcceptChanges`,
13921343 `RejectChanges`, and `AllChanges` (string)
13931344
1394−## CommonState {#type-ref-CommonState}
1345+## CommonState {#type-commonstate}
13951346
13961347The state used by pandoc to collect information and make it
13971348available to readers and writers.
13981349
13991350`input_files`
14001351: List of input files from command line
1401− ([List](#module-pandoc.list) of strings)
1352+ ([List] of strings)
14021353
14031354`output_file`
14041355: Output file from command line (string or nil)
14051356
14061357`log`
1407−: A list of log messages in reverse order
1408− ([List](#module-pandoc.list) of
1409− [LogMessage](#type-ref-LogMessage)s)
1358+: A list of log messages in reverse order ([List] of
1359+ [LogMessage]s)
14101360
14111361`request_headers`
14121362: Headers to add for HTTP requests; table with header names as
@@ -1414,7 +1364,7 @@ available to readers and writers.
14141364
14151365`resource_path`
14161366: Path to search for resources like included images
1417− ([List](#module-pandoc.list) of strings)
1367+ ([List] of strings)
14181368
14191369`source_url`
14201370: Absolute URL or directory of first source file (string or
@@ -1429,12 +1379,23 @@ available to readers and writers.
14291379`verbosity`
14301380: Verbosity level; one of `INFO`, `WARNING`, `ERROR` (string)
14311381
1432−## LogMessage {#type-ref-LogMessage}
1382+## List {#type-list}
1383+
1384+A list is any Lua table with integer indices. Indices start at
1385+one, so if `alist = {'value'}` then `alist[1] == 'value'`.
1386+
1387+Lists, when part of an element, or when generated during
1388+marshalling, are made instances of the `pandoc.List` type for
1389+convenience. The `pandoc.List` type is defined in the
1390+[*pandoc.List*](#module-pandoc.list) module. See there for
1391+available methods.
14331392
1434−A pandoc log message. Object have no fields, but can be
1393+## LogMessage {#type-logmessage}
1394+
1395+A pandoc log message. Objects have no fields, but can be
14351396converted to a string via `tostring`.
14361397
1437−## Version {#type-ref-Version}
1398+## Version {#type-version}
14381399
14391400A version object. This represents a software version like
14401401"2.7.3". The object behaves like a numerically indexed table,
@@ -1460,10 +1421,10 @@ than the expected version.
14601421Parameters:
14611422
14621423`actual`
1463−: actual version specifier ([Version](#type-ref-Version))
1424+: actual version specifier ([Version])
14641425
14651426`expected`
1466−: minimum expected version ([Version](#type-ref-Version))
1427+: minimum expected version ([Version])
14671428
14681429`error_message`
14691430: optional error message template. The string is used as
@@ -1479,6 +1440,26 @@ Usage:
14791440 'pandoc-types is too old: expected version %s, got %s'
14801441 )
14811442
1443+[Alignment]: #type-alignment
1444+[Attr]: #type-attr
1445+[Attributes]: #type-attributes
1446+[Block]: #type-block
1447+[Blocks]: #type-block
1448+[Citation]: #type-citation
1449+[Citations]: #type-citation
1450+[CommonState]: #type-commonstate
1451+[Inline]: #type-inline
1452+[Inlines]: #type-inline
1453+[List]: #type-list
1454+[ListAttributes]: #type-listattributes
1455+[Meta]: #type-meta
1456+[MetaValue]: #type-metavalue
1457+[MetaValues]: #type-metavalue
1458+[LogMessage]: #type-logmessage
1459+[Pandoc]: #type-pandoc
1460+[Version]: #type-version
1461+[`pandoc.utils.equals`]: #pandoc.utils.equals
1462+
14821463# Module text
14831464
14841465UTF-8 aware text manipulation functions, implemented in Haskell.
@@ -1494,31 +1475,31 @@ function Str (s)
14941475end
14951476```
14961477
1497−### lower {#text-lower}
1478+### lower {#text.lower}
14981479
14991480`lower (s)`
15001481
15011482Returns a copy of a UTF-8 string, converted to lowercase.
15021483
1503−### upper {#text-upper}
1484+### upper {#text.upper}
15041485
15051486`upper (s)`
15061487
15071488Returns a copy of a UTF-8 string, converted to uppercase.
15081489
1509−### reverse {#text-reverse}
1490+### reverse {#text.reverse}
15101491
15111492`reverse (s)`
15121493
15131494Returns a copy of a UTF-8 string, with characters reversed.
15141495
1515−### len {#text-len}
1496+### len {#text.len}
15161497
15171498`len (s)`
15181499
15191500Returns the length of a UTF-8 string.
15201501
1521−### sub {#text-sub}
1502+### sub {#text.sub}
15221503
15231504`sub (s)`
15241505
@@ -1527,11 +1508,13 @@ indexing rules.
15271508
15281509# Module pandoc
15291510
1530−Lua functions for pandoc scripts.
1511+Lua functions for pandoc scripts; includes constructors for
1512+document tree elements, functions to parse text in a given
1513+format, and functions to filter and modify a subtree.
15311514
1532−## Pandoc Document
1515+## Pandoc
15331516
1534−[`Pandoc (blocks[, meta])`]{#Pandoc}
1517+[`Pandoc (blocks[, meta])`]{#pandoc.pandoc}
15351518
15361519: A complete pandoc document
15371520
@@ -1543,9 +1526,9 @@ Lua functions for pandoc scripts.
15431526 `meta`:
15441527 : document meta data
15451528
1546−## Meta {#meta}
1529+## Meta
15471530
1548−[`Meta (table)`]{#Meta}
1531+[`Meta (table)`]{#pando.meta}
15491532
15501533: Create a new Meta object.
15511534
@@ -1554,9 +1537,9 @@ Lua functions for pandoc scripts.
15541537 `table`:
15551538 : table containing document meta information
15561539
1557−## MetaValue {#metavalue}
1540+## MetaValue
15581541
1559−[`MetaBlocks (blocks)`]{#MetaBlocks}
1542+[`MetaBlocks (blocks)`]{#pandoc.metablocks}
15601543
15611544: Meta blocks
15621545
@@ -1565,7 +1548,7 @@ Lua functions for pandoc scripts.
15651548 `blocks`:
15661549 : blocks
15671550
1568−[`MetaInlines (inlines)`]{#MetaInlines}
1551+[`MetaInlines (inlines)`]{#pandoc.metainlines}
15691552
15701553: Meta inlines
15711554
@@ -1574,7 +1557,7 @@ Lua functions for pandoc scripts.
15741557 `inlines`:
15751558 : inlines
15761559
1577−[`MetaList (meta_values)`]{#MetaList}
1560+[`MetaList (meta_values)`]{#pandoc.metalist}
15781561
15791562: Meta list
15801563
@@ -1583,7 +1566,7 @@ Lua functions for pandoc scripts.
15831566 `meta_values`:
15841567 : list of meta values
15851568
1586−[`MetaMap (key_value_map)`]{#MetaMap}
1569+[`MetaMap (key_value_map)`]{#pandoc.metamap}
15871570
15881571: Meta map
15891572
@@ -1592,7 +1575,7 @@ Lua functions for pandoc scripts.
15921575 `key_value_map`:
15931576 : a string-indexed map of meta values
15941577
1595−[`MetaString (str)`]{#MetaString}
1578+[`MetaString (str)`]{#pandoc.metastring}
15961579
15971580: Creates string to be used in meta data.
15981581
@@ -1601,7 +1584,7 @@ Lua functions for pandoc scripts.
16011584 `str`:
16021585 : string value
16031586
1604−[`MetaBool (bool)`]{#MetaBool}
1587+[`MetaBool (bool)`]{#pandoc.metabool}
16051588
16061589: Creates boolean to be used in meta data.
16071590
@@ -1612,11 +1595,7 @@ Lua functions for pandoc scripts.
16121595
16131596## Blocks
16141597
1615−[`Block`]{#Block}
1616−
1617−: Block elements
1618−
1619−[`BlockQuote (content)`]{#BlockQuote}
1598+[`BlockQuote (content)`]{#pandoc.blockquote}
16201599
16211600: Creates a block quote element
16221601
@@ -1627,7 +1606,7 @@ Lua functions for pandoc scripts.
16271606
16281607 Returns: block quote element
16291608
1630−[`BulletList (content)`]{#BulletList}
1609+[`BulletList (content)`]{#pandoc.bulletlist}
16311610
16321611: Creates a bullet (i.e.
16331612
@@ -1638,7 +1617,7 @@ Lua functions for pandoc scripts.
16381617
16391618 Returns: bullet list element
16401619
1641−[`CodeBlock (text[, attr])`]{#CodeBlock}
1620+[`CodeBlock (text[, attr])`]{#pandoc.codeblock}
16421621
16431622: Creates a code block element
16441623
@@ -1652,7 +1631,7 @@ Lua functions for pandoc scripts.
16521631
16531632 Returns: code block element
16541633
1655−[`DefinitionList (content)`]{#DefinitionList}
1634+[`DefinitionList (content)`]{#pandoc.definitionlist}
16561635
16571636: Creates a definition list, containing terms and their
16581637 explanation.
@@ -1664,7 +1643,7 @@ Lua functions for pandoc scripts.
16641643
16651644 Returns: definition list element
16661645
1667−[`Div (content[, attr])`]{#Div}
1646+[`Div (content[, attr])`]{#pandoc.div}
16681647
16691648: Creates a div element
16701649
@@ -1678,7 +1657,7 @@ Lua functions for pandoc scripts.
16781657
16791658 Returns: div element
16801659
1681−[`Header (level, content[, attr])`]{#Header}
1660+[`Header (level, content[, attr])`]{#pandoc.header}
16821661
16831662: Creates a header element.
16841663
@@ -1695,13 +1674,13 @@ Lua functions for pandoc scripts.
16951674
16961675 Returns: header element
16971676
1698−[`HorizontalRule ()`]{#HorizontalRule}
1677+[`HorizontalRule ()`]{#pandoc.horizontalrule}
16991678
17001679: Creates a horizontal rule.
17011680
17021681 Returns: horizontal rule
17031682
1704−[`LineBlock (content)`]{#LineBlock}
1683+[`LineBlock (content)`]{#pandoc.lineblock}
17051684
17061685: Creates a line block element.
17071686
@@ -1712,13 +1691,13 @@ Lua functions for pandoc scripts.
17121691
17131692 Returns: line block element
17141693
1715−[`Null ()`]{#Null}
1694+[`Null ()`]{#pandoc.null}
17161695
17171696: Creates a null element.
17181697
17191698 Returns: null element
17201699
1721−[`OrderedList (items[, listAttributes])`]{#OrderedList}
1700+[`OrderedList (items[, listAttributes])`]{#pandoc.orderedlist}
17221701
17231702: Creates an ordered list.
17241703
@@ -1732,7 +1711,7 @@ Lua functions for pandoc scripts.
17321711
17331712 Returns: ordered list element
17341713
1735−[`Para (content)`]{#Para}
1714+[`Para (content)`]{#pandoc.para}
17361715
17371716: Creates a para element.
17381717
@@ -1743,7 +1722,7 @@ Lua functions for pandoc scripts.
17431722
17441723 Returns: paragraph element
17451724
1746−[`Plain (content)`]{#Plain}
1725+[`Plain (content)`]{#pandoc.plain}
17471726
17481727: Creates a plain element.
17491728
@@ -1754,7 +1733,7 @@ Lua functions for pandoc scripts.
17541733
17551734 Returns: plain element
17561735
1757−[`RawBlock (format, text)`]{#RawBlock}
1736+[`RawBlock (format, text)`]{#pandoc.rawblock}
17581737
17591738: Creates a raw content block of the specified format.
17601739
@@ -1768,7 +1747,7 @@ Lua functions for pandoc scripts.
17681747
17691748 Returns: raw block element
17701749
1771−[`Table (caption, aligns, widths, headers, rows)`]{#Table}
1750+[`Table (caption, aligns, widths, headers, rows)`]{#pandoc.table}
17721751
17731752: Creates a table element.
17741753
@@ -1791,13 +1770,9 @@ Lua functions for pandoc scripts.
17911770
17921771 Returns: table element
17931772
1794−## Inline {#inline}
1795−
1796−[`Inline`]{#Inline}
1773+## Inline
17971774
1798−: Inline element class
1799−
1800−[`Cite (content, citations)`]{#Cite}
1775+[`Cite (content, citations)`]{#pandoc.cite}
18011776
18021777: Creates a Cite inline element
18031778
@@ -1811,7 +1786,7 @@ Lua functions for pandoc scripts.
18111786
18121787 Returns: citations element
18131788
1814−[`Code (text[, attr])`]{#Code}
1789+[`Code (text[, attr])`]{#pandoc.code}
18151790
18161791: Creates a Code inline element
18171792
@@ -1825,7 +1800,7 @@ Lua functions for pandoc scripts.
18251800
18261801 Returns: code element
18271802
1828−[`Emph (content)`]{#Emph}
1803+[`Emph (content)`]{#pandoc.emph}
18291804
18301805: Creates an inline element representing emphasised text.
18311806
@@ -1836,7 +1811,7 @@ Lua functions for pandoc scripts.
18361811
18371812 Returns: emphasis element
18381813
1839−[`Image (caption, src[, title[, attr]])`]{#Image}
1814+[`Image (caption, src[, title[, attr]])`]{#pandoc.image}
18401815
18411816: Creates a Image inline element
18421817
@@ -1856,13 +1831,13 @@ Lua functions for pandoc scripts.
18561831
18571832 Returns: image element
18581833
1859−[`LineBreak ()`]{#LineBreak}
1834+[`LineBreak ()`]{#pandoc.linebreak}
18601835
18611836: Create a LineBreak inline element
18621837
18631838 Returns: linebreak element
18641839
1865−[`Link (content, target[, title[, attr]])`]{#Link}
1840+[`Link (content, target[, title[, attr]])`]{#pandoc.link}
18661841
18671842: Creates a link inline element, usually a hyperlink.
18681843
@@ -1882,7 +1857,7 @@ Lua functions for pandoc scripts.
18821857
18831858 Returns: image element
18841859
1885−[`Math (mathtype, text)`]{#Math}
1860+[`Math (mathtype, text)`]{#pandoc.math}
18861861
18871862: Creates a Math element, either inline or displayed.
18881863
@@ -1896,7 +1871,7 @@ Lua functions for pandoc scripts.
18961871
18971872 Returns: Math element
18981873
1899−[`DisplayMath (text)`]{#DisplayMath}
1874+[`DisplayMath (text)`]{#pandoc.displaymath}
19001875
19011876: Creates a DisplayMath element (DEPRECATED).
19021877
@@ -1907,7 +1882,7 @@ Lua functions for pandoc scripts.
19071882
19081883 Returns: Math element
19091884
1910−[`InlineMath (text)`]{#InlineMath}
1885+[`InlineMath (text)`]{#pandoc.inlinemath}
19111886
19121887: Creates an InlineMath inline element (DEPRECATED).
19131888
@@ -1918,7 +1893,7 @@ Lua functions for pandoc scripts.
19181893
19191894 Returns: Math element
19201895
1921−[`Note (content)`]{#Note}
1896+[`Note (content)`]{#pandoc.note}
19221897
19231898: Creates a Note inline element
19241899
@@ -1927,7 +1902,7 @@ Lua functions for pandoc scripts.
19271902 `content`:
19281903 : footnote block content
19291904
1930−[`Quoted (quotetype, content)`]{#Quoted}
1905+[`Quoted (quotetype, content)`]{#pandoc.quoted}
19311906
19321907: Creates a Quoted inline element given the quote type and
19331908 quoted content.
@@ -1942,7 +1917,7 @@ Lua functions for pandoc scripts.
19421917
19431918 Returns: quoted element
19441919
1945−[`SingleQuoted (content)`]{#SingleQuoted}
1920+[`SingleQuoted (content)`]{#pandoc.singlequoted}
19461921
19471922: Creates a single-quoted inline element (DEPRECATED).
19481923
@@ -1953,9 +1928,9 @@ Lua functions for pandoc scripts.
19531928
19541929 Returns: quoted element
19551930
1956− See also: [Quoted](#Quoted)
1931+ See also: [Quoted](#type-quoted)
19571932
1958−[`DoubleQuoted (content)`]{#DoubleQuoted}
1933+[`DoubleQuoted (content)`]{#pandoc.doublequoted}
19591934
19601935: Creates a single-quoted inline element (DEPRECATED).
19611936
@@ -1966,9 +1941,9 @@ Lua functions for pandoc scripts.
19661941
19671942 Returns: quoted element
19681943
1969− See also: [Quoted](#Quoted)
1944+ See also: [Quoted](#type-quoted)
19701945
1971−[`RawInline (format, text)`]{#RawInline}
1946+[`RawInline (format, text)`]{#pandoc.rawinline}
19721947
19731948: Creates a RawInline inline element
19741949
@@ -1982,7 +1957,7 @@ Lua functions for pandoc scripts.
19821957
19831958 Returns: raw inline element
19841959
1985−[`SmallCaps (content)`]{#SmallCaps}
1960+[`SmallCaps (content)`]{#pandoc.smallcaps}
19861961
19871962: Creates text rendered in small caps
19881963
@@ -1993,19 +1968,19 @@ Lua functions for pandoc scripts.
19931968
19941969 Returns: smallcaps element
19951970
1996−[`SoftBreak ()`]{#SoftBreak}
1971+[`SoftBreak ()`]{#pandoc.softbreak}
19971972
19981973: Creates a SoftBreak inline element.
19991974
20001975 Returns: softbreak element
20011976
2002−[`Space ()`]{#Space}
1977+[`Space ()`]{#pandoc.space}
20031978
20041979: Create a Space inline element
20051980
20061981 Returns: space element
20071982
2008−[`Span (content[, attr])`]{#Span}
1983+[`Span (content[, attr])`]{#pandoc.span}
20091984
20101985: Creates a Span inline element
20111986
@@ -2019,7 +1994,7 @@ Lua functions for pandoc scripts.
20191994
20201995 Returns: span element
20211996
2022−[`Str (text)`]{#Str}
1997+[`Str (text)`]{#pandoc.str}
20231998
20241999: Creates a Str inline element
20252000
@@ -2030,7 +2005,7 @@ Lua functions for pandoc scripts.
20302005
20312006 Returns: string element
20322007
2033−[`Strikeout (content)`]{#Strikeout}
2008+[`Strikeout (content)`]{#pandoc.strikeout}
20342009
20352010: Creates text which is striked out.
20362011
@@ -2041,7 +2016,7 @@ Lua functions for pandoc scripts.
20412016
20422017 Returns: strikeout element
20432018
2044−[`Strong (content)`]{#Strong}
2019+[`Strong (content)`]{#pandoc.strong}
20452020
20462021: Creates a Strong element, whose text is usually displayed in
20472022 a bold font.
@@ -2053,7 +2028,7 @@ Lua functions for pandoc scripts.
20532028
20542029 Returns: strong element
20552030
2056−[`Subscript (content)`]{#Subscript}
2031+[`Subscript (content)`]{#pandoc.subscript}
20572032
20582033: Creates a Subscript inline element
20592034
@@ -2064,7 +2039,7 @@ Lua functions for pandoc scripts.
20642039
20652040 Returns: subscript element
20662041
2067−[`Superscript (content)`]{#Superscript}
2042+[`Superscript (content)`]{#pandoc.superscript}
20682043
20692044: Creates a Superscript inline element
20702045
@@ -2075,9 +2050,9 @@ Lua functions for pandoc scripts.
20752050
20762051 Returns: strong element
20772052
2078−## Element components {#element-components-create}
2053+## Element components
20792054
2080−[`Attr ([identifier[, classes[, attributes]]])`]{#Attr}
2055+[`Attr ([identifier[, classes[, attributes]]])`]{#pandoc.attr}
20812056
20822057: Create a new set of attributes (Attr).
20832058
@@ -2094,7 +2069,7 @@ Lua functions for pandoc scripts.
20942069
20952070 Returns: element attributes
20962071
2097−[`Citation (id, mode[, prefix[, suffix[, note_num[, hash]]]])`]{#Citation}
2072+[`Citation (id, mode[, prefix[, suffix[, note_num[, hash]]]])`]{#pandoc.citation}
20982073
20992074: Creates a single citation.
21002075
@@ -2118,7 +2093,7 @@ Lua functions for pandoc scripts.
21182093 `hash`:
21192094 : hash number
21202095
2121−[`ListAttributes ([start[, style[, delimiter]]])`]{#ListAttributes}
2096+[`ListAttributes ([start[, style[, delimiter]]])`]{#pandoc.listattributes}
21222097
21232098: Creates a set of list attributes.
21242099
@@ -2137,121 +2112,121 @@ Lua functions for pandoc scripts.
21372112
21382113## Constants
21392114
2140−[`AuthorInText`]{#AuthorInText}
2115+[`AuthorInText`]{#pandoc.authorintext}
21412116
21422117: Author name is mentioned in the text.
21432118
2144− See also: [Citation](#Citation)
2119+ See also: [Citation](#type-citation)
21452120
2146−[`SuppressAuthor`]{#SuppressAuthor}
2121+[`SuppressAuthor`]{#pandoc.suppressauthor}
21472122
21482123: Author name is suppressed.
21492124
2150− See also: [Citation](#Citation)
2125+ See also: [Citation](#type-citation)
21512126
2152−[`NormalCitation`]{#NormalCitation}
2127+[`NormalCitation`]{#pandoc.normalcitation}
21532128
21542129: Default citation style is used.
21552130
2156− See also: [Citation](#Citation)
2131+ See also: [Citation](#type-citation)
21572132
2158−[`AlignLeft`]{#AlignLeft}
2133+[`AlignLeft`]{#pandoc.alignleft}
21592134
21602135: Table cells aligned left.
21612136
2162− See also: [Table](#Table)
2137+ See also: [Table](#type-alignment)
21632138
2164−[`AlignRight`]{#AlignRight}
2139+[`AlignRight`]{#pandoc.alignright}
21652140
21662141: Table cells right-aligned.
21672142
2168− See also: [Table](#Table)
2143+ See also: [Table](#type-alignment)
21692144
2170−[`AlignCenter`]{#AlignCenter}
2145+[`AlignCenter`]{#pandoc.aligncenter}
21712146
21722147: Table cell content is centered.
21732148
2174− See also: [Table](#Table)
2149+ See also: [Table](#type-alignment)
21752150
2176−[`AlignDefault`]{#AlignDefault}
2151+[`AlignDefault`]{#pandoc.aligndefault}
21772152
21782153: Table cells are alignment is unaltered.
21792154
2180− See also: [Table](#Table)
2155+ See also: [Table](#type-alignment)
21812156
2182−[`DefaultDelim`]{#DefaultDelim}
2157+[`DefaultDelim`]{#pandoc.defaultdelim}
21832158
21842159: Default list number delimiters are used.
21852160
2186− See also: [OrderedList](#OrderedList)
2161+ See also: [ListAttributes](#type-listattributes)
21872162
2188−[`Period`]{#Period}
2163+[`Period`]{#pandoc.period}
21892164
21902165: List numbers are delimited by a period.
21912166
2192− See also: [OrderedList](#OrderedList)
2167+ See also: [ListAttributes](#type-listattributes)
21932168
2194−[`OneParen`]{#OneParen}
2169+[`OneParen`]{#pandoc.oneparen}
21952170
21962171: List numbers are delimited by a single parenthesis.
21972172
2198− See also: [OrderedList](#OrderedList)
2173+ See also: [ListAttributes](#type-listattributes)
21992174
2200−[`TwoParens`]{#TwoParens}
2175+[`TwoParens`]{#pandoc.twoparens}
22012176
22022177: List numbers are delimited by a double parentheses.
22032178
2204− See also: [OrderedList](#OrderedList)
2179+ See also: [ListAttributes](#type-listattributes)
22052180
2206−[`DefaultStyle`]{#DefaultStyle}
2181+[`DefaultStyle`]{#pandoc.defaultstyle}
22072182
22082183: List are numbered in the default style
22092184
2210− See also: [OrderedList](#OrderedList)
2185+ See also: [ListAttributes](#type-listattributes)
22112186
2212−[`Example`]{#Example}
2187+[`Example`]{#pandoc.example}
22132188
22142189: List items are numbered as examples.
22152190
2216− See also: [OrderedList](#OrderedList)
2191+ See also: [ListAttributes](#type-listattributes)
22172192
2218−[`Decimal`]{#Decimal}
2193+[`Decimal`]{#pandoc.decimal}
22192194
22202195: List are numbered using decimal integers.
22212196
2222− See also: [OrderedList](#OrderedList)
2197+ See also: [ListAttributes](#type-listattributes)
22232198
2224−[`LowerRoman`]{#LowerRoman}
2199+[`LowerRoman`]{#pandoc.lowerroman}
22252200
22262201: List are numbered using lower-case roman numerals.
22272202
2228− See also: [OrderedList](#OrderedList)
2203+ See also: [ListAttributes](#type-listattributes)
22292204
2230−[`UpperRoman`]{#UpperRoman}
2205+[`UpperRoman`]{#pandoc.upperroman}
22312206
22322207: List are numbered using upper-case roman numerals
22332208
2234− See also: [OrderedList](#OrderedList)
2209+ See also: [ListAttributes](#type-listattributes)
22352210
2236−[`LowerAlpha`]{#LowerAlpha}
2211+[`LowerAlpha`]{#pandoc.loweralpha}
22372212
22382213: List are numbered using lower-case alphabetic characters.
22392214
2240− See also: [OrderedList](#OrderedList)
2215+ See also: [ListAttributes](#type-listattributes)
22412216
2242−[`UpperAlpha`]{#UpperAlpha}
2217+[`UpperAlpha`]{#pandoc.upperalpha}
22432218
22442219: List are numbered using upper-case alphabetic characters.
22452220
2246− See also: [OrderedList](#OrderedList)
2221+ See also: [ListAttributes](#type-listattributes)
22472222
2248−[`sha1`]{#sha1}
2223+[`sha1`]{#pandoc.sha1}
22492224
22502225: Functions which have moved to different modules
22512226
22522227## Helper functions
22532228
2254−### pipe
2229+### pipe {#pandoc.pipe}
22552230
22562231`pipe (command, args, input)`
22572232
@@ -2272,7 +2247,7 @@ Usage:
22722247
22732248 local output = pandoc.pipe("sed", {"-e","s/a/b/"}, "abc")
22742249
2275−### walk\_block
2250+### walk\_block {#pandoc.walk_block}
22762251
22772252`walk_block (element, filter)`
22782253
@@ -2289,7 +2264,7 @@ Parameters:
22892264
22902265Returns: the transformed block element
22912266
2292−### walk\_inline
2267+### walk\_inline {#pandoc.walk_inline}
22932268
22942269`walk_inline (element, filter)`
22952270
@@ -2306,7 +2281,7 @@ Parameters:
23062281
23072282Returns: the transformed inline element
23082283
2309−### read
2284+### read {#pandoc.read}
23102285
23112286`read (markup[, format])`
23122287
@@ -2340,11 +2315,11 @@ The module is loaded as part of the `pandoc` module and
23402315available as `pandoc.utils`. In versions up-to and including
23412316pandoc 2.6, this module had to be loaded explicitly. Example:
23422317
2343− local utils = require 'pandoc.utils'
2318+ pandoc.utils = require 'pandoc.utils'
23442319
2345−Use this for backwards compatibility.
2320+Use the above for backwards compatibility.
23462321
2347−### blocks\_to\_inlines {#utils-blocks_to_inlines}
2322+### blocks\_to\_inlines {#pandoc.utils.blocks_to_inlines}
23482323
23492324`blocks_to_inlines (blocks[, sep])`
23502325
@@ -2353,16 +2328,16 @@ Squash a list of blocks into a list of inlines.
23532328Parameters:
23542329
23552330`blocks`:
2356−: List of [Blocks](#Blocks) to be flattened.
2331+: List of [Blocks](#type-block) to be flattened.
23572332
23582333`sep`:
2359−: List of [Inlines](#Inlines) inserted as separator between
2334+: List of [Inlines](#type-inline) inserted as separator between
23602335 two consecutive blocks; defaults to
23612336 `{ pandoc.Space(), pandoc.Str'¶', pandoc.Space()}`.
23622337
23632338Returns:
23642339
2365−- List of [Inlines](#Inlines)
2340+- [List](#type-list) of [Inlines](#type-inline)
23662341
23672342Usage:
23682343
@@ -2377,7 +2352,7 @@ Usage:
23772352 -- pandoc.Emph{ pandoc.Str 'Paragraph2' }
23782353 -- }
23792354
2380−### equals {#utils-equals}
2355+### equals {#pandoc.utils.equals}
23812356
23822357`equals (element1, element2)`
23832358
@@ -2388,22 +2363,19 @@ equal.
23882363Parameters:
23892364
23902365`element1`, `element2`:
2391−: Objects to be compared. Acceptable input types are
2392− [Pandoc](#type-ref-pandoc), [Meta](#type-ref-meta),
2393− [MetaValue](#type-ref-MetaValue), [Block](#type-ref-Block),
2394− [Inline](#type-ref-Inline), [Attr](#type-ref-Attr),
2395− [ListAttributes](#type-ref-ListAttributes), and
2396− [Citation](#type-ref-Citation).
2366+: Objects to be compared. Acceptable input types are [Pandoc],
2367+ [Meta], [MetaValue], [Block], [Inline], [Attr],
2368+ [ListAttributes], and [Citation].
23972369
23982370Returns:
23992371
24002372- Whether the two objects represent the same element (boolean)
24012373
2402−### make\_sections {#utils-make_sections}
2374+### make\_sections {#pandoc.utils.make_sections}
24032375
24042376`make_sections (number_sections, base_level, blocks)`
24052377
2406−Converst list of [Blocks](#Blocks) into sections.
2378+Converst list of [Blocks](#type-block) into sections.
24072379`Div`s will be created beginning at each `Header`
24082380and containing following content until the next `Header`
24092381of comparable level. If `number_sections` is true,
@@ -2415,7 +2387,7 @@ is the level specified.
24152387
24162388Returns:
24172389
2418−- List of [Blocks](#Blocks).
2390+- List of [Blocks](#type-block).
24192391
24202392Usage:
24212393
@@ -2425,7 +2397,7 @@ Usage:
24252397 }
24262398 local newblocks = pandoc.utils.make_sections(true, 1, blocks)
24272399
2428−### run\_json\_filter {#utils-run_json_filter}
2400+### run\_json\_filter {#pandoc.utils.run_json_filter}
24292401
24302402`run_json_filter (doc, filter[, args])`
24312403
@@ -2445,7 +2417,7 @@ Parameters:
24452417
24462418Returns:
24472419
2448−- ([Pandoc](#Pandoc)) Filtered document
2420+- ([Pandoc](#type-pandoc)) Filtered document
24492421
24502422Usage:
24512423
@@ -2458,7 +2430,7 @@ Usage:
24582430 )
24592431 some_blocks = sub_doc.blocks -- some blocks with bib
24602432
2461−### normalize\_date {#utils-normalize_date}
2433+### normalize\_date {#pandoc.utils.normalize_date}
24622434
24632435`normalize_date (date_string)`
24642436
@@ -2471,7 +2443,7 @@ Returns:
24712443
24722444- A date string, or nil when the conversion failed.
24732445
2474−### sha1 {#utils-sha1}
2446+### sha1 {#pandoc.utils.sha1}
24752447
24762448`sha1 (contents)`
24772449
@@ -2485,7 +2457,7 @@ Usage:
24852457
24862458 local fp = pandoc.utils.sha1("foobar")
24872459
2488−### stringify {#utils-stringify}
2460+### stringify {#pandoc.utils.stringify}
24892461
24902462`stringify (element)`
24912463
@@ -2502,7 +2474,7 @@ Usage:
25022474 -- outputs "Moin"
25032475 print(pandoc.utils.stringify(inline))
25042476
2505−### to\_roman\_numeral {#utils-to_roman_numeral}
2477+### to\_roman\_numeral {#pandoc.utils.to_roman_numeral}
25062478
25072479`to_roman_numeral (integer)`
25082480
@@ -2530,7 +2502,7 @@ required, e.g.:
25302502
25312503 local mb = require 'pandoc.mediabag'
25322504
2533−### delete {#mediabag-delete}
2505+### delete {#pandoc.mediabag.delete}
25342506
25352507`delete (filepath)`
25362508
@@ -2542,13 +2514,13 @@ Parameters:
25422514: filename of the item to be deleted. The media bag will be
25432515 left unchanged if no entry with the given filename exists.
25442516
2545−### empty {#mediabag-empty}
2517+### empty {#pandoc.mediabag.empty}
25462518
25472519`empty ()`
25482520
25492521Clear-out the media bag, deleting all items.
25502522
2551−### insert {#mediabag-insert}
2523+### insert {#pandoc.mediabag.insert}
25522524
25532525`insert (filepath, mime_type, contents)`
25542526
@@ -2572,7 +2544,7 @@ Usage:
25722544 local contents = "Hello, World!"
25732545 pandoc.mediabag.insert(fp, mt, contents)
25742546
2575−### items {#mediabag-items}
2547+### items {#pandoc.mediabag.items}
25762548
25772549`items ()`
25782550
@@ -2583,7 +2555,7 @@ processed one-by-one to avoid excessive memory use.
25832555
25842556This function should be used only when full access to all items,
25852557including their contents, is required. For all other cases,
2586−[`list`](#mediabag-list) should be preferred.
2558+[`list`](#pandoc.mediabag.list) should be preferred.
25872559
25882560Returns:
25892561
@@ -2599,7 +2571,7 @@ Usage:
25992571 -- print(fp, mt, contents)
26002572 end
26012573
2602−### list {#mediabag-list}
2574+### list {#pandoc.mediabag.list}
26032575
26042576`list ()`
26052577
@@ -2620,7 +2592,7 @@ Usage:
26202592 end
26212593 print(sum)
26222594
2623−### lookup {#mediabag-lookup}
2595+### lookup {#pandoc.mediabag.lookup}
26242596
26252597`lookup (filepath)`
26262598
@@ -2642,7 +2614,7 @@ Usage:
26422614 local filename = "media/diagram.png"
26432615 local mt, contents = pandoc.mediabag.lookup(filename)
26442616
2645−### fetch {#mediabag-fetch}
2617+### fetch {#pandoc.mediabag.fetch}
26462618
26472619`fetch (source, base_url)`
26482620
@@ -2667,7 +2639,7 @@ methods and convenience functions.
26672639
26682640## Constructor
26692641
2670−[`pandoc.List([table])`]{#pandoc.List}
2642+[`pandoc.List([table])`]{#pandoc.list}
26712643
26722644: Create a new List. If the optional argument `table` is given,
26732645 set the metatable of that value to `pandoc.List`. This is an
@@ -2675,7 +2647,7 @@ methods and convenience functions.
26752647
26762648## Metamethods
26772649
2678−[`pandoc.List:__concat (list)`]{#pandoc.List:__concat}
2650+[`pandoc.List:__concat (list)`]{#pandoc.list:__concat}
26792651
26802652: Concatenates two lists.
26812653
@@ -2689,11 +2661,11 @@ methods and convenience functions.
26892661
26902662## Methods
26912663
2692−[`pandoc.List:clone ()`]{#pandoc.List:clone}
2664+[`pandoc.List:clone ()`]{#pandoc.list:clone}
26932665
26942666: Returns a (shallow) copy of the list.
26952667
2696−[`pandoc.List:new([table])`]{#pandoc.List:new}
2668+[`pandoc.List:new([table])`]{#pandoc.list:new}
26972669
26982670: Create a new List. If the optional argument `table` is given,
26992671 set the metatable of that value to `pandoc.List`.
@@ -2706,7 +2678,7 @@ methods and convenience functions.
27062678
27072679 Returns: the updated input value
27082680
2709−[`pandoc.List:includes (needle, init)`]{#pandoc.List:includes}
2681+[`pandoc.List:includes (needle, init)`]{#pandoc.list:includes}
27102682
27112683: Checks if the list has an item equal to the given needle.
27122684
@@ -2721,7 +2693,7 @@ methods and convenience functions.
27212693 Returns: true if a list item is equal to the needle, false
27222694 otherwise
27232695
2724−[`pandoc.List:find (needle, init)`]{#pandoc.List:find}
2696+[`pandoc.List:find (needle, init)`]{#pandoc.list:find}
27252697
27262698: Returns the value and index of the first occurrence of the
27272699 given item.
@@ -2737,7 +2709,7 @@ methods and convenience functions.
27372709 Returns: first item equal to the needle, or nil if no such
27382710 item exists.
27392711
2740−[`pandoc.List:find_if (pred, init)`]{#pandoc.List:find_if}
2712+[`pandoc.List:find_if (pred, init)`]{#pandoc.list:find_if}
27412713
27422714: Returns the value and index of the first element for which
27432715 the predicate holds true.
@@ -2753,7 +2725,7 @@ methods and convenience functions.
27532725 Returns: first item for which \`test\` succeeds, or nil if
27542726 no such item exists.
27552727
2756−[`pandoc.List:extend (list)`]{#pandoc.List:extend}
2728+[`pandoc.List:extend (list)`]{#pandoc.list:extend}
27572729
27582730: Adds the given list to the end of this list.
27592731
@@ -2762,7 +2734,7 @@ methods and convenience functions.
27622734 `list`:
27632735 : list to appended
27642736
2765−[`pandoc.List:map (fn)`]{#pandoc.List:map}
2737+[`pandoc.List:map (fn)`]{#pandoc.list:map}
27662738
27672739: Returns a copy of the current list by applying the given
27682740 function to all elements.
@@ -2772,7 +2744,7 @@ methods and convenience functions.
27722744 `fn`:
27732745 : function which is applied to all list items.
27742746
2775−[`pandoc.List:filter (pred)`]{#pandoc.List:filter}
2747+[`pandoc.List:filter (pred)`]{#pandoc.list:filter}
27762748
27772749: Returns a new list containing all items satisfying a given
27782750 condition.
@@ -2789,19 +2761,19 @@ methods and convenience functions.
27892761
27902762Access to system information and functionality.
27912763
2792−## Static Fields {#system-fields}
2764+## Static Fields
27932765
2794−### arch {#system-arch}
2766+### arch {#pandoc.system.arch}
27952767
27962768The machine architecture on which the program is running.
27972769
2798−### os {#system-os}
2770+### os {#pandoc.system.os}
27992771
28002772The operating system on which the program is running.
28012773
2802−## Functions {#system-functions}
2774+## Functions
28032775
2804−### environment {#system-environment}
2776+### environment {#pandoc.system.environment}
28052777
28062778`environment ()`
28072779
@@ -2812,7 +2784,7 @@ Returns:
28122784- A table mapping environment variables names to their string
28132785 value (table).
28142786
2815−### get\_working\_directory {#system-get_working_directory}
2787+### get\_working\_directory {#pandoc.system.get_working_directory}
28162788
28172789`get_working_directory ()`
28182790
@@ -2822,7 +2794,7 @@ Returns:
28222794
28232795- The current working directory (string).
28242796
2825−### with\_environment {#system-with_environment}
2797+### with\_environment {#pandoc.system.with_environment}
28262798
28272799`with_environment (environment, callback)`
28282800
@@ -2846,7 +2818,7 @@ Returns:
28462818
28472819- The result(s) of the call to `callback`
28482820
2849−### with\_temporary\_directory {#system-with_temporary_directory}
2821+### with\_temporary\_directory {#pandoc.system.with_temporary_directory}
28502822
28512823`with_temporary_directory ([parent_dir,] templ, callback)`
28522824
@@ -2871,7 +2843,7 @@ Returns:
28712843
28722844- The result of the call to `callback`.
28732845
2874−### with\_working\_directory {#system-with_working_directory}
2846+### with\_working\_directory {#pandoc.system.with_working_directory}
28752847
28762848`with_working_directory (directory, callback)`
28772849
@@ -2897,7 +2869,7 @@ Returns:
28972869
28982870Constructors for types which are not part of the pandoc AST.
28992871
2900−### Version {#pandoc.types.Version}
2872+### Version {#pandoc.types.version}
29012873
29022874`Version (version_specifier)`
29032875
@@ -2908,8 +2880,8 @@ Parameters:
29082880`version`:
29092881: Version specifier: this can be a version string like
29102882 `'2.7.3'`, a list of integers like `{2, 7, 3}`, a single
2911− integer, or a [Version](#type-ref-Version).
2883+ integer, or a [Version].
29122884
29132885Returns:
29142886
2915−- A new [Version](#type-ref-Version) object.
2887+- A new [Version] object.