aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert Krewinkel <[email protected]>2023-01-28 18:11:45 +0100
committerAlbert Krewinkel <[email protected]>2023-01-28 18:12:26 +0100
commit5f31a01d77f5fea46e2deca51165d5af8fc99677 (patch)
tree75d5fc541d681d1b6e1113cf13e4c6863b621f04 /doc
parent49c8bd0a2e2c402d9431d416ad0a45ac232b0b3e (diff)
doc/lua-filters.md: document 'Figure' type and constructor
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filters.md49
1 files changed, 49 insertions, 0 deletions
diff --git a/doc/lua-filters.md b/doc/lua-filters.md
index b58a9c269..28023e2e3 100644
--- a/doc/lua-filters.md
+++ b/doc/lua-filters.md
@@ -1124,6 +1124,36 @@ Fields:
`tag`, `t`
: the literal `Div` (string)
+### Figure {#type-figure}
+
+Figure with caption and arbitrary block contents.
+
+Values of this type can be created with the
+[`pandoc.Figure`](#pandoc.figure) constructor.
+
+Fields:
+
+`content`
+: block content ([Blocks][])
+
+`caption`
+: figure caption ([Caption][])
+
+`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 `Figure` (string)
+
### Header {#type-header}
Creates a header element.
@@ -2370,6 +2400,8 @@ Usage:
[Citations]: #type-citation
[ColSpec]: #type-colspec
[CommonState]: #type-commonstate
+[Div]: #type-div
+[Figure]: #type-figure
[Image]: #type-image
[Inline]: #type-inline
[Inlines]: #type-inlines
@@ -2717,6 +2749,23 @@ Parameters:
Returns: [Div] object
+### `Figure (content[, caption[, attr]])` {#pandoc.div}
+
+Creates a [Figure][] element.
+
+Parameters:
+
+`content`
+: figure block content
+
+`caption`
+: figure caption
+
+`attr`
+: element attributes
+
+Returns: [Figure][] object
+
### `Header (level, content[, attr])` {#pandoc.header}
Creates a header element.