From 74814186b59be34c4975b6c5900e44dbd618ca09 Mon Sep 17 00:00:00 2001 From: Wuzzy Date: Tue, 29 Nov 2016 23:29:49 +0100 Subject: Update API doc on new entry builder --- API.md | 7 +++++++ 1 file changed, 7 insertions(+) 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. -- cgit v1.2.3