Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

Lua filter docs: render field names as code

Browse source
This commit is contained in:
Albert Krewinkel 2018-10-15 22:52:02 +02:00
parent d9f179f7f2
commit f6559e5def
1 changed files with 131 additions and 131 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

262
doc/lua-filter-types-and-objects.md
View file

@ -4,10 +4,10 @@
## Pandoc ## Pandoc
blocks `blocks`
: document content ([list] of [blocks]) : document content ([list] of [blocks])
meta `meta`
: document meta information ([Meta] object) : document meta information ([Meta] object)
@ -28,7 +28,7 @@ A list of blocks usable as meta value ([list] of [blocks])
Fields: Fields:
tag, t `tag`, `t`
: the literal `MetaBlocks` (string) : the literal `MetaBlocks` (string)
### MetaBool ### MetaBool
@ -41,7 +41,7 @@ List of inlines used in metadata ([list] of [inline]s)
Fields: Fields:
tag, t `tag`, `t`
: the literal `MetaInlines` (string) : the literal `MetaInlines` (string)
### MetaList ### MetaList
@ -50,7 +50,7 @@ A list of other [meta value]s. ([list])
Fields: Fields:
tag, t `tag`, `t`
: the literal `MetaList` (string) : the literal `MetaList` (string)
### MetaMap ### MetaMap
@ -59,7 +59,7 @@ A string-indexed map of meta-values. (table)
Fields: Fields:
tag, t `tag`, `t`
: the literal `MetaMap` (string) : the literal `MetaMap` (string)
*Note*: The fields will be shadowed if the map contains a field *Note*: The fields will be shadowed if the map contains a field
@ -79,96 +79,96 @@ A block quote element
content: content:
: block content ([list] of [blocks]) : block content ([list] of [blocks])
tag, t `tag`, `t`
: the literal `BlockQuote` (string) : the literal `BlockQuote` (string)
### BulletList ### BulletList
A bullet list A bullet list
content `content`
: list of items ([list] of [blocks]) : list of items ([list] of [blocks])
tag, t `tag`, `t`
: the literal `BulletList` (string) : the literal `BulletList` (string)
### CodeBlock ### CodeBlock
Block of code. Block of code.
text `text`
: code string (string) : code string (string)
attr `attr`
: element attributes (Attr) : element attributes (Attr)
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `CodeBlock` (string) : the literal `CodeBlock` (string)
### DefinitionList ### DefinitionList
Definition list, containing terms and their explanation. Definition list, containing terms and their explanation.
content `content`
: list of items : list of items
tag, t `tag`, `t`
: the literal `DefinitionList` (string) : the literal `DefinitionList` (string)
### Div ### Div
Generic block container with attributes Generic block container with attributes
content `content`
: block content ([list] of [blocks]) : block content ([list] of [blocks])
attr `attr`
: element attributes (Attr) : element attributes (Attr)
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `Div` (string) : the literal `Div` (string)
### Header ### Header
Creates a header element. Creates a header element.
level `level`
: header level (integer) : header level (integer)
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
attr `attr`
: element attributes (Attr) : element attributes (Attr)
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `Header` (string) : the literal `Header` (string)
@ -176,7 +176,7 @@ tag, t
A horizontal rule. A horizontal rule.
tag, t `tag`, `t`
: the literal `HorizontalRule` (string) : the literal `HorizontalRule` (string)
### LineBlock ### LineBlock
@ -184,10 +184,10 @@ tag, t
A line block, i.e. a list of lines, each separated from the next A line block, i.e. a list of lines, each separated from the next
by a newline. by a newline.
content `content`
: inline content : inline content
tag, t `tag`, `t`
: the literal `LineBlock` (string) : the literal `LineBlock` (string)
### Null ### Null
@ -195,7 +195,7 @@ tag, t
A null element; this element never produces any output in the A null element; this element never produces any output in the
target format. target format.
tag, t `tag`, `t`
: the literal `Null` (string) : the literal `Null` (string)
### OrderedList ### OrderedList
@ -204,55 +204,55 @@ An ordered list.
Parameters: Parameters:
items `items`
: list items ([list] of [blocks]) : list items ([list] of [blocks])
listAttributes `listAttributes`
: list parameters (ListAttributes) : list parameters (ListAttributes)
start `start`
: alias for `listAttributes.start` (integer) : alias for `listAttributes.start` (integer)
style `style`
: alias for `listAttributes.style` (string) : alias for `listAttributes.style` (string)
delimiter `delimiter`
: alias for `listAttributes.delimiter` (string) : alias for `listAttributes.delimiter` (string)
tag, t `tag`, `t`
: the literal `OrderedList` (string) : the literal `OrderedList` (string)
### Para ### Para
A paragraph A paragraph
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Para` (string) : the literal `Para` (string)
### Plain ### Plain
Plain text, not a paragraph Plain text, not a paragraph
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Plain` (string) : the literal `Plain` (string)
### RawBlock ### RawBlock
Raw content of a specified format. Raw content of a specified format.
format `format`
: format of content (string) : format of content (string)
text `text`
: raw content (string) : raw content (string)
tag, t `tag`, `t`
: the literal `RawBlock` (string) : the literal `RawBlock` (string)
### Table ### Table
@ -268,13 +268,13 @@ aligns:
widths: widths:
: column widths : column widths
headers `headers`
: header row : header row
rows: rows:
: table rows : table rows
tag, t `tag`, `t`
: the literal `Table` (string) : the literal `Table` (string)
## Inline ## Inline
@ -282,235 +282,235 @@ tag, t
### Cite ### Cite
Citation Citation
content `content`
: ([list] of [inlines]) : ([list] of [inlines])
citations `citations`
: citation entries ([list] of [citations]) : citation entries ([list] of [citations])
tag, t `tag`, `t`
: the literal `Cite` (string) : the literal `Cite` (string)
### Code ### Code
Inline code Inline code
text `text`
: code string (string) : code string (string)
attr `attr`
: attributes ([Attr]) : attributes ([Attr])
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `Code` (string) : the literal `Code` (string)
### Emph ### Emph
Emphasized text Emphasized text
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Emph` (string) : the literal `Emph` (string)
### Image ### Image
Image: alt text (list of inlines), target Image: alt text (list of inlines), target
attr `attr`
: attributes ([Attr]) : attributes ([Attr])
caption `caption`
: text used to describe the image ([list] of [inlines]) : text used to describe the image ([list] of [inlines])
src `src`
: path to the image file (string) : path to the image file (string)
title `title`
: brief image description : brief image description
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `Image` (string) : the literal `Image` (string)
### LineBreak ### LineBreak
Hard line break Hard line break
tag, t `tag`, `t`
: the literal `LineBreak` (string) : the literal `LineBreak` (string)
### Link ### Link
Hyperlink: alt text (list of inlines), target Hyperlink: alt text (list of inlines), target
attr `attr`
: attributes ([Attr]) : attributes ([Attr])
content `content`
: text for this link ([list] of [inlines]) : text for this link ([list] of [inlines])
target `target`
: the link target (string) : the link target (string)
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `Link` (string) : the literal `Link` (string)
### Math ### Math
TeX math (literal) TeX math (literal)
mathype `mathype`
: specifier determining whether the math content should be : specifier determining whether the math content should be
shown inline (`InlineMath`) or on a separate line shown inline (`InlineMath`) or on a separate line
(`DisplayMath`) (string) (`DisplayMath`) (string)
text `text`
: math content (string) : math content (string)
tag, t `tag`, `t`
: the literal `Math` (string) : the literal `Math` (string)
### Note ### Note
Footnote or endnote Footnote or endnote
content `content`
: ([list] of [blocks]) : ([list] of [blocks])
tag, t `tag`, `t`
: the literal `Note` (string) : the literal `Note` (string)
### Quoted ### Quoted
Quoted text Quoted text
quotetype `quotetype`
: type of quotes to be used; one of `SingleQuote` or : type of quotes to be used; one of `SingleQuote` or
`DoubleQuote` (string) `DoubleQuote` (string)
content `content`
: quoted text ([list] of [inlines]) : quoted text ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Quoted` (string) : the literal `Quoted` (string)
### RawInline ### RawInline
Raw inline Raw inline
format `format`
: the format of the content (string) : the format of the content (string)
text `text`
: raw content (string) : raw content (string)
tag, t `tag`, `t`
: the literal `RawInline` (string) : the literal `RawInline` (string)
### SmallCaps ### SmallCaps
Small caps text Small caps text
content `content`
: ([list] of [inlines]) : ([list] of [inlines])
tag, t `tag`, `t`
: the literal `SmallCaps` (string) : the literal `SmallCaps` (string)
### SoftBreak ### SoftBreak
Soft line break Soft line break
tag, t `tag`, `t`
: the literal `SoftBreak` (string) : the literal `SoftBreak` (string)
### Space ### Space
Inter-word space Inter-word space
tag, t `tag`, `t`
: the literal `Space` (string) : the literal `Space` (string)
### Span ### Span
Generic inline container with attributes Generic inline container with attributes
attr `attr`
: attributes ([Attr]) : attributes ([Attr])
content `content`
: wrapped content ([list] of [inlines]) : wrapped content ([list] of [inlines])
identifier `identifier`
: alias for `attr.identifier` (string) : alias for `attr.identifier` (string)
classes `classes`
: alias for `attr.classes` ([list] of strings) : alias for `attr.classes` ([list] of strings)
attributes `attributes`
: alias for `attr.attributes` ([attributes]) : alias for `attr.attributes` ([attributes])
tag, t `tag`, `t`
: the literal `Span` (string) : the literal `Span` (string)
### Str ### Str
Text Text
text `text`
: content (string) : content (string)
tag, t `tag`, `t`
: the literal `Str` (string) : the literal `Str` (string)
### Strikeout ### Strikeout
Strikeout text Strikeout text
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Strikeout` (string) : the literal `Strikeout` (string)
### Strong ### Strong
Strongly emphasized text Strongly emphasized text
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Strong` (string) : the literal `Strong` (string)
### Subscript ### Subscript
Subscripted text Subscripted text
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Subscript` (string) : the literal `Subscript` (string)
### Superscript ### Superscript
Superscripted text Superscripted text
content `content`
: inline content ([list] of [inlines]) : inline content ([list] of [inlines])
tag, t `tag`, `t`
: the literal `Superscript` (string) : the literal `Superscript` (string)
## Attributes ## Attributes
@ -522,37 +522,37 @@ indices to the list table.
Single citation entry Single citation entry
id `id`
: citation identifier, e.g., a bibtex key (string) : citation identifier, e.g., a bibtex key (string)
mode `mode`
: citation mode, one of `AuthorInText`, `SuppressAuthor`, or : citation mode, one of `AuthorInText`, `SuppressAuthor`, or
`NormalCitation` (string) `NormalCitation` (string)
prefix `prefix`
: citation prefix ([list] of [inlines]) : citation prefix ([list] of [inlines])
suffix `suffix`
: citation suffix ([list] of [inlines]) : citation suffix ([list] of [inlines])
note_num `note_num`
: note number (integer) : note number (integer)
hash `hash`
: hash (integer) : hash (integer)
## ListAttributes ## ListAttributes
List attributes List attributes
start `start`
: number of the first list item (integer) : number of the first list item (integer)
style `style`
: style used for list numbers; possible values are `DefaultStyle`, : style used for list numbers; possible values are `DefaultStyle`,
`Example`, `Decimal`, `LowerRoman`, `UpperRoman`, `Example`, `Decimal`, `LowerRoman`, `UpperRoman`,
`LowerAlpha`, and `UpperAlpha` (string) `LowerAlpha`, and `UpperAlpha` (string)
delimiter `delimiter`
: delimiter of list numbers; one of `DefaultDelim`, `Period`, : delimiter of list numbers; one of `DefaultDelim`, `Period`,
`OneParen`, and `TwoParens` (string) `OneParen`, and `TwoParens` (string)
@ -568,57 +568,57 @@ document contents.
**Objects of this type are read-only.*** **Objects of this type are read-only.***
level `level`
: header level (integer) : header level (integer)
numbering `numbering`
: section numbering ([list] of integers) : section numbering ([list] of integers)
attr `attr`
: header attributes ([attributes]) : header attributes ([attributes])
label `label`
: header content ([list] of [inlines]) : header content ([list] of [inlines])
contents `contents`
: list of contents in this section ([list] of hierarchical elements) : list of contents in this section ([list] of hierarchical elements)
t, tag `tag`, `t`
: constant `Sec` (string) : constant `Sec` (string)
## ReaderOptions ## ReaderOptions
Pandoc reader options Pandoc reader options
abbreviations `abbreviations`
: set of known abbreviations (set of strings) : set of known abbreviations (set of strings)
columns `columns`
: number of columns in terminal (integer) : number of columns in terminal (integer)
default_image_extension `default_image_extension`
: default extension for images (string) : default extension for images (string)
extensions `extensions`
: string representation of the syntax extensions bit field : string representation of the syntax extensions bit field
(string) (string)
indented_code_classes `indented_code_classes`
: default classes for indented code blocks (list of strings) : default classes for indented code blocks (list of strings)
standalone `standalone`
: whether the input was a standalone document with header : whether the input was a standalone document with header
(boolean) (boolean)
strip_comments `strip_comments`
: HTML comments are stripped instead of parsed as raw HTML : HTML comments are stripped instead of parsed as raw HTML
(boolean) (boolean)
tab_stop `tab_stop`
: width (i.e. equivalent number of spaces) of tab stops : width (i.e. equivalent number of spaces) of tab stops
(integer) (integer)
track_changes `track_changes`
: track changes setting for docx; one of `AcceptChanges`, : track changes setting for docx; one of `AcceptChanges`,
`RejectChanges`, and `AllChanges` (string) `RejectChanges`, and `AllChanges` (string)