git.iko.soy/typeable/pandoc
on master help sign in
Lua filter docs: cross-link constructors and types

Thanks to @bpj for the idea.

commit6fd3d546a2f72cc75d9d1968b7f672b7b6dfb9a3 authorAlbert Krewinkel <albert@zeitkraut.de> dateSat 11 Jan 2020, 23:19 (7 years ago) parent4ede11a
1 file changed+281−62
doc/lua-filters.md+281−62
doc/lua-filters.md+281−62
@@ -686,7 +686,9 @@ Usage:
686686
687687Pandoc document
688688
689−Object equality is determined via [`pandoc.utils.equals`].
689+Values of this type can be created with the
690+[`pandoc.Pandoc`](#pandoc.pandoc) constructor. Object equality is
691+determined via [`pandoc.utils.equals`].
690692
691693`blocks`
692694: document content ([List] of [Blocks])
@@ -699,7 +701,9 @@ Object equality is determined via [`pandoc.utils.equals`].
699701Meta information on a document; string-indexed collection of
700702[MetaValues].
701703
702−Object equality is determined via [`pandoc.utils.equals`].
704+Values of this type can be created with the
705+[`pandoc.Meta`](#pandoc.meta) constructor. Object equality is
706+determined via [`pandoc.utils.equals`].
703707
704708## MetaValue {#type-metavalue}
705709
@@ -709,7 +713,7 @@ Object equality is determined via [`pandoc.utils.equals`].
709713
710714### MetaBlocks {#type-metablocks}
711715
712−A list of blocks usable as meta value ([List] of [Blocks])
716+A list of blocks usable as meta value ([List] of [Blocks]).
713717
714718Fields:
715719
@@ -718,12 +722,15 @@ Fields:
718722
719723### MetaBool {#type-metabool}
720724
721−Plain Lua boolean value (boolean)
725+Alias for Lua boolean, i.e. the values `true` and `false`.
722726
723727### MetaInlines {#type-metainlines}
724728
725729List of inlines used in metadata ([List] of [Inlines])
726730
731+Values of this type can be created with the
732+[`pandoc.MetaInlines`](#pandoc.metainlines) constructor.
733+
727734Fields:
728735
729736`tag`, `t`
@@ -731,16 +738,25 @@ Fields:
731738
732739### MetaList {#type-metalist}
733740
734−A list of other [MetaValues]. ([List] of [MetaValues])
741+A list of other metadata values ([List] of [MetaValues]).
742+
743+Values of this type can be created with the
744+[`pandoc.MetaList`](#pandoc.metalist) constructor.
735745
736746Fields:
737747
738748`tag`, `t`
739749: the literal `MetaList` (string)
740750
751+All methods available for [List]s can be used on this type as
752+well.
753+
741754### MetaMap {#type-metamap}
742755
743−A string-indexed map of meta-values. (table)
756+A string-indexed map of meta-values. (table).
757+
758+Values of this type can be created with the
759+[`pandoc.MetaMap`](#pandoc.metamap) constructor.
744760
745761Fields:
746762
@@ -752,7 +768,7 @@ with the same name as those listed.
752768
753769### MetaString {#type-metastring}
754770
755−Plain Lua string value (string)
771+Plain Lua string value (string).
756772
757773## Block {#type-block}
758774
@@ -760,9 +776,14 @@ Object equality is determined via [`pandoc.utils.equals`].
760776
761777### BlockQuote {#type-blockquote}
762778
763−A block quote element
779+A block quote element.
780+
781+Values of this type can be created with the
782+[`pandoc.BlockQuote`](#pandoc.blockquote) constructor.
783+
784+Fields:
764785
765−content:
786+`content`:
766787: block content ([List] of [Blocks])
767788
768789`tag`, `t`
@@ -770,7 +791,12 @@ content:
770791
771792### BulletList {#type-bulletlist}
772793
773−A bullet list
794+A bullet list.
795+
796+Values of this type can be created with the
797+[`pandoc.BulletList`](#pandoc.bulletlist) constructor.
798+
799+Fields:
774800
775801`content`
776802: list of items ([List] of [Blocks])
@@ -782,6 +808,11 @@ A bullet list
782808
783809Block of code.
784810
811+Values of this type can be created with the
812+[`pandoc.CodeBlock`](#pandoc.codeblock) constructor.
813+
814+Fields:
815+
785816`text`
786817: code string (string)
787818
@@ -804,6 +835,11 @@ Block of code.
804835
805836Definition list, containing terms and their explanation.
806837
838+Values of this type can be created with the
839+[`pandoc.DefinitionList`](#pandoc.definitionlist) constructor.
840+
841+Fields:
842+
807843`content`
808844: list of items
809845
@@ -812,7 +848,12 @@ Definition list, containing terms and their explanation.
812848
813849### Div {#type-div}
814850
815−Generic block container with attributes
851+Generic block container with attributes.
852+
853+Values of this type can be created with the
854+[`pandoc.Div`](#pandoc.div) constructor.
855+
856+Fields:
816857
817858`content`
818859: block content ([List] of [Blocks])
@@ -837,6 +878,11 @@ Generic block container with attributes
837878
838879Creates a header element.
839880
881+Values of this type can be created with the
882+[`pandoc.Header`](#pandoc.header) constructor.
883+
884+Fields:
885+
840886`level`
841887: header level (integer)
842888
@@ -863,6 +909,11 @@ Creates a header element.
863909
864910A horizontal rule.
865911
912+Values of this type can be created with the
913+[`pandoc.HorizontalRule`](#pandoc.horizontalrule) constructor.
914+
915+Fields:
916+
866917`tag`, `t`
867918: the literal `HorizontalRule` (string)
868919
@@ -871,6 +922,11 @@ A horizontal rule.
871922A line block, i.e. a list of lines, each separated from the next
872923by a newline.
873924
925+Values of this type can be created with the
926+[`pandoc.LineBlock`](#pandoc.lineblock) constructor.
927+
928+Fields:
929+
874930`content`
875931: inline content
876932
@@ -882,6 +938,9 @@ by a newline.
882938A null element; this element never produces any output in the
883939target format.
884940
941+Values of this type can be created with the
942+[`pandoc.Null`](#pandoc.null) constructor.
943+
885944`tag`, `t`
886945: the literal `Null` (string)
887946
@@ -889,6 +948,11 @@ target format.
889948
890949An ordered list.
891950
951+Values of this type can be created with the
952+[`pandoc.OrderedList`](#pandoc.orderedlist) constructor.
953+
954+Fields:
955+
892956`content`
893957: list items ([List] of [List] of [Blocks])
894958
@@ -909,7 +973,12 @@ An ordered list.
909973
910974### Para {#type-para}
911975
912−A paragraph
976+A paragraph.
977+
978+Values of this type can be created with the
979+[`pandoc.Para`](#pandoc.para) constructor.
980+
981+Fields:
913982
914983`content`
915984: inline content ([List] of [Inlines])
@@ -919,7 +988,12 @@ A paragraph
919988
920989### Plain {#type-plain}
921990
922−Plain text, not a paragraph
991+Plain text, not a paragraph.
992+
993+Values of this type can be created with the
994+[`pandoc.Plain`](#pandoc.plain) constructor.
995+
996+Fields:
923997
924998`content`
925999: inline content ([List] of [Inlines])
@@ -931,6 +1005,11 @@ Plain text, not a paragraph
9311005
9321006Raw content of a specified format.
9331007
1008+Values of this type can be created with the
1009+[`pandoc.RawBlock`](#pandoc.rawblock) constructor.
1010+
1011+Fields:
1012+
9341013`format`
9351014: format of content (string)
9361015
@@ -944,6 +1023,11 @@ Raw content of a specified format.
9441023
9451024A table.
9461025
1026+Values of this type can be created with the
1027+[`pandoc.Table`](#pandoc.table) constructor.
1028+
1029+Fields:
1030+
9471031`caption`
9481032: table caption ([List] of [Inlines])
9491033
@@ -978,7 +1062,12 @@ Object equality is determined via [`pandoc.utils.equals`].
9781062
9791063### Cite {#type-cite}
9801064
981−Citation
1065+Citation.
1066+
1067+Values of this type can be created with the
1068+[`pandoc.Cite`](#pandoc.cite) constructor.
1069+
1070+Fields:
9821071
9831072`content`
9841073: ([List] of [Inlines])
@@ -993,6 +1082,11 @@ Citation
9931082
9941083Inline code
9951084
1085+Values of this type can be created with the
1086+[`pandoc.Code`](#pandoc.code) constructor.
1087+
1088+Fields:
1089+
9961090`text`
9971091: code string (string)
9981092
@@ -1015,6 +1109,11 @@ Inline code
10151109
10161110Emphasized text
10171111
1112+Values of this type can be created with the
1113+[`pandoc.Emph`](#pandoc.emph) constructor.
1114+
1115+Fields:
1116+
10181117`content`
10191118: inline content ([List] of [Inlines])
10201119
@@ -1025,6 +1124,11 @@ Emphasized text
10251124
10261125Image: alt text (list of inlines), target
10271126
1127+Values of this type can be created with the
1128+[`pandoc.Image`](#pandoc.image) constructor.
1129+
1130+Fields:
1131+
10281132`attr`
10291133: attributes ([Attr])
10301134
@@ -1053,6 +1157,11 @@ Image: alt text (list of inlines), target
10531157
10541158Hard line break
10551159
1160+Values of this type can be created with the
1161+[`pandoc.LineBreak`](#pandoc.linebreak) constructor.
1162+
1163+Fields:
1164+
10561165`tag`, `t`
10571166: the literal `LineBreak` (string)
10581167
@@ -1060,6 +1169,11 @@ Hard line break
10601169
10611170Hyperlink: alt text (list of inlines), target
10621171
1172+Values of this type can be created with the
1173+[`pandoc.Link`](#pandoc.link) constructor.
1174+
1175+Fields:
1176+
10631177`attr`
10641178: attributes ([Attr])
10651179
@@ -1085,6 +1199,11 @@ Hyperlink: alt text (list of inlines), target
10851199
10861200TeX math (literal)
10871201
1202+Values of this type can be created with the
1203+[`pandoc.Math`](#pandoc.math) constructor.
1204+
1205+Fields:
1206+
10881207`mathtype`
10891208: specifier determining whether the math content should be
10901209 shown inline (`InlineMath`) or on a separate line
@@ -1100,6 +1219,11 @@ TeX math (literal)
11001219
11011220Footnote or endnote
11021221
1222+Values of this type can be created with the
1223+[`pandoc.Note`](#pandoc.note) constructor.
1224+
1225+Fields:
1226+
11031227`content`
11041228: ([List] of [Blocks])
11051229
@@ -1110,6 +1234,11 @@ Footnote or endnote
11101234
11111235Quoted text
11121236
1237+Values of this type can be created with the
1238+[`pandoc.Quoted`](#pandoc.quoted) constructor.
1239+
1240+Fields:
1241+
11131242`quotetype`
11141243: type of quotes to be used; one of `SingleQuote` or
11151244 `DoubleQuote` (string)
@@ -1124,6 +1253,11 @@ Quoted text
11241253
11251254Raw inline
11261255
1256+Values of this type can be created with the
1257+[`pandoc.RawInline`](#pandoc.rawinline) constructor.
1258+
1259+Fields:
1260+
11271261`format`
11281262: the format of the content (string)
11291263
@@ -1137,6 +1271,11 @@ Raw inline
11371271
11381272Small caps text
11391273
1274+Values of this type can be created with the
1275+[`pandoc.SmallCaps`](#pandoc.smallcaps) constructor.
1276+
1277+Fields:
1278+
11401279`content`
11411280: ([List] of [Inlines])
11421281
@@ -1147,6 +1286,11 @@ Small caps text
11471286
11481287Soft line break
11491288
1289+Values of this type can be created with the
1290+[`pandoc.SoftBreak`](#pandoc.softbreak) constructor.
1291+
1292+Fields:
1293+
11501294`tag`, `t`
11511295: the literal `SoftBreak` (string)
11521296
@@ -1154,6 +1298,11 @@ Soft line break
11541298
11551299Inter-word space
11561300
1301+Values of this type can be created with the
1302+[`pandoc.Space`](#pandoc.space) constructor.
1303+
1304+Fields:
1305+
11571306`tag`, `t`
11581307: the literal `Space` (string)
11591308
@@ -1161,6 +1310,11 @@ Inter-word space
11611310
11621311Generic inline container with attributes
11631312
1313+Values of this type can be created with the
1314+[`pandoc.Span`](#pandoc.span) constructor.
1315+
1316+Fields:
1317+
11641318`attr`
11651319: attributes ([Attr])
11661320
@@ -1183,6 +1337,11 @@ Generic inline container with attributes
11831337
11841338Text
11851339
1340+Values of this type can be created with the
1341+[`pandoc.Str`](#pandoc.str) constructor.
1342+
1343+Fields:
1344+
11861345`text`
11871346: content (string)
11881347
@@ -1193,6 +1352,11 @@ Text
11931352
11941353Strikeout text
11951354
1355+Values of this type can be created with the
1356+[`pandoc.Strikeout`](#pandoc.strikeout) constructor.
1357+
1358+Fields:
1359+
11961360`content`
11971361: inline content ([List] of [Inlines])
11981362
@@ -1203,6 +1367,11 @@ Strikeout text
12031367
12041368Strongly emphasized text
12051369
1370+Values of this type can be created with the
1371+[`pandoc.Strong`](#pandoc.strong) constructor.
1372+
1373+Fields:
1374+
12061375`content`
12071376: inline content ([List] of [Inlines])
12081377
@@ -1213,6 +1382,11 @@ Strongly emphasized text
12131382
12141383Subscripted text
12151384
1385+Values of this type can be created with the
1386+[`pandoc.Subscript`](#pandoc.subscript) constructor.
1387+
1388+Fields:
1389+
12161390`content`
12171391: inline content ([List] of [Inlines])
12181392
@@ -1223,6 +1397,11 @@ Subscripted text
12231397
12241398Superscripted text
12251399
1400+Values of this type can be created with the
1401+[`pandoc.Superscript`](#pandoc.superscript) constructor.
1402+
1403+Fields:
1404+
12261405`content`
12271406: inline content ([List] of [Inlines])
12281407
@@ -1249,6 +1428,8 @@ This also works when using the `attr` setter:
12491428
12501429Object equality is determined via [`pandoc.utils.equals`].
12511430
1431+Fields:
1432+
12521433`identifier`
12531434: element identifier (string)
12541435
@@ -1267,8 +1448,13 @@ indices to the list table.
12671448
12681449Single citation entry
12691450
1451+Values of this type can be created with the
1452+[`pandoc.Citation`](#pandoc.citation) constructor.
1453+
12701454Object equality is determined via [`pandoc.utils.equals`].
12711455
1456+Fields:
1457+
12721458`id`
12731459: citation identifier, e.g., a bibtex key (string)
12741460
@@ -1292,8 +1478,13 @@ Object equality is determined via [`pandoc.utils.equals`].
12921478
12931479List attributes
12941480
1481+Values of this type can be created with the
1482+[`pandoc.ListAttributes`](#pandoc.listattributes) constructor.
1483+
12951484Object equality is determined via [`pandoc.utils.equals`].
12961485
1486+Fields:
1487+
12971488`start`
12981489: number of the first list item (integer)
12991490
@@ -1310,6 +1501,8 @@ Object equality is determined via [`pandoc.utils.equals`].
13101501
13111502Pandoc reader options
13121503
1504+Fields:
1505+
13131506`abbreviations`
13141507: set of known abbreviations (set of strings)
13151508
@@ -1347,6 +1540,8 @@ Pandoc reader options
13471540The state used by pandoc to collect information and make it
13481541available to readers and writers.
13491542
1543+Fields:
1544+
13501545`input_files`
13511546: List of input files from command line
13521547 ([List] of strings)
@@ -1390,6 +1585,10 @@ convenience. The `pandoc.List` type is defined in the
13901585[*pandoc.List*](#module-pandoc.list) module. See there for
13911586available methods.
13921587
1588+Values of this type can be created with the
1589+[`pandoc.List`](#pandoc.list) constructor, turning a normal Lua
1590+table into a List.
1591+
13931592## LogMessage {#type-logmessage}
13941593
13951594A pandoc log message. Objects have no fields, but can be
@@ -1410,6 +1609,9 @@ Comparisons are performed element-wise, i.e.
14101609
14111610 Version '1.12' > Version '1.9'
14121611
1612+Values of this type can be created with the
1613+[`pandoc.types.Version`](#pandoc.types.version) constructor.
1614+
14131615### `must_be_at_least`
14141616
14151617`must_be_at_least(actual, expected [, error_message])`
@@ -1526,9 +1728,11 @@ format, and functions to filter and modify a subtree.
15261728 `meta`:
15271729 : document meta data
15281730
1731+ Returns: [Pandoc] object
1732+
15291733## Meta
15301734
1531−[`Meta (table)`]{#pando.meta}
1735+[`Meta (table)`]{#pandoc.meta}
15321736
15331737: Create a new Meta object.
15341738
@@ -1537,6 +1741,8 @@ format, and functions to filter and modify a subtree.
15371741 `table`:
15381742 : table containing document meta information
15391743
1744+ Returns: [Meta] object
1745+
15401746## MetaValue
15411747
15421748[`MetaBlocks (blocks)`]{#pandoc.metablocks}
@@ -1548,6 +1754,8 @@ format, and functions to filter and modify a subtree.
15481754 `blocks`:
15491755 : blocks
15501756
1757+ Returns: [MetaBlocks] object
1758+
15511759[`MetaInlines (inlines)`]{#pandoc.metainlines}
15521760
15531761: Meta inlines
@@ -1557,6 +1765,8 @@ format, and functions to filter and modify a subtree.
15571765 `inlines`:
15581766 : inlines
15591767
1768+ Returns: [MetaInlines] object
1769+
15601770[`MetaList (meta_values)`]{#pandoc.metalist}
15611771
15621772: Meta list
@@ -1566,6 +1776,8 @@ format, and functions to filter and modify a subtree.
15661776 `meta_values`:
15671777 : list of meta values
15681778
1779+ Returns: [MetaList] object
1780+
15691781[`MetaMap (key_value_map)`]{#pandoc.metamap}
15701782
15711783: Meta map
@@ -1575,6 +1787,8 @@ format, and functions to filter and modify a subtree.
15751787 `key_value_map`:
15761788 : a string-indexed map of meta values
15771789
1790+ Returns: [MetaMap] object
1791+
15781792[`MetaString (str)`]{#pandoc.metastring}
15791793
15801794: Creates string to be used in meta data.
@@ -1584,6 +1798,8 @@ format, and functions to filter and modify a subtree.
15841798 `str`:
15851799 : string value
15861800
1801+ Returns: [MetaString] object
1802+
15871803[`MetaBool (bool)`]{#pandoc.metabool}
15881804
15891805: Creates boolean to be used in meta data.
@@ -1593,6 +1809,8 @@ format, and functions to filter and modify a subtree.
15931809 `bool`:
15941810 : boolean value
15951811
1812+ Returns: [MetaBool] object
1813+
15961814## Blocks
15971815
15981816[`BlockQuote (content)`]{#pandoc.blockquote}
@@ -1604,7 +1822,7 @@ format, and functions to filter and modify a subtree.
16041822 `content`:
16051823 : block content
16061824
1607− Returns: block quote element
1825+ Returns: [BlockQuote] object
16081826
16091827[`BulletList (content)`]{#pandoc.bulletlist}
16101828
@@ -1615,7 +1833,7 @@ format, and functions to filter and modify a subtree.
16151833 `content`:
16161834 : list of items
16171835
1618− Returns: bullet list element
1836+ Returns: [BulletList] object
16191837
16201838[`CodeBlock (text[, attr])`]{#pandoc.codeblock}
16211839
@@ -1629,7 +1847,7 @@ format, and functions to filter and modify a subtree.
16291847 `attr`:
16301848 : element attributes
16311849
1632− Returns: code block element
1850+ Returns: [CodeBlock] object
16331851
16341852[`DefinitionList (content)`]{#pandoc.definitionlist}
16351853
@@ -1641,7 +1859,7 @@ format, and functions to filter and modify a subtree.
16411859 `content`:
16421860 : list of items
16431861
1644− Returns: definition list element
1862+ Returns: [DefinitionList] object
16451863
16461864[`Div (content[, attr])`]{#pandoc.div}
16471865
@@ -1655,7 +1873,7 @@ format, and functions to filter and modify a subtree.
16551873 `attr`:
16561874 : element attributes
16571875
1658− Returns: div element
1876+ Returns: [Div] object
16591877
16601878[`Header (level, content[, attr])`]{#pandoc.header}
16611879
@@ -1672,13 +1890,13 @@ format, and functions to filter and modify a subtree.
16721890 `attr`:
16731891 : element attributes
16741892
1675− Returns: header element
1893+ Returns: [Header] object
16761894
16771895[`HorizontalRule ()`]{#pandoc.horizontalrule}
16781896
16791897: Creates a horizontal rule.
16801898
1681− Returns: horizontal rule
1899+ Returns: [HorizontalRule] object
16821900
16831901[`LineBlock (content)`]{#pandoc.lineblock}
16841902
@@ -1689,13 +1907,13 @@ format, and functions to filter and modify a subtree.
16891907 `content`:
16901908 : inline content
16911909
1692− Returns: line block element
1910+ Returns: [LineBlock] object
16931911
16941912[`Null ()`]{#pandoc.null}
16951913
16961914: Creates a null element.
16971915
1698− Returns: null element
1916+ Returns: [Null] object
16991917
17001918[`OrderedList (items[, listAttributes])`]{#pandoc.orderedlist}
17011919
@@ -1709,7 +1927,7 @@ format, and functions to filter and modify a subtree.
17091927 `listAttributes`:
17101928 : list parameters
17111929
1712− Returns: ordered list element
1930+ Returns: [OrderedList](#type-orderedlist) object
17131931
17141932[`Para (content)`]{#pandoc.para}
17151933
@@ -1720,7 +1938,7 @@ format, and functions to filter and modify a subtree.
17201938 `content`:
17211939 : inline content
17221940
1723− Returns: paragraph element
1941+ Returns: [Para](#type-para) object
17241942
17251943[`Plain (content)`]{#pandoc.plain}
17261944
@@ -1731,7 +1949,7 @@ format, and functions to filter and modify a subtree.
17311949 `content`:
17321950 : inline content
17331951
1734− Returns: plain element
1952+ Returns: [Plain](#type-plain) object
17351953
17361954[`RawBlock (format, text)`]{#pandoc.rawblock}
17371955
@@ -1745,7 +1963,7 @@ format, and functions to filter and modify a subtree.
17451963 `text`:
17461964 : string content
17471965
1748− Returns: raw block element
1966+ Returns: [RawBlock](#type-rawblock) object
17491967
17501968[`Table (caption, aligns, widths, headers, rows)`]{#pandoc.table}
17511969
@@ -1768,7 +1986,7 @@ format, and functions to filter and modify a subtree.
17681986 `rows`:
17691987 : table rows
17701988
1771− Returns: table element
1989+ Returns: [Table](#type-table) object
17721990
17731991## Inline
17741992
@@ -1784,7 +2002,7 @@ format, and functions to filter and modify a subtree.
17842002 `citations`:
17852003 : List of citations
17862004
1787− Returns: citations element
2005+ Returns: [Cite](#type-cite) object
17882006
17892007[`Code (text[, attr])`]{#pandoc.code}
17902008
@@ -1798,7 +2016,7 @@ format, and functions to filter and modify a subtree.
17982016 `attr`:
17992017 : additional attributes
18002018
1801− Returns: code element
2019+ Returns: [Code](#type-code) object
18022020
18032021[`Emph (content)`]{#pandoc.emph}
18042022
@@ -1809,7 +2027,7 @@ format, and functions to filter and modify a subtree.
18092027 `content`:
18102028 : inline content
18112029
1812− Returns: emphasis element
2030+ Returns: [Emph](#type-emph) object
18132031
18142032[`Image (caption, src[, title[, attr]])`]{#pandoc.image}
18152033
@@ -1829,13 +2047,13 @@ format, and functions to filter and modify a subtree.
18292047 `attr`:
18302048 : additional attributes
18312049
1832− Returns: image element
2050+ Returns: [Image](#type-image) object
18332051
18342052[`LineBreak ()`]{#pandoc.linebreak}
18352053
18362054: Create a LineBreak inline element
18372055
1838− Returns: linebreak element
2056+ Returns: [LineBreak](#type-linebreak) object
18392057
18402058[`Link (content, target[, title[, attr]])`]{#pandoc.link}
18412059
@@ -1855,7 +2073,7 @@ format, and functions to filter and modify a subtree.
18552073 `attr`:
18562074 : additional attributes
18572075
1858− Returns: image element
2076+ Returns: [Link](#type-link) object
18592077
18602078[`Math (mathtype, text)`]{#pandoc.math}
18612079
@@ -1869,29 +2087,29 @@ format, and functions to filter and modify a subtree.
18692087 `text`:
18702088 : Math content
18712089
1872− Returns: Math element
2090+ Returns: [Math](#type-math) object
18732091
18742092[`DisplayMath (text)`]{#pandoc.displaymath}
18752093
1876−: Creates a DisplayMath element (DEPRECATED).
2094+: Creates a math element of type "DisplayMath" (DEPRECATED).
18772095
18782096 Parameters:
18792097
18802098 `text`:
18812099 : Math content
18822100
1883− Returns: Math element
2101+ Returns: [Math](#type-math) object
18842102
18852103[`InlineMath (text)`]{#pandoc.inlinemath}
18862104
1887−: Creates an InlineMath inline element (DEPRECATED).
2105+: Creates a math element of type "InlineMath" (DEPRECATED).
18882106
18892107 Parameters:
18902108
18912109 `text`:
18922110 : Math content
18932111
1894− Returns: Math element
2112+ Returns: [Math](#type-math) object
18952113
18962114[`Note (content)`]{#pandoc.note}
18972115
@@ -1902,6 +2120,8 @@ format, and functions to filter and modify a subtree.
19022120 `content`:
19032121 : footnote block content
19042122
2123+ Returns: [Note](#type-note) object
2124+
19052125[`Quoted (quotetype, content)`]{#pandoc.quoted}
19062126
19072127: Creates a Quoted inline element given the quote type and
@@ -1915,7 +2135,7 @@ format, and functions to filter and modify a subtree.
19152135 `content`:
19162136 : inline content
19172137
1918− Returns: quoted element
2138+ Returns: [Quoted](#type-quoted) object
19192139
19202140[`SingleQuoted (content)`]{#pandoc.singlequoted}
19212141
@@ -1926,9 +2146,7 @@ format, and functions to filter and modify a subtree.
19262146 `content`:
19272147 : inline content
19282148
1929− Returns: quoted element
1930−
1931− See also: [Quoted](#type-quoted)
2149+ Returns: [Quoted](#type-quoted)
19322150
19332151[`DoubleQuoted (content)`]{#pandoc.doublequoted}
19342152
@@ -1939,13 +2157,11 @@ format, and functions to filter and modify a subtree.
19392157 `content`:
19402158 : inline content
19412159
1942− Returns: quoted element
1943−
1944− See also: [Quoted](#type-quoted)
2160+ Returns: [Quoted](#type-quoted)
19452161
19462162[`RawInline (format, text)`]{#pandoc.rawinline}
19472163
1948−: Creates a RawInline inline element
2164+: Creates a raw inline element
19492165
19502166 Parameters:
19512167
@@ -1955,7 +2171,7 @@ format, and functions to filter and modify a subtree.
19552171 `text`:
19562172 : string content
19572173
1958− Returns: raw inline element
2174+ Returns: [RawInline](#type-rawinline) object
19592175
19602176[`SmallCaps (content)`]{#pandoc.smallcaps}
19612177
@@ -1966,19 +2182,19 @@ format, and functions to filter and modify a subtree.
19662182 `content`:
19672183 : inline content
19682184
1969− Returns: smallcaps element
2185+ Returns: [SmallCaps](#type-smallcaps) object
19702186
19712187[`SoftBreak ()`]{#pandoc.softbreak}
19722188
19732189: Creates a SoftBreak inline element.
19742190
1975− Returns: softbreak element
2191+ Returns: [SoftBreak](#type-softbreak) object
19762192
19772193[`Space ()`]{#pandoc.space}
19782194
19792195: Create a Space inline element
19802196
1981− Returns: space element
2197+ Returns: [Space](#type-space) object
19822198
19832199[`Span (content[, attr])`]{#pandoc.span}
19842200
@@ -1992,7 +2208,7 @@ format, and functions to filter and modify a subtree.
19922208 `attr`:
19932209 : additional attributes
19942210
1995− Returns: span element
2211+ Returns: [Span](#type-span) object
19962212
19972213[`Str (text)`]{#pandoc.str}
19982214
@@ -2003,7 +2219,7 @@ format, and functions to filter and modify a subtree.
20032219 `text`:
20042220 : content
20052221
2006− Returns: string element
2222+ Returns: [Str](#type-str) object
20072223
20082224[`Strikeout (content)`]{#pandoc.strikeout}
20092225
@@ -2014,7 +2230,7 @@ format, and functions to filter and modify a subtree.
20142230 `content`:
20152231 : inline content
20162232
2017− Returns: strikeout element
2233+ Returns: [Strikeout](#type-strikeout) object
20182234
20192235[`Strong (content)`]{#pandoc.strong}
20202236
@@ -2026,7 +2242,7 @@ format, and functions to filter and modify a subtree.
20262242 `content`:
20272243 : inline content
20282244
2029− Returns: strong element
2245+ Returns: [Strong](#type-strong) object
20302246
20312247[`Subscript (content)`]{#pandoc.subscript}
20322248
@@ -2037,7 +2253,7 @@ format, and functions to filter and modify a subtree.
20372253 `content`:
20382254 : inline content
20392255
2040− Returns: subscript element
2256+ Returns: [Subscript](#type-subscript) object
20412257
20422258[`Superscript (content)`]{#pandoc.superscript}
20432259
@@ -2048,7 +2264,7 @@ format, and functions to filter and modify a subtree.
20482264 `content`:
20492265 : inline content
20502266
2051− Returns: strong element
2267+ Returns: [Superscript](#type-superscript) object
20522268
20532269## Element components
20542270
@@ -2067,7 +2283,7 @@ format, and functions to filter and modify a subtree.
20672283 `attributes`:
20682284 : table containing string keys and values
20692285
2070− Returns: element attributes
2286+ Returns: [Attr](#type-attr) object
20712287
20722288[`Citation (id, mode[, prefix[, suffix[, note_num[, hash]]]])`]{#pandoc.citation}
20732289
@@ -2093,6 +2309,8 @@ format, and functions to filter and modify a subtree.
20932309 `hash`:
20942310 : hash number
20952311
2312+ Returns: [Citation](#type-citation) object
2313+
20962314[`ListAttributes ([start[, style[, delimiter]]])`]{#pandoc.listattributes}
20972315
20982316: Creates a set of list attributes.
@@ -2108,7 +2326,7 @@ format, and functions to filter and modify a subtree.
21082326 `delimiter`:
21092327 : delimiter of list numbers
21102328
2111− Returns: list attributes table
2329+ Returns: [ListAttributes](#type-listattributes) object
21122330
21132331## Constants
21142332
@@ -2222,7 +2440,8 @@ format, and functions to filter and modify a subtree.
22222440
22232441[`sha1`]{#pandoc.sha1}
22242442
2225−: Functions which have moved to different modules
2443+: Alias for [`pandoc.utils.sha1`](#pandoc.utils.sha1)
2444+ (DEPRECATED).
22262445
22272446## Helper functions
22282447
@@ -2936,7 +3155,7 @@ Creates a Version object.
29363155
29373156Parameters:
29383157
2939−`version`:
3158+`version_specifier`:
29403159: Version specifier: this can be a version string like
29413160 `'2.7.3'`, a list of integers like `{2, 7, 3}`, a single
29423161 integer, or a [Version].