aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAlbert Krewinkel <albert@zeitkraut.de>2018-10-11 21:25:26 +0200
committerAlbert Krewinkel <albert@zeitkraut.de>2018-10-11 21:25:26 +0200
commit484056a4cd9d243a73cf7cb9b87225814e176d72 (patch)
treea1646358f4cb0ed10aa7e3b7cc7f1c9b31a898f9 /doc
parent2e63e2f2bc76407a0c8610154e8127d5fa4b3279 (diff)
downloadpandoc-484056a4cd9d243a73cf7cb9b87225814e176d72.tar.gz
Lua filter docs: document fields of Citation objects
Diffstat (limited to 'doc')
-rw-r--r--doc/lua-filter-types-and-objects.md28
1 files changed, 26 insertions, 2 deletions
diff --git a/doc/lua-filter-types-and-objects.md b/doc/lua-filter-types-and-objects.md
index 9695e72eb..7d920319a 100644
--- a/doc/lua-filter-types-and-objects.md
+++ b/doc/lua-filter-types-and-objects.md
@@ -464,8 +464,31 @@ tag, t
## Attributes
-List of key/value pairs. Values can be accessed by using keys as indices to the
-list table.
+List of key/value pairs. Values can be accessed by using keys as
+indices to the list table.
+
+## Citation
+
+Single citation entry
+
+id
+: citation identifier, e.g., a bibtex key (string)
+
+mode
+: citation mode, one of `AuthorInText`, `SuppressAuthor`, or
+ `NormalCitation` (string)
+
+prefix
+: citation prefix ([list] of [inlines])
+
+suffix
+: citation suffix ([list] of [inlines])
+
+note_num
+: note number (integer)
+
+hash
+: hash (integer)
[block]: #block
@@ -476,3 +499,4 @@ list table.
[inlines]: #inline
[Attr]: #attr
[attributes]: #attributes
+[citaions]: #citation