diff options
| author | Albert Krewinkel <[email protected]> | 2025-05-28 13:56:08 +0200 |
|---|---|---|
| committer | Albert Krewinkel <[email protected]> | 2025-05-28 13:56:08 +0200 |
| commit | e6bd65ee19301311130ebadf01a2530a4100b461 (patch) | |
| tree | 214e400c686aece8b0c9612b42d8913d8bf1f9d0 /doc | |
| parent | 46081560cccc0b8238d247201dd6da49ef57ff92 (diff) | |
doc/lua-filters.md: Re-generate docs
Pandoc now uses fewer spaces when outputting list items.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lua-filters.md | 411 |
1 files changed, 207 insertions, 204 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md index b2ad38ad5..0c2a7dfcd 100644 --- a/doc/lua-filters.md +++ b/doc/lua-filters.md @@ -2534,7 +2534,7 @@ Parameters: Returns: -- new Pandoc document ([Pandoc]) +- new Pandoc document ([Pandoc]) ### Meta {#pandoc.Meta} @@ -2547,7 +2547,7 @@ Parameters: Returns: -- new Meta table (table) +- new Meta table (table) ### MetaBlocks {#pandoc.MetaBlocks} @@ -2564,7 +2564,7 @@ Parameters: Returns: -- list of Block elements ([Blocks]) +- list of Block elements ([Blocks]) ### MetaBool {#pandoc.MetaBool} @@ -2577,7 +2577,7 @@ Parameters: Returns: -- input, unchanged (boolean) +- input, unchanged (boolean) ### MetaInlines {#pandoc.MetaInlines} @@ -2594,7 +2594,7 @@ Parameters: Returns: -- list of Inline elements ([Inlines]) +- list of Inline elements ([Inlines]) ### MetaList {#pandoc.MetaList} @@ -2611,7 +2611,7 @@ Parameters: Returns: -- list of meta values ([List]{unknown-type="List"}) +- list of meta values ([List]{unknown-type="List"}) ### MetaMap {#pandoc.MetaMap} @@ -2628,7 +2628,7 @@ Parameters: Returns: -- map of meta values (table) +- map of meta values (table) ### MetaString {#pandoc.MetaString} @@ -2645,7 +2645,7 @@ Parameters: Returns: -- unchanged input (string) +- unchanged input (string) ### BlockQuote {#pandoc.BlockQuote} @@ -2660,7 +2660,7 @@ Parameters: Returns: -- BlockQuote element ([Block]) +- BlockQuote element ([Block]) ### BulletList {#pandoc.BulletList} @@ -2675,7 +2675,7 @@ Parameters: Returns: -- BulletList element ([Block]) +- BulletList element ([Block]) ### CodeBlock {#pandoc.CodeBlock} @@ -2693,7 +2693,7 @@ Parameters: Returns: -- CodeBlock element ([Block]) +- CodeBlock element ([Block]) ### DefinitionList {#pandoc.DefinitionList} @@ -2709,7 +2709,7 @@ Parameters: Returns: -- DefinitionList element ([Block]) +- DefinitionList element ([Block]) ### Div {#pandoc.Div} @@ -2727,7 +2727,7 @@ Parameters: Returns: -- Div element ([Block]) +- Div element ([Block]) ### Figure {#pandoc.Figure} @@ -2748,7 +2748,7 @@ Parameters: Returns: -- Figure object ([Block]) +- Figure object ([Block]) ### Header {#pandoc.Header} @@ -2769,7 +2769,7 @@ Parameters: Returns: -- Header element ([Block]) +- Header element ([Block]) ### HorizontalRule {#pandoc.HorizontalRule} @@ -2779,7 +2779,7 @@ Creates a horizontal rule. Returns: -- HorizontalRule element ([Block]) +- HorizontalRule element ([Block]) ### LineBlock {#pandoc.LineBlock} @@ -2794,7 +2794,7 @@ Parameters: Returns: -- LineBlock element ([Block]) +- LineBlock element ([Block]) ### OrderedList {#pandoc.OrderedList} @@ -2812,7 +2812,7 @@ Parameters: Returns: -- OrderedList element ([Block]) +- OrderedList element ([Block]) ### Para {#pandoc.Para} @@ -2827,7 +2827,7 @@ Parameters: Returns: -- Para element ([Block]) +- Para element ([Block]) ### Plain {#pandoc.Plain} @@ -2842,7 +2842,7 @@ Parameters: Returns: -- Plain element ([Block]) +- Plain element ([Block]) ### RawBlock {#pandoc.RawBlock} @@ -2860,7 +2860,7 @@ Parameters: Returns: -- RawBlock element ([Block]) +- RawBlock element ([Block]) ### Table {#pandoc.Table} @@ -2890,7 +2890,7 @@ Parameters: Returns: -- Table element ([Block]) +- Table element ([Block]) ### Blocks {#pandoc.Blocks} @@ -2906,7 +2906,7 @@ Parameters: Returns: -- list of block elements ([Blocks]) +- list of block elements ([Blocks]) ### Cite {#pandoc.Cite} @@ -2924,7 +2924,7 @@ Parameters: Returns: -- cite element ([Inline]) +- cite element ([Inline]) ### Code {#pandoc.Code} @@ -2942,7 +2942,7 @@ Parameters: Returns: -- code element ([Inline]) +- code element ([Inline]) ### Emph {#pandoc.Emph} @@ -2957,7 +2957,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### Image {#pandoc.Image} @@ -2981,7 +2981,7 @@ Parameters: Returns: -- Image element ([Inline]) +- Image element ([Inline]) ### LineBreak {#pandoc.LineBreak} @@ -2991,7 +2991,7 @@ Create a LineBreak inline element Returns: -- line break ([Inline]) +- line break ([Inline]) ### Link {#pandoc.Link} @@ -3015,7 +3015,7 @@ Parameters: Returns: -- link element ([Inline]) +- link element ([Inline]) ### Math {#pandoc.Math} @@ -3033,7 +3033,7 @@ Parameters: Returns: -- math element ([Inline]) +- math element ([Inline]) ### Note {#pandoc.Note} @@ -3048,7 +3048,7 @@ Parameters: Returns: -- note ([Inline]) +- note ([Inline]) ### Quoted {#pandoc.Quoted} @@ -3067,7 +3067,7 @@ Parameters: Returns: -- quoted element ([Inline]) +- quoted element ([Inline]) ### RawInline {#pandoc.RawInline} @@ -3085,7 +3085,7 @@ Parameters: Returns: -- raw inline element ([Inline]) +- raw inline element ([Inline]) ### SmallCaps {#pandoc.SmallCaps} @@ -3100,7 +3100,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### SoftBreak {#pandoc.SoftBreak} @@ -3110,7 +3110,7 @@ Creates a SoftBreak inline element. Returns: -- soft break ([Inline]) +- soft break ([Inline]) ### Space {#pandoc.Space} @@ -3120,7 +3120,7 @@ Create a Space inline element Returns: -- new space ([Inline]) +- new space ([Inline]) ### Span {#pandoc.Span} @@ -3138,7 +3138,7 @@ Parameters: Returns: -- [Span] object ([Inline]) +- [Span] object ([Inline]) ### Str {#pandoc.Str} @@ -3153,7 +3153,7 @@ Parameters: Returns: -- [Str] object ([Inline]) +- [Str] object ([Inline]) ### Strikeout {#pandoc.Strikeout} @@ -3168,7 +3168,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### Strong {#pandoc.Strong} @@ -3184,7 +3184,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### Subscript {#pandoc.Subscript} @@ -3199,7 +3199,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### Superscript {#pandoc.Superscript} @@ -3214,7 +3214,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### Underline {#pandoc.Underline} @@ -3229,7 +3229,7 @@ Parameters: Returns: -- new object ([Inline]) +- new object ([Inline]) ### Inlines {#pandoc.Inlines} @@ -3237,11 +3237,11 @@ Returns: Converts its argument into an [Inlines] list: -- copies a list of [Inline] elements into a fresh list; any - string `s` within the list is treated as `pandoc.Str(s)`; -- turns a single [Inline] into a singleton list; -- splits a string into `Str`-wrapped words, treating interword - spaces as `Space`s or `SoftBreak`s. +- copies a list of [Inline] elements into a fresh list; any string + `s` within the list is treated as `pandoc.Str(s)`; +- turns a single [Inline] into a singleton list; +- splits a string into `Str`-wrapped words, treating interword + spaces as `Space`s or `SoftBreak`s. Parameters: @@ -3251,7 +3251,7 @@ Parameters: Returns: -- list of inline elements ([Inlines]) +- list of inline elements ([Inlines]) ### Attr {#pandoc.Attr} @@ -3273,7 +3273,7 @@ Parameters: Returns: -- new Attr object ([Attr]) +- new Attr object ([Attr]) ### Cell {#pandoc.Cell} @@ -3302,7 +3302,7 @@ Parameters: Returns: -- new Cell object ([Cell]) +- new Cell object ([Cell]) ### AttributeList {#pandoc.AttributeList} @@ -3315,7 +3315,7 @@ Parameters: Returns: -- new AttributeList object ([AttributeList]) +- new AttributeList object ([AttributeList]) ### Citation {#pandoc.Citation} @@ -3346,7 +3346,7 @@ Parameters: Returns: -- new citation object ([Citation]{unknown-type="Citation"}) +- new citation object ([Citation]{unknown-type="Citation"}) ### ListAttributes {#pandoc.ListAttributes} @@ -3368,7 +3368,7 @@ Parameters: Returns: -- new ListAttributes object ([ListAttributes]) +- new ListAttributes object ([ListAttributes]) ### Row {#pandoc.Row} @@ -3386,7 +3386,7 @@ Parameters: Returns: -- new Row object ([Row]) +- new Row object ([Row]) ### TableFoot {#pandoc.TableFoot} @@ -3404,7 +3404,7 @@ Parameters: Returns: -- new TableFoot object ([TableFoot]) +- new TableFoot object ([TableFoot]) ### TableHead {#pandoc.TableHead} @@ -3422,7 +3422,7 @@ Parameters: Returns: -- new TableHead object ([TableHead]) +- new TableHead object ([TableHead]) ### SimpleTable {#pandoc.SimpleTable} @@ -3466,7 +3466,7 @@ Parameters: Returns: -- new SimpleTable object ([SimpleTable]) +- new SimpleTable object ([SimpleTable]) <!-- END: AUTOGENERATED CONTENT --> @@ -3889,7 +3889,7 @@ Parameters: Returns: -- parsed options, using their JSON-like representation. (table) +- parsed options, using their JSON-like representation. (table) *Since: 3.0* @@ -3976,7 +3976,7 @@ Parameters: Returns: -- ([Inlines]) +- ([Inlines]) *Since: 2.2.3* @@ -4002,7 +4002,7 @@ Parameters: Returns: -- processed document ([Pandoc]) +- processed document ([Pandoc]) *Since: 2.19.1* @@ -4027,7 +4027,7 @@ Parameters: Returns: -- Whether the two objects represent the same element (boolean) +- Whether the two objects represent the same element (boolean) *Since: 2.5* @@ -4054,7 +4054,7 @@ Parameters: Returns: -- table block element ([Block]) +- table block element ([Block]) *Since: 2.11* @@ -4085,7 +4085,7 @@ Parameters: Returns: -- blocks with sections ([Blocks]) +- blocks with sections ([Blocks]) *Since: 2.8* @@ -4105,8 +4105,8 @@ Parameters: Returns: -- normalized date, or nil if normalization failed. ([string or - nil]{unknown-type="string or nil"}) +- normalized date, or nil if normalization failed. ([string or + nil]{unknown-type="string or nil"}) *Since: 2.0.6* @@ -4140,7 +4140,7 @@ Parameters: Returns: -- lift of references. (table) +- lift of references. (table) *Since: 2.17* @@ -4164,7 +4164,7 @@ Parameters: Returns: -- filtered document ([Pandoc]) +- filtered document ([Pandoc]) *Since: 2.1.1* @@ -4189,7 +4189,7 @@ Parameters: Returns: -- filtered document ([Pandoc]) +- filtered document ([Pandoc]) *Since: 3.2.1* @@ -4206,7 +4206,7 @@ Parameters: Returns: -- hexadecimal hash value (string) +- hexadecimal hash value (string) *Since: 2.0.6* @@ -4225,7 +4225,7 @@ Parameters: Returns: -- A plain string representation of the given element. (string) +- A plain string representation of the given element. (string) *Since: 2.0.6* @@ -4249,7 +4249,7 @@ Parameters: Returns: -- A roman numeral. (string) +- A roman numeral. (string) *Since: 2.0.6* @@ -4274,7 +4274,7 @@ Parameters: Returns: -- SimpleTable object ([SimpleTable]) +- SimpleTable object ([SimpleTable]) *Since: 2.11* @@ -4309,7 +4309,7 @@ Parameters: Returns: -- type of the given value (string) +- type of the given value (string) *Since: 2.17* @@ -4327,7 +4327,7 @@ Parameters: Returns: -- new Version object ([Version]) +- new Version object ([Version]) <!-- END: AUTOGENERATED CONTENT --> @@ -4394,10 +4394,10 @@ Parameters: Returns: -- The entry's MIME type, or `nil` if the file was not found. - (string) -- Contents of the file, or `nil` if the file was not found. - (string) +- The entry's MIME type, or `nil` if the file was not found. + (string) +- Contents of the file, or `nil` if the file was not found. + (string) *Since: 2.0* @@ -4419,7 +4419,7 @@ Parameters: Returns: -- modified document ([Pandoc]) +- modified document ([Pandoc]) *Since: 2.19* @@ -4473,11 +4473,11 @@ Returns: Iterator triple: -- The iterator function; must be called with the iterator state - and the current iterator value. -- Iterator state -- an opaque value to be passed to the iterator - function. -- Initial iterator value. +- The iterator function; must be called with the iterator state + and the current iterator value. +- Iterator state -- an opaque value to be passed to the iterator + function. +- Initial iterator value. *Since: 2.7.3* @@ -4499,10 +4499,10 @@ Usage: Returns: -- A list of elements summarizing each entry in the media bag. - The summary item contains the keys `path`, `type`, and - `length`, giving the filepath, MIME type, and length of - contents in bytes, respectively. (table) +- A list of elements summarizing each entry in the media bag. The + summary item contains the keys `path`, `type`, and `length`, + giving the filepath, MIME type, and length of contents in bytes, + respectively. (table) *Since: 2.0* @@ -4525,10 +4525,9 @@ Parameters: Returns: -- The entry's MIME type, or nil if the file was not found. - (string) -- Contents of the file, or nil if the file was not found. - (string) +- The entry's MIME type, or nil if the file was not found. + (string) +- Contents of the file, or nil if the file was not found. (string) *Since: 2.0* @@ -4858,8 +4857,8 @@ Parameters: Returns: -- all extensions supported for `format` - ([FormatExtensions]{unknown-type="FormatExtensions"}) +- all extensions supported for `format` + ([FormatExtensions]{unknown-type="FormatExtensions"}) *Since: 3.0* @@ -4878,8 +4877,8 @@ Parameters: Returns: -- default extensions enabled for `format` - ([FormatExtensions]{unknown-type="FormatExtensions"}) +- default extensions enabled for `format` + ([FormatExtensions]{unknown-type="FormatExtensions"}) *Since: 3.0* @@ -4903,7 +4902,7 @@ Parameters: Returns: -- extensions config (table) +- extensions config (table) *Since: 3.0* @@ -4918,7 +4917,7 @@ Parameters: Returns: -- format determined by heuristic (string\|nil) +- format determined by heuristic (string\|nil) *Since: 3.1.2* @@ -4958,7 +4957,7 @@ Parameters: Returns: -- image size information or error message (table) +- image size information or error message (table) *Since: 3.1.13* @@ -4978,8 +4977,8 @@ Parameters: Returns: -- image format, or nil if the format cannot be determined - (string\|nil) +- image format, or nil if the format cannot be determined + (string\|nil) *Since: 3.1.13* @@ -5025,7 +5024,7 @@ Parameters: Returns: -- decoded object (any) +- decoded object (any) *Since: 3.1.1* @@ -5047,7 +5046,7 @@ Parameters: Returns: -- JSON encoding of the given `object` (string) +- JSON encoding of the given `object` (string) *Since: 3.1.1* @@ -5146,7 +5145,7 @@ Parameters: Returns: -- The filepath up to the last directory separator. (string) +- The filepath up to the last directory separator. (string) *Since: 2.12* @@ -5163,7 +5162,7 @@ Parameters: Returns: -- File name part of the input path. (string) +- File name part of the input path. (string) *Since: 2.12* @@ -5180,8 +5179,8 @@ Parameters: Returns: -- `true` iff `filepath` is an absolute path, `false` otherwise. - (boolean) +- `true` iff `filepath` is an absolute path, `false` otherwise. + (boolean) *Since: 2.12* @@ -5198,8 +5197,8 @@ Parameters: Returns: -- `true` iff `filepath` is a relative path, `false` otherwise. - (boolean) +- `true` iff `filepath` is a relative path, `false` otherwise. + (boolean) *Since: 2.12* @@ -5216,7 +5215,7 @@ Parameters: Returns: -- The joined path. (string) +- The joined path. (string) *Since: 2.12* @@ -5242,7 +5241,7 @@ Parameters: Returns: -- contracted filename (string) +- contracted filename (string) *Since: 2.12* @@ -5252,12 +5251,12 @@ Returns: Normalizes a path. -- `//` makes sense only as part of a (Windows) network drive; - elsewhere, multiple slashes are reduced to a single - `path.separator` (platform dependent). -- `/` becomes `path.separator` (platform dependent). -- `./` is removed. -- an empty path becomes `.` +- `//` makes sense only as part of a (Windows) network drive; + elsewhere, multiple slashes are reduced to a single + `path.separator` (platform dependent). +- `/` becomes `path.separator` (platform dependent). +- `./` is removed. +- an empty path becomes `.` Parameters: @@ -5266,7 +5265,7 @@ Parameters: Returns: -- The normalized path. (string) +- The normalized path. (string) *Since: 2.12* @@ -5283,7 +5282,7 @@ Parameters: Returns: -- List of all path components. ({string,\...}) +- List of all path components. ({string,\...}) *Since: 2.12* @@ -5303,8 +5302,8 @@ Parameters: Returns: -- filepath without extension (string) -- extension or empty string (string) +- filepath without extension (string) +- extension or empty string (string) *Since: 2.12* @@ -5323,7 +5322,7 @@ Parameters: Returns: -- list of directories in search path ({string,\...}) +- list of directories in search path ({string,\...}) *Since: 2.12* @@ -5385,7 +5384,7 @@ Parameters: Returns: -- processed blocks ([Blocks]) +- processed blocks ([Blocks]) *Since: 3.0* @@ -5404,7 +5403,7 @@ Parameters: Returns: -- slide level ([integer]{unknown-type="integer"}) +- slide level ([integer]{unknown-type="integer"}) *Since: 3.0* @@ -5453,7 +5452,7 @@ Parameters: Returns: -- ([ChunkedDoc]) +- ([ChunkedDoc]) *Since: 3.0* @@ -5474,7 +5473,7 @@ Parameters: Returns: -- Table of contents as a BulletList object ([Block]) +- Table of contents as a BulletList object ([Block]) *Since: 3.0* @@ -5494,9 +5493,10 @@ The machine architecture on which the program is running. (string) ### os {#pandoc.system.os} -The operating system on which the program is running. (string) -The most common values are `darwin` (macOS), `freebsd`, `linux`, +The operating system on which the program is running. The most +common values are `darwin` (macOS), `freebsd`, `linux`, `linux-android`, `mingw32` (Windows), `netbsd`, `openbsd`. +(string) ## Functions {#pandoc.system-functions} @@ -5510,7 +5510,7 @@ versions and on different platforms. Returns: -- CPU time in picoseconds ([integer]{unknown-type="integer"}) +- CPU time in picoseconds ([integer]{unknown-type="integer"}) *Since: 3.1.1* @@ -5522,8 +5522,8 @@ Retrieves the entire environment as a string-indexed table. Returns: -- A table mapping environment variable names to their value. - (table) +- A table mapping environment variable names to their value. + (table) *Since: 2.7.3* @@ -5535,7 +5535,7 @@ Obtain the current working directory as an absolute path. Returns: -- The current working directory. (string) +- The current working directory. (string) *Since: 2.8* @@ -5553,8 +5553,8 @@ Parameters: Returns: -- A table of all entries in `directory`, except for the special - entries (`.` and `..`). (table) +- A table of all entries in `directory`, except for the special + entries (`.` and `..`). (table) *Since: 2.19* @@ -5722,7 +5722,7 @@ Parameters: Returns: -- new doc ([Doc]) +- new doc ([Doc]) *Since: 2.18* @@ -5740,7 +5740,7 @@ Parameters: Returns: -- conditional doc ([Doc]) +- conditional doc ([Doc]) *Since: 2.18* @@ -5757,7 +5757,7 @@ Parameters: Returns: -- conditional blank lines ([Doc]) +- conditional blank lines ([Doc]) *Since: 2.18* @@ -5774,7 +5774,7 @@ Parameters: Returns: -- `doc` enclosed by {}. ([Doc]) +- `doc` enclosed by {}. ([Doc]) *Since: 2.18* @@ -5791,7 +5791,7 @@ Parameters: Returns: -- doc enclosed by \[\]. ([Doc]) +- doc enclosed by \[\]. ([Doc]) *Since: 2.18* @@ -5812,8 +5812,8 @@ Parameters: Returns: -- doc, aligned centered in a block with max `width` chars per - line. ([Doc]) +- doc, aligned centered in a block with max `width` chars per + line. ([Doc]) *Since: 2.18* @@ -5830,7 +5830,7 @@ Parameters: Returns: -- `doc` without trailing blanks ([Doc]) +- `doc` without trailing blanks ([Doc]) *Since: 2.18* @@ -5850,7 +5850,7 @@ Parameters: Returns: -- concatenated doc ([Doc]) +- concatenated doc ([Doc]) *Since: 2.18* @@ -5867,7 +5867,7 @@ Parameters: Returns: -- `doc` enclosed by `"` chars ([Doc]) +- `doc` enclosed by `"` chars ([Doc]) *Since: 2.18* @@ -5884,7 +5884,7 @@ Parameters: Returns: -- flushed `doc` ([Doc]) +- flushed `doc` ([Doc]) *Since: 2.18* @@ -5907,8 +5907,8 @@ Parameters: Returns: -- `doc` prefixed by `start` on the first line, subsequent lines - indented by `ind` spaces. ([Doc]) +- `doc` prefixed by `start` on the first line, subsequent lines + indented by `ind` spaces. ([Doc]) *Since: 2.18* @@ -5931,7 +5931,7 @@ Parameters: Returns: -- enclosed contents ([Doc]) +- enclosed contents ([Doc]) *Since: 2.18* @@ -5952,7 +5952,7 @@ Parameters: Returns: -- doc put into block with max `width` chars per line. ([Doc]) +- doc put into block with max `width` chars per line. ([Doc]) *Since: 2.18* @@ -5969,7 +5969,7 @@ Parameters: Returns: -- doc containing just the literal string ([Doc]) +- doc contatining just the literal string ([Doc]) *Since: 2.18* @@ -5989,7 +5989,7 @@ Parameters: Returns: -- `doc` indented by `ind` spaces ([Doc]) +- `doc` indented by `ind` spaces ([Doc]) *Since: 2.18* @@ -6006,7 +6006,7 @@ Parameters: Returns: -- `doc` with leading blanks removed ([Doc]) +- `doc` with leading blanks removed ([Doc]) *Since: 2.18* @@ -6023,7 +6023,7 @@ Parameters: Returns: -- same as input, but non-reflowable ([Doc]) +- same as input, but non-reflowable ([Doc]) *Since: 2.18* @@ -6040,7 +6040,7 @@ Parameters: Returns: -- doc enclosed by (). ([Doc]) +- doc enclosed by (). ([Doc]) *Since: 2.18* @@ -6061,7 +6061,7 @@ Parameters: Returns: -- prefixed `doc` ([Doc]) +- prefixed `doc` ([Doc]) *Since: 2.18* @@ -6078,7 +6078,7 @@ Parameters: Returns: -- doc enclosed in `'`. ([Doc]) +- doc enclosed in `'`. ([Doc]) *Since: 2.18* @@ -6099,8 +6099,8 @@ Parameters: Returns: -- doc, right aligned in a block with max `width` chars per line. - ([Doc]) +- doc, right aligned in a block with max `width` chars per line. + ([Doc]) *Since: 2.18* @@ -6118,7 +6118,7 @@ Parameters: Returns: -- automatically expanding border Doc ([Doc]) +- automatically expanding border Doc ([Doc]) *Since: 2.18* @@ -6147,7 +6147,7 @@ Parameters: Returns: -- rendered doc (string) +- rendered doc (string) *Since: 2.18* @@ -6164,8 +6164,8 @@ Parameters: Returns: -- `true` iff `doc` is the empty document, `false` otherwise. - (boolean) +- `true` iff `doc` is the empty document, `false` otherwise. + (boolean) *Since: 2.18* @@ -6182,7 +6182,7 @@ Parameters: Returns: -- doc height ([integer]{unknown-type="integer"}\|string) +- doc height ([integer]{unknown-type="integer"}\|string) *Since: 2.18* @@ -6200,8 +6200,8 @@ Parameters: Returns: -- minimal possible width - ([integer]{unknown-type="integer"}\|string) +- minimal possible width + ([integer]{unknown-type="integer"}\|string) *Since: 2.18* @@ -6218,7 +6218,7 @@ Parameters: Returns: -- doc width ([integer]{unknown-type="integer"}\|string) +- doc width ([integer]{unknown-type="integer"}\|string) *Since: 2.18* @@ -6237,7 +6237,7 @@ Parameters: Returns: -- text length ([integer]{unknown-type="integer"}\|string) +- text length ([integer]{unknown-type="integer"}\|string) *Since: 2.18* @@ -6258,7 +6258,7 @@ Parameters: Returns: -- column number ([integer]{unknown-type="integer"}\|string) +- column number ([integer]{unknown-type="integer"}\|string) *Since: 2.18* @@ -6275,7 +6275,7 @@ Parameters: Returns: -- bolded Doc ([Doc]) +- bolded Doc ([Doc]) *Since: 3.4.1* @@ -6292,7 +6292,7 @@ Parameters: Returns: -- styled Doc ([Doc]) +- styled Doc ([Doc]) *Since: 3.4.1* @@ -6309,7 +6309,7 @@ Parameters: Returns: -- styled Doc ([Doc]) +- styled Doc ([Doc]) *Since: 3.4.1* @@ -6326,7 +6326,7 @@ Parameters: Returns: -- styled Doc ([Doc]) +- styled Doc ([Doc]) *Since: 3.4.1* @@ -6347,7 +6347,7 @@ Parameters: Returns: -- styled Doc ([Doc]) +- styled Doc ([Doc]) *Since: 3.4.1* @@ -6368,7 +6368,7 @@ Parameters: Returns: -- styled Doc ([Doc]) +- styled Doc ([Doc]) *Since: 3.4.1* @@ -6439,7 +6439,7 @@ Parameters: Returns: -- UTF-8 string (string) +- UTF-8 string (string) *Since: 3.0* @@ -6457,7 +6457,7 @@ Parameters: Returns: -- length ([integer]{unknown-type="integer"}\|string) +- length ([integer]{unknown-type="integer"}\|string) *Since: 2.0.3* @@ -6474,7 +6474,7 @@ Parameters: Returns: -- Lowercase copy of `s` (string) +- Lowercase copy of `s` (string) *Since: 2.0.3* @@ -6491,7 +6491,7 @@ Parameters: Returns: -- Reversed `s` (string) +- Reversed `s` (string) *Since: 2.0.3* @@ -6515,7 +6515,7 @@ Parameters: Returns: -- text substring (string) +- text substring (string) *Since: 2.0.3* @@ -6542,7 +6542,7 @@ Parameters: Returns: -- re-encoded string (string) +- re-encoded string (string) *Since: 3.0* @@ -6559,7 +6559,7 @@ Parameters: Returns: -- Uppercase copy of `s` (string) +- Uppercase copy of `s` (string) *Since: 2.0.3* @@ -6593,7 +6593,7 @@ Parameters: Returns: -- rendered template ([Doc]) +- rendered template ([Doc]) *Since: 3.0* @@ -6623,7 +6623,7 @@ Parameters: Returns: -- compiled template ([Template]) +- compiled template ([Template]) *Since: 2.17* @@ -6642,7 +6642,7 @@ Parameters: Returns: -- raw template (string) +- raw template (string) *Since: 2.17* @@ -6664,7 +6664,7 @@ Parameters: Returns: -- content of template file (string) +- content of template file (string) *Since: 3.2.1* @@ -6689,10 +6689,14 @@ Parameters: Returns: -- template context (table) +- template context (table) *Since: 3.0* +## Types {#pandoc.template-types} + +### Template {#type-pandoc.Template} + <!-- END: AUTOGENERATED CONTENT --> <!-- BEGIN: AUTOGENERATED CONTENT for module pandoc.types --> @@ -6716,7 +6720,7 @@ Parameters: Returns: -- New Version object. ([Version]) +- New Version object. ([Version]) *Since: 2.7.3* @@ -6734,15 +6738,14 @@ like the `zip` function described below. Zip options are optional; when defined, they must be a table with any of the following keys: -- `recursive`: recurse directories when set to `true`; -- `verbose`: print info messages to stdout; -- `destination`: the value specifies the directory in which to - extract; -- `location`: value is used as path name, defining where files - are placed. -- `preserve_symlinks`: Boolean value, controlling whether - symbolic links are preserved as such. This option is ignored - on Windows. +- `recursive`: recurse directories when set to `true`; +- `verbose`: print info messages to stdout; +- `destination`: the value specifies the directory in which to + extract; +- `location`: value is used as path name, defining where files are + placed. +- `preserve_symlinks`: Boolean value, controlling whether symbolic + links are preserved as such. This option is ignored on Windows. ## Functions {#pandoc.zip-functions} @@ -6762,7 +6765,7 @@ Parameters: Returns: -- new Archive ([zip.Archive]) +- new Archive ([zip.Archive]) *Since: 3.0* @@ -6786,7 +6789,7 @@ Parameters: Returns: -- a new zip archive entry ([zip.Entry]) +- a new zip archive entry ([zip.Entry]) *Since: 3.0* @@ -6806,7 +6809,7 @@ Parameters: Returns: -- a new zip archive entry ([zip.Entry]) +- a new zip archive entry ([zip.Entry]) *Since: 3.0* @@ -6827,7 +6830,7 @@ Parameters: Returns: -- a new archive ([zip.Archive]) +- a new archive ([zip.Archive]) *Since: 3.0* @@ -6856,7 +6859,7 @@ Parameters: Returns: -- bytes of the archive (string) +- bytes of the archive (string) ##### extract {#pandoc.zip.Archive.extract} @@ -6908,7 +6911,7 @@ Parameters: Returns: -- binary contents (string) +- binary contents (string) ##### symlink {#pandoc.zip.Entry.symlink} @@ -6924,7 +6927,7 @@ Parameters: Returns: -- link target if entry represents a symbolic link (string\|nil) +- link target if entry represents a symbolic link (string\|nil) <!-- END: AUTOGENERATED CONTENT --> |
