From 484056a4cd9d243a73cf7cb9b87225814e176d72 Mon Sep 17 00:00:00 2001 From: Albert Krewinkel Date: Thu, 11 Oct 2018 21:25:26 +0200 Subject: Lua filter docs: document fields of Citation objects --- doc/lua-filter-types-and-objects.md | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) (limited to 'doc') 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 -- cgit v1.2.3