summaryrefslogtreecommitdiff
path: root/API.md
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-11-29 23:29:49 +0100
committerWuzzy <almikes@aol.com>2016-11-29 23:29:49 +0100
commit74814186b59be34c4975b6c5900e44dbd618ca09 (patch)
tree4e8d629e0278a5d26d6b254ea0d5bc03e7ab7ee9 /API.md
parentaafa9e7784078af379068cd20e77ec8f1992c282 (diff)
Update API doc on new entry builder
Diffstat (limited to 'API.md')
-rw-r--r--API.md7
1 files changed, 7 insertions, 0 deletions
diff --git a/API.md b/API.md
index 8ffcadc..4b91a18 100644
--- a/API.md
+++ b/API.md
@@ -154,6 +154,13 @@ following predefined convenience functions:
* `doc.entry_builders.text`: Expects entry data to be a string.
It will be inserted directly into the entry. Useful for entries with
a free form text.
+* `doc.entry_builders.text_and_gallery`: For entries with text and
+ an optional standard gallery (3 rows, 3:2 aspect ratio). Expects
+ entry data to be a table with these fields:
+ * `text`: The entry text
+ * `images`: The images of the gallery, the format is the same as the
+ `imagedata` parameter of `doc.widgets.gallery`. Can be `nil`, in
+ which case no gallery is shown for the entry
* `doc.entry_builders.formspec`: Entry data is expected to contain the
complete entry formspec as a string. Useful if your entries. Useful
if you expect your entries to differ wildly in layouts.