From 1ac87b487f16834022a6995278212205dd4bc72e Mon Sep 17 00:00:00 2001 From: Albert Krewinkel Date: Thu, 11 Oct 2018 22:30:40 +0200 Subject: [PATCH] Lua filter docs: document list attributes --- doc/lua-filter-types-and-objects.md | 30 ++++++++++++++++++++++++++--- 1 file changed, 27 insertions(+), 3 deletions(-) diff --git a/doc/lua-filter-types-and-objects.md b/doc/lua-filter-types-and-objects.md index 7d920319a..02331da15 100644 --- a/doc/lua-filter-types-and-objects.md +++ b/doc/lua-filter-types-and-objects.md @@ -166,7 +166,16 @@ items : list items ([list] of [blocks]) listAttributes -: list parameters +: list parameters (ListAttributes) + +start +: alias for `listAttributes.start` (integer) + +style +: alias for `listAttributes.style` (string) + +delimiter +: alias for `listAttributes.delimiter` (string) tag, t : the literal `OrderedList` (string) @@ -176,7 +185,7 @@ tag, t A paragraph content -: inline content +: inline content ([list] of [inlines]) tag, t : the literal `Para` (string) @@ -186,7 +195,7 @@ tag, t Plain text, not a paragraph content -: inline content +: inline content ([list] of [inlines]) tag, t : the literal `Plain` (string) @@ -490,6 +499,21 @@ note_num hash : hash (integer) +## ListAttributes +List attributes + +start +: number of the first list item (integer) + +style +: style used for list numbers; possible values are `DefaultStyle`, + `Example`, `Decimal`, `LowerRoman`, `UpperRoman`, + `LowerAlpha`, and `UpperAlpha` (string) + +delimiter +: delimiter of list numbers; one of `DeaultDelim`, `Period`, + `OneParen`, and `TwoParens` (string) + [block]: #block [blocks]: #block