From 36a6a40ef7db36686630adf8ccb18a0fa252768f Mon Sep 17 00:00:00 2001 From: Albert Krewinkel Date: Sat, 6 Oct 2018 21:47:05 +0200 Subject: Documentation: add draft for Lua objects reference --- doc/lua-filter-types-and-objects.md | 396 ++++++++++++++++++++++++++++++++++++ 1 file changed, 396 insertions(+) create mode 100644 doc/lua-filter-types-and-objects.md diff --git a/doc/lua-filter-types-and-objects.md b/doc/lua-filter-types-and-objects.md new file mode 100644 index 000000000..f6d11a928 --- /dev/null +++ b/doc/lua-filter-types-and-objects.md @@ -0,0 +1,396 @@ +% Lua filter types and objects +% Albert Krewinkel +% Oct 6, 2018 + +## Pandoc + +blocks +: document content ([list] of [blocks]) + +meta +: document meta information ([Meta] object) + + +## Meta + +Meta information on a document; string-indexed collection of [meta +values](#metavalue). This is represented as a string-indexed table containing +[meta values](#MetaValue). + + +## MetaValue + +Document meta information items. + +### MetaBlocks + +blocks +: a list of blocks usable as meta value ([list] of [blocks]) + + +## Block + +### BlockQuote + +A block quote element + +content: +: block content ([list] of [blocks]) + +tag, t +: the literal `BlockQuote` (string) + +### BulletList + +A bullet list + +content +: list of items ([list] of [blocks]) + +tag, t +: the literal `BlockQuote` (string) + +### CodeBlock + +Block of code. + +text +: code string (string) + +attr +: element attributes (Attr) + +identifier +: alias for `attr.identifier` (string) + +classes +: alias for `attr.classes` ([list] of strings) + +attributes +: alias for `attr.attributes` ([attributes]) + +tag, t +: the literal `CodeBlock` (string) + +### DefinitionList + +Definition list, containing terms and their explanation. + +content +: list of items + +tag, t +: the literal `DefinitionList` (string) + +### Div + +Generic block container with attributes + +content +: block content ([list] of [blocks]) + +attr +: element attributes (Attr) + +identifier +: alias for `attr.identifier` (string) + +classes +: alias for `attr.classes` ([list] of strings) + +attributes +: alias for `attr.attributes` ([attributes]) + +tag, t +: the literal `Div` (string) + +### Header + +Creates a header element. + +level +: header level (integer) + +content +: inline content ([list] of [inlines]) + +attr +: element attributes (Attr) + +identifier +: alias for `attr.identifier` (string) + +classes +: alias for `attr.classes` ([list] of strings) + +attributes +: alias for `attr.attributes` ([attributes]) + +tag, t +: the literal `Header` (string) + + +### HorizontalRule + +A horizontal rule. + +tag, t +: the literal `HorizontalRule` (string) + +### LineBlock + +A line block, i.e. a list of lines, each separated from the next +by a newline. + +content +: inline content + +tag, t +: the literal `LineBlock` (string) + +### Null + +A null element; this element never produces any output in the +target format. + +tag, t +: the literal `Null` (string) + +### OrderedList + +An ordered list. + +Parameters: + +items +: list items ([list] of [blocks]) + +listAttributes +: list parameters + +tag, t +: the literal `OrderedList` (string) + +### Para + +A paragraph + +content +: inline content + +tag, t +: the literal `Para` (string) + +### Plain + +Plain text, not a paragraph + +content +: inline content + +tag, t +: the literal `Plain` (string) + +### RawBlock + +Raw content of a specified format. + +format +: format of content (string) + +text +: raw content (string) + +tag, t +: the literal `RawBlock` (string) + +### Table + +A table. + +caption: +: table caption + +aligns: +: alignments + +widths: +: column widths + +headers +: header row + +rows: +: table rows + +tag, t +: the literal `Table` (string) + +## Inline + +### Cite +Citation + +content +: ([list] of [inlines]) + +citations +: citation entries ([list] of [citations]) + +tag, t +: the literal `Cite` (string) + +### Code +Inline code + +text +: code string (string) + +attr +: attributes ([Attr]) + +identifier +: alias for `attr.identifier` (string) + +classes +: alias for `attr.classes` ([list] of strings) + +attributes +: alias for `attr.attributes` ([attributes]) + +tag, t +: the literal `Code` (string) + +### Emph +Emphasized text + +content +: inline content ([list] of [inlines]) + +tag, t +: the literal `Emph` (string) + + + +### Image +Image: alt text (list of inlines), target + +tag, t +: the literal `Image` (string) + +### Link +Hyperlink: alt text (list of inlines), target + +tag, t +: the literal `Link` (string) + +### LineBreak +Hard line break + +tag, t +: the literal `LineBreak` (string) + +### Math +TeX math (literal) + +tag, t +: the literal `Math` (string) + +### Note +Footnote or endnote + +tag, t +: the literal `Note` (string) + +### Quoted +Quoted text (list of inlines) + +tag, t +: the literal `Quoted` (string) + +### RawInline +Raw inline + +tag, t +: the literal `RawInline` (string) + +### SmallCaps +Small caps text (list of inlines) + +tag, t +: the literal `SmallCaps` (string) + +### SoftBreak +Soft line break + +tag, t +: the literal `SoftBreak` (string) + +### Space +Inter-word space + +tag, t +: the literal `Space` (string) + +### Span +Generic inline container with attributes + +attr +: attributes ([Attr]) + +identifier +: alias for `attr.identifier` (string) + +classes +: alias for `attr.classes` ([list] of strings) + +attributes +: alias for `attr.attributes` ([attributes]) + +tag, t +: the literal `Span` (string) + +### Str +Text (string) + +tag, t +: the literal `Str` (string) + +### Strikeout +Strikeout text (list of inlines) + +tag, t +: the literal `Strikeout` (string) + +### Strong +Strongly emphasized text (list of inlines) + +tag, t +: the literal `Strong` (string) + +### Subscript +Subscripted text (list of inlines) + +tag, t +: the literal `Subscript` (string) + +### Superscript +Superscripted text (list of inlines) + +tag, t +: the literal `Superscript` (string) + +## Attributes + +List of key/value pairs. Values can be accessed by using keys as indices to the +list table. + + +[block]: #block +[blocks]: #block +[list]: #list +[meta value]: #metavalue +[inline]: #inline +[inlines]: #inline +[Attr]: #attr +[attributes]: #attributes -- cgit v1.2.3