@@ -1374,23 +1374,33 @@ function Str (s)
13741374end
13751375```
13761376
1377−### `lower (s)` {#text-lower}
1377+### lower {#text-lower}
1378+
1379+`lower (s)`
13781380
13791381Returns a copy of a UTF-8 string, converted to lowercase.
13801382
1381−### `upper (s)` {#text-upper}
1383+### upper {#text-upper}
1384+
1385+`upper (s)`
13821386
13831387Returns a copy of a UTF-8 string, converted to uppercase.
13841388
1385−### `reverse (s)` {#text-reverse}
1389+### reverse {#text-reverse}
1390+
1391+`reverse (s)`
13861392
13871393Returns a copy of a UTF-8 string, with characters reversed.
13881394
1389−### `len (s)` {#text-len}
1395+### len {#text-len}
1396+
1397+`len (s)`
13901398
13911399Returns the length of a UTF-8 string.
13921400
1393−### `sub (s)` {#text-sub}
1401+### sub {#text-sub}
1402+
1403+`sub (s)`
13941404
13951405Returns a substring of a UTF-8 string, using Lua's string
13961406indexing rules.
@@ -1401,723 +1411,711 @@ Lua functions for pandoc scripts.
14011411
14021412## Pandoc Document
14031413
1404−### `Pandoc (blocks[, meta])` {#Pandoc}
1414+### Pandoc {#Pandoc}
1415+
1416+`Pandoc (blocks[, meta])`
14051417
14061418A complete pandoc document
14071419
14081420Parameters:
14091421
14101422`blocks`:
1411−: document content
1423+: list of [Blocks]
14121424
14131425`meta`:
1414−: document meta data
1426+: [Meta] value (see below)
1427+
1428+## Metadata
14151429
1416−## Meta
1430+### Meta {#Meta}
14171431
1418−### `Meta (table)` {#Meta}
1432+`Meta (table)`
14191433
1420−Create a new Meta object.
1434+Create a new [Meta] object.
14211435
14221436Parameters:
14231437
14241438`table`:
1425−: table containing document meta information
1439+: table with string keys and [MetaValue] values
14261440
14271441## MetaValue
14281442
1429−### `MetaBlocks (blocks)` {#MetaBlocks}
1443+### MetaBlocks {#MetaBlocks}
1444+
1445+`MetaBlocks (blocks)`
14301446
1431−Meta blocks
1447+Block-level metadata content.
14321448
14331449Parameters:
14341450
14351451`blocks`:
1436−: blocks
1452+: list of [Blocks]
14371453
1438−### `MetaInlines (inlines)` {#MetaInlines}
1454+### MetaInlines {#MetaInlines}
14391455
1440−Meta inlines
1456+`MetaInlines (inlines)`
1457+
1458+Inline-level metadata content.
14411459
14421460Parameters:
14431461
14441462`inlines`:
1445−: inlines
1463+: list of [Inlines]
1464+
1465+### MetaList {#MetaList}
14461466
1447−### `MetaList (meta_values)` {#MetaList}
1467+`MetaList (meta_values)`
14481468
1449−Meta list
1469+List of metadata items.
14501470
14511471Parameters:
14521472
14531473`meta_values`:
1454−: list of meta values
1474+: list of [MetaValues][MetaValue]
14551475
1456−### `MetaMap (key_value_map)` {#MetaMap}
1476+### MetaMap {#MetaMap}
14571477
1458−Meta map
1478+`MetaMap (key_value_map)`
1479+
1480+Field/value map of metadata items.
14591481
14601482Parameters:
14611483
14621484`key_value_map`:
1463−: a string-indexed map of meta values
1485+: a table with string keys and [MetaValue] values
1486+
1487+### MetaString {#MetaString}
14641488
1465−### `MetaString (str)` {#MetaString}
1489+`MetaString (str)`
14661490
1467−Creates string to be used in meta data.
1491+String metadata content.
14681492
14691493Parameters:
14701494
14711495`str`:
14721496: string value
14731497
1474−### `MetaBool (bool)` {#MetaBool}
1498+### MetaBool {#MetaBool}
1499+
1500+`MetaBool (bool)`
14751501
1476−Creates boolean to be used in meta data.
1502+Boolean metadata content.
14771503
14781504Parameters:
14791505
14801506`bool`:
14811507: boolean value
14821508
1483−## Blocks
1509+## Blocks {#Blocks}
14841510
1485−### `Block` {#Block}
1511+### BlockQuote {#BlockQuote}
14861512
1487−Block elements
1513+`BlockQuote (content)`
14881514
1489−### `BlockQuote (content)` {#BlockQuote}
1490−
1491−Creates a block quote element
1515+Creates a BlockQuote element
14921516
14931517Parameters:
14941518
14951519`content`:
1496−: block content
1520+: list of [Blocks]
1521+
1522+Returns: BlockQuote element
14971523
1498−Returns: block quote element
1524+### BulletList {#BulletList}
14991525
1500−### `BulletList (content)` {#BulletList}
1526+`BulletList (content)`
15011527
1502−Creates a bullet (i.e.
1528+Creates a BulletList element
15031529
15041530Parameters:
15051531
15061532`content`:
1507−: list of items
1533+: list of items (where each item is a list of [Blocks])
1534+
1535+Returns: BulletList element
15081536
1509−Returns: bullet list element
1537+### CodeBlock {#CodeBlock}
15101538
1511−### `CodeBlock (text[, attr])` {#CodeBlock}
1539+`CodeBlock (text[, attr])`
15121540
1513−Creates a code block element
1541+Creates a CodeBlock element
15141542
15151543Parameters:
15161544
15171545`text`:
1518−: code string
1546+: string (the code)
15191547
15201548`attr`:
1521−: element attributes
1549+: [Attr]{#Attr} (code attributes)
15221550
1523−Returns: code block element
1551+Returns: CodeBlock element
15241552
1525−### `DefinitionList (content)` {#DefinitionList}
1553+### DefinitionList {#DefinitionList}
15261554
1527−Creates a definition list, containing terms and their
1528−explanation.
1555+`DefinitionList (content)`
1556+
1557+Creates a DefinitionList element
15291558
15301559Parameters:
15311560
15321561`content`:
1533−: list of items
1562+: list of items (where each item is a two element list,
1563+ where the first element is a list of [Inlines], the
1564+ term, and the second is a list of lists of [Blocks],
1565+ the definitions)
15341566
1535−Returns: definition list element
1567+Returns: DefinitionList element
15361568
1537−### `Div (content[, attr])` {#Div}
1569+### Div {#Div}
15381570
1539−Creates a div element
1571+`Div (content[, attr])`
1572+
1573+Creates a Div element
15401574
15411575Parameters:
15421576
15431577`content`:
1544−: block content
1578+: list of [Blocks]
15451579
15461580`attr`:
1547−: element attributes
1581+: [Attr]{#Attr} (Div attributes)
15481582
1549−Returns: div element
1583+Returns: Div element
15501584
1551−### `Header (level, content[, attr])` {#Header}
1585+### Header {#Header}
15521586
1553−Creates a header element.
1587+`Header (level, content[, attr])`
1588+
1589+Creates a Header element.
15541590
15551591Parameters:
15561592
15571593`level`:
1558−: header level
1594+: Header level (integer)
15591595
15601596`content`:
1561−: inline content
1597+: list of [Inlines] (header title)
15621598
15631599`attr`:
1564−: element attributes
1600+: [Attr]{#Attr} (header attributes)
1601+
1602+Returns: Header element
15651603
1566−Returns: header element
1604+### HorizontalRule {#HorizontalRule}
15671605
1568−### `HorizontalRule ()` {#HorizontalRule}
1606+`HorizontalRule ()`
15691607
1570−Creates a horizontal rule.
1608+Creates a HorizontalRule element.
15711609
1572−Returns: horizontal rule
1610+Returns: HorizontalRule element
15731611
1574−### `LineBlock (content)` {#LineBlock}
1612+### LineBlock {#LineBlock}
15751613
1576−Creates a line block element.
1614+`LineBlock (content)`
1615+
1616+Creates a LineBlock element.
15771617
15781618Parameters:
15791619
15801620`content`:
1581−: inline content
1621+: list of lines (where each line is a list of [Inlines])
1622+
1623+Returns: LineBlock element
15821624
1583−Returns: line block element
1625+### Null {#Null}
15841626
1585−### `Null ()` {#Null}
1627+`Null ()`
15861628
1587−Creates a null element.
1629+Creates a Null block element.
15881630
1589−Returns: null element
1631+Returns: Null element
15901632
1591−### `OrderedList (items[, listAttributes])` {#OrderedList}
1633+### OrderedList {#OrderedList}
15921634
1593−Creates an ordered list.
1635+`OrderedList (items[, listAttributes])`
1636+
1637+Creates an OrderedList element.
15941638
15951639Parameters:
15961640
15971641`items`:
1598−: list items
1642+: list of items (where each item is a list of [Blocks])
15991643
16001644`listAttributes`:
1601−: list parameters
1645+: [ListAttributes]{#ListAttributes}
1646+
1647+Returns: OrderedList element
16021648
1603−Returns: ordered list element
1649+### Para {#Para}
16041650
1605−### `Para (content)` {#Para}
1651+`Para (content)`
16061652
1607−Creates a para element.
1653+Creates a Para element.
16081654
16091655Parameters:
16101656
16111657`content`:
1612−: inline content
1658+: list of [Inlines]
1659+
1660+Returns: Para element
16131661
1614−Returns: paragraph element
1662+### Plain {#Plain}
16151663
1616−### `Plain (content)` {#Plain}
1664+`Plain (content)`
16171665
1618−Creates a plain element.
1666+Creates a Plain element.
16191667
16201668Parameters:
16211669
16221670`content`:
1623−: inline content
1671+: list of [Inlines]
16241672
1625−Returns: plain element
1673+Returns: Plain element
16261674
1627−### `RawBlock (format, text)` {#RawBlock}
1675+### RawBlock {#RawBlock}
16281676
1629−Creates a raw content block of the specified format.
1677+`RawBlock (format, text)`
1678+
1679+Creates a RawBlock of the specified format.
16301680
16311681Parameters:
16321682
16331683`format`:
1634−: format of content
1684+: string (format of content, e.g. 'latex')
16351685
16361686`text`:
16371687: string content
16381688
1639−Returns: raw block element
1689+Returns: RawBlock element
1690+
1691+### Table {#Table}
16401692
1641−### `Table (caption, aligns, widths, headers, rows)` {#Table}
1693+`Table (caption, aligns, widths, headers, rows)`
16421694
1643−Creates a table element.
1695+Creates a Table element.
16441696
16451697Parameters:
16461698
16471699`caption`:
1648−: table caption
1700+: table caption (list of [Inlines])
16491701
16501702`aligns`:
1651−: alignments
1703+: alignments (a list of
1704+ `pandoc.AlignDefault`, `pandoc.AlignLeft`, `pandoc.AlignRight`,
1705+ `pandoc.AlignCenter`, one for each column)
16521706
16531707`widths`:
1654−: column widths
1708+: column widths (a list of floats, one for each column,
1709+ denoting the fraction of the textwidth needed for the
1710+ column, 0.5 = half width; OR an empty list for a
1711+ simple table where cells need not wrap)
16551712
16561713`headers`:
1657−: header row
1714+: header row (a list of cells, each cell a list of [Blocks])
16581715
16591716`rows`:
1660−: table rows
1717+: table rows (a list of rows, each row a list of cells,
1718+ each cell a list of [Blocks])
16611719
1662−Returns: table element
1720+Returns: Table element
16631721
1664−## Inline
1722+## Inlines {#Inlines}
16651723
1666−### `Inline` {#Inline}
1724+### Cite {#Cite}
16671725
1668−Inline element class
1726+`Cite (content, citations)`
16691727
1670−### `Cite (content, citations)` {#Cite}
1671−
1672−Creates a Cite inline element
1728+Creates a Cite element
16731729
16741730Parameters:
16751731
16761732`content`:
1677−: List of inlines
1733+: list of [Inlines]
16781734
16791735`citations`:
1680−: List of citations
1736+: list of [Citation]s
16811737
16821738Returns: citations element
16831739
1684−### `Code (text[, attr])` {#Code}
1740+### Code {#Code}
1741+
1742+`Code (text[, attr])`
16851743
16861744Creates a Code inline element
16871745
16881746Parameters:
16891747
16901748`text`:
1691−: code string
1749+: string (the code)
16921750
16931751`attr`:
1694−: additional attributes
1752+: [Attr]{#Attr} (code attributes)
16951753
1696−Returns: code element
1754+Returns: Code element
16971755
1698−### `Emph (content)` {#Emph}
1756+### Emph {#Emph}
16991757
1700−Creates an inline element representing emphasised text.
1758+`Emph (content)`
1759+
1760+Creates an Emph inline element
17011761
17021762Parameters:
17031763
17041764`content`:
1705−: inline content
1765+: list of [Inlines]
17061766
1707−Returns: emphasis element
1767+Returns: Emph element
17081768
1709−### `Image (caption, src[, title[, attr]])` {#Image}
1769+### Image {#Image}
1770+
1771+`Image (alt, src[, title[, attr]])`
17101772
17111773Creates a Image inline element
17121774
17131775Parameters:
17141776
1715−`caption`:
1716−: text used to describe the image
1777+`alt`:
1778+: list of [Inlines]: alt text (or, for implicit figures,
1779+ caption)
17171780
17181781`src`:
1719−: path to the image file
1782+: string: path to the image file
17201783
17211784`title`:
1722−: brief image description
1785+: string: title attribute
17231786
17241787`attr`:
1725−: additional attributes
1788+: [Attr]{#Attr}: additional image attributes
17261789
1727−Returns: image element
1790+Returns: Image element
1791+
1792+### LineBreak {#LineBreak}
17281793
1729−### `LineBreak ()` {#LineBreak}
1794+`LineBreak ()`
17301795
17311796Create a LineBreak inline element
17321797
17331798Returns: linebreak element
17341799
1735−### `Link (content, target[, title[, attr]])` {#Link}
1800+### Link {#Link}
17361801
1737−Creates a link inline element, usually a hyperlink.
1802+`Link (content, target[, title[, attr]])`
1803+
1804+Creates a Link inline element
17381805
17391806Parameters:
17401807
17411808`content`:
1742−: text for this link
1809+: list of [Inlines]: the linked text
17431810
17441811`target`:
1745−: the link target
1812+: string: the link target
17461813
17471814`title`:
1748−: brief link description
1815+: string: the title attribute
17491816
17501817`attr`:
1751−: additional attributes
1818+: [Attr]{#Attr}: additional link attributes
17521819
17531820Returns: image element
17541821
1755−### `Math (mathtype, text)` {#Math}
1822+### Math {#Math}
1823+
1824+`Math (mathtype, text)`
17561825
1757−Creates a Math element, either inline or displayed.
1826+Creates a Math inline element, either inline or displayed.
17581827
17591828Parameters:
17601829
17611830`mathtype`:
1762−: rendering specifier
1831+: either `pandoc.InlineMath` or `pandoc.DisplayMath`
17631832
17641833`text`:
1765−: Math content
1834+: string: raw tex math
17661835
17671836Returns: Math element
17681837
1769−### `DisplayMath (text)` {#DisplayMath}
1838+### DisplayMath {#DisplayMath}
1839+
1840+`DisplayMath (text)`
17701841
1771−Creates a DisplayMath element (DEPRECATED).
1842+Creates a DisplayMath element (DEPRECATED, use `Math`).
17721843
17731844Parameters:
17741845
17751846`text`:
1776−: Math content
1847+: string: raw tex math
17771848
17781849Returns: Math element
17791850
1780−### `InlineMath (text)` {#InlineMath}
1851+### InlineMath {#InlineMath}
17811852
1782−Creates an InlineMath inline element (DEPRECATED).
1853+`InlineMath (text)`
1854+
1855+Creates an InlineMath inline element (DEPRECATED, use
1856+[Math]{#Math}).
17831857
17841858Parameters:
17851859
17861860`text`:
1787−: Math content
1861+: string: raw tex math
17881862
17891863Returns: Math element
17901864
1791−### `Note (content)` {#Note}
1865+### Note {#Note}
1866+
1867+`Note (content)`
17921868
17931869Creates a Note inline element
17941870
17951871Parameters:
17961872
17971873`content`:
1798−: footnote block content
1874+: list of [Blocks] (content of footnote)
17991875
1800−### `Quoted (quotetype, content)` {#Quoted}
1876+### Quoted {#Quoted}
18011877
1802−Creates a Quoted inline element given the quote type and
1803−quoted content.
1878+`Quoted (quotetype, content)`
1879+
1880+Creates a Quoted inline element
18041881
18051882Parameters:
18061883
18071884`quotetype`:
1808−: type of quotes to be used
1885+: either `pandoc.DoubleQuote` or `pandoc.SingleQuote`
18091886
18101887`content`:
1811−: inline content
1888+: list of [Inlines]
1889+
1890+Returns: Quoted element
18121891
1813−Returns: quoted element
1892+### SingleQuoted {#SingleQuoted}
18141893
1815−### `SingleQuoted (content)` {#SingleQuoted}
1894+`SingleQuoted (content)`
18161895
1817−Creates a single-quoted inline element (DEPRECATED).
1896+Creates a single-quoted inline element (DEPRECATED, use [Quoted]{#Quoted}).
18181897
18191898Parameters:
18201899
18211900`content`:
1822−: inline content
1901+: list of [Inlines]
18231902
1824−Returns: quoted element
1903+Returns: Quoted element
18251904
1826−See also: [Quoted](#Quoted)
1905+### DoubleQuoted {#DoubleQuoted}
18271906
1828−### `DoubleQuoted (content)` {#DoubleQuoted}
1907+`DoubleQuoted (content)`
18291908
1830−Creates a single-quoted inline element (DEPRECATED).
1909+Creates a double-quoted inline element (DEPRECATED, use [Quoted]{#Quoted}).
18311910
18321911Parameters:
18331912
18341913`content`:
1835−: inline content
1914+: list of [Inlines]
18361915
1837−Returns: quoted element
1916+Returns: Quoted element
18381917
1839−See also: [Quoted](#Quoted)
1918+### RawInline {#RawInline}
18401919
1841−### `RawInline (format, text)` {#RawInline}
1920+`RawInline (format, text)`
18421921
18431922Creates a RawInline inline element
18441923
18451924Parameters:
18461925
18471926`format`:
1848−: format of the contents
1927+: string (format of the contents)
18491928
18501929`text`:
1851−: string content
1930+: string (content)
1931+
1932+Returns: RawInline element
18521933
1853−Returns: raw inline element
1934+### Smallcaps {#SmallCaps}
18541935
1855−### `SmallCaps (content)` {#SmallCaps}
1936+`SmallCaps (content)`
18561937
18571938Creates text rendered in small caps
18581939
18591940Parameters:
18601941
18611942`content`:
1862−: inline content
1943+: list of [Inlines]
1944+
1945+Returns: SmallCaps element
18631946
1864−Returns: smallcaps element
1947+### SoftBreak {#SoftBreak}
18651948
1866−### `SoftBreak ()` {#SoftBreak}
1949+`SoftBreak ()`
18671950
18681951Creates a SoftBreak inline element.
18691952
1870−Returns: softbreak element
1953+Returns: SoftBreak element
18711954
1872−### `Space ()` {#Space}
1955+### Space {#Space}
1956+
1957+`Space ()`
18731958
18741959Create a Space inline element
18751960
1876−Returns: space element
1961+Returns: Space element
1962+
1963+### Span {#Span}
18771964
1878−### `Span (content[, attr])` {#Span}
1965+`Span (content[, attr])`
18791966
18801967Creates a Span inline element
18811968
18821969Parameters:
18831970
18841971`content`:
1885−: inline content
1972+: list of [Inlines]
18861973
18871974`attr`:
1888−: additional attributes
1975+: [Attr]{#Attr}: span attributes
18891976
1890−Returns: span element
1977+Returns: Span element
18911978
1892−### `Str (text)` {#Str}
1979+### Str {#Str}
1980+
1981+`Str (text)`
18931982
18941983Creates a Str inline element
18951984
18961985Parameters:
18971986
18981987`text`:
1899−: content
1988+: string
1989+
1990+Returns: String element
19001991
1901−Returns: string element
1992+### Strikeout {#Strikeout}
19021993
1903−### `Strikeout (content)` {#Strikeout}
1994+`Strikeout (content)`
19041995
1905−Creates text which is striked out.
1996+Creates a Strikeout inline element
19061997
19071998Parameters:
19081999
19092000`content`:
1910−: inline content
2001+: list of [Inlines]
2002+
2003+Returns: Strikeout element
19112004
1912−Returns: strikeout element
2005+### Strong {#Strong}
19132006
1914−### `Strong (content)` {#Strong}
2007+`Strong (content)`
19152008
1916−Creates a Strong element, whose text is usually displayed in
1917−a bold font.
2009+Creates a Strong inline element.
19182010
19192011Parameters:
19202012
19212013`content`:
1922−: inline content
2014+: list of [Inlines]
19232015
1924−Returns: strong element
2016+Returns: Strong element
19252017
1926−### `Subscript (content)` {#Subscript}
2018+### Subscript {#Subscript}
2019+
2020+`Subscript (content)`
19272021
19282022Creates a Subscript inline element
19292023
19302024Parameters:
19312025
19322026`content`:
1933−: inline content
2027+: list of [Inlines]
19342028
1935−Returns: subscript element
2029+Returns: Subscript element
19362030
1937−### `Superscript (content)` {#Superscript}
2031+### Superscript {#Superscript}
2032+
2033+`Superscript (content)`
19382034
19392035Creates a Superscript inline element
19402036
19412037Parameters:
19422038
19432039`content`:
1944−: inline content
2040+: list of [Inlines]
19452041
1946−Returns: strong element
2042+Returns: Superscript element
19472043
19482044## Element components
19492045
1950−### `Attr ([identifier[, classes[, attributes]]])` {#Attr}
2046+### Attr {#Attr}
2047+
2048+`Attr ([identifier[, classes[, attributes]]])`
19512049
19522050Create a new set of attributes (Attr).
19532051
19542052Parameters:
19552053
19562054`identifier`:
1957−: element identifier
2055+: string: element identifier
19582056
19592057`classes`:
1960−: element classes
2058+: list of strings: classes
19612059
19622060`attributes`:
19632061: table containing string keys and values
19642062
1965−Returns: element attributes
2063+Returns: Attr
19662064
1967−### `Citation (id, mode[, prefix[, suffix[, note_num[, hash]]]])` {#Citation}
2065+### Citation {#Citation}
19682066
1969−Creates a single citation.
2067+`Citation (id, mode[, prefix[, suffix[, note_num[, hash]]]])`
2068+
2069+Creates a single Citation.
19702070
19712071Parameters:
19722072
19732073`id`:
1974−: citation identifier (like a bibtex key)
2074+: string citation identifier (like a bibtex key)
19752075
19762076`mode`:
1977−: citation mode
2077+: `pandoc.AuthorInText`, `pandoc.SuppressAuthor`, or
2078+ `pandoc.NormalCitation`
19782079
19792080`prefix`:
1980−: citation prefix
2081+: list of [Inlines] for citation prefix
19812082
19822083`suffix`:
1983−: citation suffix
2084+: list of [Inlines] for citation suffix
19842085
19852086`note_num`:
1986−: note number
2087+: int: note number
19872088
19882089`hash`:
1989−: hash number
2090+: int: hash number
2091+
2092+### ListAttributes {#ListAttributes}
19902093
1991−### `ListAttributes ([start[, style[, delimiter]]])` (#ListAttributes)
2094+`ListAttributes ([start[, style[, delimiter]]])`
19922095
19932096Creates a set of list attributes
19942097
19952098Parameters:
19962099
19972100`start`:
1998−: number of the first list item (default: 1)
2101+: int: number of the first list item (default: 1)
19992102
20002103`style`:
2001−: style used for list numbering (default: `DefaultStyle`)
2104+: `pandoc.DefaultStyle` (default), `pandoc.Decimal`,
2105+ `pandoc.LowerRoman`, `pandoc.UpperRoman`, `pandoc.LowerAlpha`,
2106+ or `pandoc.UpperAlpha`
20022107
20032108`delimiter`:
2004−: delimiter of list numbers (default: `DefaultDelim`)
2109+: `pandoc.DefaultDelim` (default), `pandoc.Period`,
2110+ `pandoc.OneParen`, `pandoc.TwoParens`
20052111
20062112Returns: list attributes table
20072113
2008−## Constants
2009−
2010−### `AuthorInText` {#AuthorInText}
2011−
2012−Author name is mentioned in the text.
2013−
2014−See also: [Citation](#Citation)
2015−
2016−### `SuppressAuthor` {#SuppressAuthor}
2017−
2018−Author name is suppressed.
2019−
2020−See also: [Citation](#Citation)
2021−
2022−### `NormalCitation` {#NormalCitation}
2023−
2024−Default citation style is used.
2025−
2026−See also: [Citation](#Citation)
2027−
2028−### `AlignLeft` {#AlignLeft}
2029−
2030−Table cells aligned left.
2031−
2032−See also: [Table](#Table)
2033−
2034−### `AlignRight` {#AlignRight}
2035−
2036−Table cells right-aligned.
2037−
2038−See also: [Table](#Table)
2039−
2040−### `AlignCenter` {#AlignCenter}
2041−
2042−Table cell content is centered.
2043−
2044−See also: [Table](#Table)
2045−
2046−### `AlignDefault` {#AlignDefault}
2047−
2048−Table cells are alignment is unaltered.
2049−
2050−See also: [Table](#Table)
2051−
2052−### `DefaultDelim` {#DefaultDelim}
2053−
2054−Default list number delimiters are used.
2055−
2056−See also: [OrderedList](#OrderedList)
2057−
2058−### `Period` {#Period}
2059−
2060−List numbers are delimited by a period.
2061−
2062−See also: [OrderedList](#OrderedList)
2063−
2064−### `OneParen` {#OneParen}
2065−
2066−List numbers are delimited by a single parenthesis.
2067−
2068−See also: [OrderedList](#OrderedList)
2069−
2070−### `TwoParens` {#TwoParens}
2071−
2072−List numbers are delimited by a double parentheses.
2073−
2074−See also: [OrderedList](#OrderedList)
2075−
2076−### `DefaultStyle` {#DefaultStyle}
2077−
2078−List are numbered in the default style
2079−
2080−See also: [OrderedList](#OrderedList)
2081−
2082−### `Example` {#Example}
2083−
2084−List items are numbered as examples.
2085−
2086−See also: [OrderedList](#OrderedList)
2087−
2088−### `Decimal` {#Decimal}
2089−
2090−List are numbered using decimal integers.
2091−
2092−See also: [OrderedList](#OrderedList)
2093−
2094−### `LowerRoman` {#LowerRoman}
2095−
2096−List are numbered using lower-case roman numerals.
2097−
2098−See also: [OrderedList](#OrderedList)
2099−
2100−### `UpperRoman` {#UpperRoman}
2101−
2102−List are numbered using upper-case roman numerals
2103−
2104−See also: [OrderedList](#OrderedList)
2105−
2106−### `LowerAlpha` {#LowerAlpha}
2107−
2108−List are numbered using lower-case alphabetic characters.
2109−
2110−See also: [OrderedList](#OrderedList)
2111−
2112−### `UpperAlpha` {#UpperAlpha}
2113−
2114−List are numbered using upper-case alphabetic characters.
2115−
2116−See also: [OrderedList](#OrderedList)
2117−
21182114## Helper functions
21192115
2120−### `pipe (command, args, input)` {#pipe}
2116+### pipe {#pipe}
2117+
2118+`pipe (command, args, input)`
21212119
21222120Runs command with arguments, passing it some input, and
21232121returns the output.
@@ -2136,7 +2134,9 @@ Usage:
21362134
21372135 local output = pandoc.pipe("sed", {"-e","s/a/b/"}, "abc")
21382136
2139−### `walk_block (element, filter)` {#walk_block}
2137+### walk_block {#walk_block}
2138+
2139+`walk_block (element, filter)`
21402140
21412141Apply a filter inside a block element, walking its contents.
21422142
@@ -2151,7 +2151,9 @@ Parameters:
21512151
21522152Returns: the transformed block element
21532153
2154−### `walk_inline (element, filter)` {#walk_inline}
2154+### walk_inline {#walk_inline}
2155+
2156+`walk_inline (element, filter)`
21552157
21562158Apply a filter inside an inline element, walking its
21572159contents.
@@ -2167,7 +2169,9 @@ Parameters:
21672169
21682170Returns: the transformed inline element
21692171
2170−### `read (markup[, format])` {#read}
2172+### read {#read}
2173+
2174+`read (markup[, format])`
21712175
21722176Parse the given string into a Pandoc document.
21732177
@@ -2177,7 +2181,7 @@ Parameters:
21772181: the markup to be parsed
21782182
21792183`format`:
2180−: format specification, defaults to \"markdown\".
2184+: format specification, defaults to `"markdown"`.
21812185
21822186Returns: pandoc document
21832187
@@ -2195,23 +2199,25 @@ Usage:
21952199This module exposes internal pandoc functions and utility
21962200functions.
21972201
2198−### `blocks_to_inlines (blocks[, sep])` {#utils-blocks_to_inlines}
2202+### blocks\_to\_inlines {#utils-blocks_to_inlines}
2203+
2204+`blocks_to_inlines (blocks[, sep])`
21992205
22002206Squash a list of blocks into a list of inlines.
22012207
22022208Parameters:
22032209
22042210`blocks`:
2205−: List of blocks to be flattened.
2211+: List of [Blocks] to be flattened.
22062212
22072213`sep`:
2208−: List of inlines inserted as separator between two
2214+: List of [Inlines] inserted as separator between two
22092215 consecutive blocks; defaults to `{ pandoc.Space(),
22102216 pandoc.Str'¶', pandoc.Space()}`.
22112217
22122218Returns:
22132219
2214−- ({[Inline][#Inline]}) List of inlines
2220+- ({[Inline][#Inline]}) List of [Inlines]
22152221
22162222Usage:
22172223
@@ -2226,7 +2232,9 @@ Usage:
22262232 -- pandoc.Emph{ pandoc.Str 'Paragraph2' }
22272233 -- }
22282234
2229−### `equals (element1, element2)` {#utils-equals}
2235+### equals {#utils-equals}
2236+
2237+`equals (element1, element2)`
22302238
22312239Test equality of AST elements. Elements in Lua are considered
22322240equal if and only if the objects obtained by unmarshaling are
@@ -2248,9 +2256,11 @@ Returns:
22482256- Whether the two objects represent the same element
22492257 (boolean)
22502258
2251−### `hierarchicalize (blocks)` {#utils-hierarchicalize}
2259+### hierarchicalize {#utils-hierarchicalize}
22522260
2253−Convert list of blocks into an hierarchical list. An
2261+`hierarchicalize (blocks)`
2262+
2263+Convert list of [Blocks] into an hierarchical list. An
22542264hierarchical elements is either a normal block (but no
22552265Header), or a `Sec` element. The latter has the following
22562266fields:
@@ -2264,7 +2274,7 @@ fields:
22642274
22652275Returns:
22662276
2267−- List of hierarchical elements
2277+- List of hierarchical elements.
22682278
22692279Usage:
22702280
@@ -2276,7 +2286,9 @@ Usage:
22762286 print(table.concat(elements[1].numbering, '.')) -- 0.1
22772287 print(table.concat(elements[2].numbering, '.')) -- 0.2
22782288
2279−### `run_json_filter (doc, filter[, args])` {#utils-run_json_filter}
2289+### run\_json\_filter {#utils-run_json_filter}
2290+
2291+`run_json_filter (doc, filter[, args])`
22802292
22812293Filter the given doc by passing it through the a JSON filter.
22822294
@@ -2307,7 +2319,9 @@ Usage:
23072319 )
23082320 some_blocks = sub_doc.blocks -- some blocks with bib
23092321
2310−### `normalize_date (date_string)` {#utils-normalize_date}
2322+### normalize_date {#utils-normalize_date}
2323+
2324+`normalize_date (date_string)`
23112325
23122326Parse a date and convert (if possible) to "YYYY-MM-DD"
23132327format. We limit years to the range 1601-9999 (ISO 8601
@@ -2318,7 +2332,9 @@ Returns:
23182332
23192333- A date string, or nil when the conversion failed.
23202334
2321−### `sha1 (contents)` {#utils-sha1}
2335+### sha1 {#utils-sha1}
2336+
2337+`sha1 (contents)`
23222338
23232339Returns the SHA1 has of the contents.
23242340
@@ -2330,7 +2346,9 @@ Usage:
23302346
23312347 local fp = pandoc.utils.sha1("foobar")
23322348
2333−### `stringify (element)` {#utils-stringify}
2349+### stringify {#utils-stringify}
2350+
2351+`stringify (element)`
23342352
23352353Converts the given element (Pandoc, Meta, Block, or Inline)
23362354into a string with all formatting removed.
@@ -2345,7 +2363,9 @@ Usage:
23452363 -- outputs "Moin"
23462364 print(pandoc.utils.stringify(inline))
23472365
2348−### `to_roman_numeral (integer)` {#utils-to_roman_numeral}
2366+### to\_roman\_numeral {#utils-to_roman_numeral}
2367+
2368+`to_roman_numeral (integer)`
23492369
23502370Converts an integer \< 4000 to uppercase roman numeral.
23512371
@@ -2365,7 +2385,9 @@ The `pandoc.mediabag` module allows accessing pandoc's media
23652385storage. The "media bag" is used when pandoc is called with the
23662386`--extract-media` or `--standalone`/`-s` option.
23672387
2368−### `insert (filepath, mime_type, contents)` {#mediabag-insert}
2388+### insert {#mediabag-insert}
2389+
2390+`insert (filepath, mime_type, contents)`
23692391
23702392Adds a new entry to pandoc's media bag.
23712393
@@ -2387,7 +2409,9 @@ Usage:
23872409 local contents = "Hello, World!"
23882410 pandoc.mediabag(fp, mt, contents)
23892411
2390−### `list ()` {#mediabag-list}
2412+### list {#mediabag-list}
2413+
2414+`list ()`
23912415
23922416Get a summary of the current media bag contents.
23932417
@@ -2406,7 +2430,9 @@ Usage:
24062430 end
24072431 print(sum)
24082432
2409−### `lookup (filepath)` {#mediabag-lookup}
2433+### lookup {#mediabag-lookup}
2434+
2435+`lookup (filepath)`
24102436
24112437Lookup a media item in the media bag, returning mime type
24122438and contents.
@@ -2426,7 +2452,9 @@ Usage:
24262452 local filename = "media/diagram.png"
24272453 local mt, contents = pandoc.mediabag.lookup(filename)
24282454
2429−### `fetch (source, base_url)` {#mediabag-fetch}
2455+### fetch {#mediabag-fetch}
2456+
2457+`fetch (source, base_url)`
24302458
24312459Fetches the given source from a URL or local file. Returns
24322460two values: the contents of the file and the mime type (or
@@ -2448,7 +2476,9 @@ Pandoc\'s List type and helper methods
24482476
24492477## Metamethods
24502478
2451−### `pandoc.List:__concat (list)` {#pandoc.List:__concat}
2479+### concat {#pandoc.List:__concat}
2480+
2481+`pandoc.List:__concat (list)`
24522482
24532483Concatenates two lists.
24542484
@@ -2462,11 +2492,15 @@ list2
24622492
24632493## Methods
24642494
2495+### clone {#pandoc.List:clone}
2496+
24652497`pandoc.List:clone ()` {#pandoc.List:clone}
24662498
24672499Returns a (shallow) copy of the list.
24682500
2469−### `pandoc.List:includes (needle, init)` {#pandoc.List:includes}
2501+### includes {#pandoc.List:includes}
2502+
2503+`pandoc.List:includes (needle, init)`
24702504
24712505Checks if the list has an item equal to the given needle.
24722506
@@ -2481,7 +2515,9 @@ Parameters:
24812515Returns: true if a list item is equal to the needle, false
24822516otherwise
24832517
2484−### `pandoc.List:find (needle, init)` {#pandoc.List:find}
2518+### find {#pandoc.List:find}
2519+
2520+`pandoc.List:find (needle, init)`
24852521
24862522Returns the value and index of the first occurrence of the
24872523given item.
@@ -2497,7 +2533,9 @@ Parameters:
24972533Returns: first item equal to the needle, or nil if no such
24982534item exists.
24992535
2500−### `pandoc.List:find_if (pred, init)` {#pandoc.List:find_if}
2536+### find_if {#pandoc.List:find_if}
2537+
2538+`pandoc.List:find_if (pred, init)`
25012539
25022540Returns the value and index of the first element for which
25032541the predicate holds true.
@@ -2513,7 +2551,9 @@ Parameters:
25132551Returns: first item for which \`test\` succeeds, or nil if
25142552no such item exists.
25152553
2516−### `pandoc.List:extend (list)` {#pandoc.List:extend}
2554+### extend {#pandoc.List:extend}
2555+
2556+`pandoc.List:extend (list)`
25172557
25182558Adds the given list to the end of this list.
25192559
@@ -2522,7 +2562,9 @@ Parameters:
25222562`list`:
25232563: list to appended
25242564
2525−### `pandoc.List:map (fn)` {#pandoc.List:map}
2565+### map {#pandoc.List:map}
2566+
2567+`pandoc.List:map (fn)`
25262568
25272569Returns a copy of the current list by applying the given
25282570function to all elements.
@@ -2532,7 +2574,9 @@ Parameters:
25322574`fn`:
25332575: function which is applied to all list items.
25342576
2535−### `pandoc.List:filter (pred)` {#pandoc.List:filter}
2577+### filter {#pandoc.List:filter}
2578+
2579+`pandoc.List:filter (pred)`
25362580
25372581Returns a new list containing all items satisfying a given
25382582condition.