Wuzzy/minetest_doc
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update API doc on new entry builder

Browse Source
This commit is contained in:
Wuzzy 2016-11-29 23:29:49 +01:00
parent aafa9e7784
commit 74814186b5
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
API.md
View File

@ -154,6 +154,13 @@ following predefined convenience functions:
* `doc.entry_builders.text`: Expects entry data to be a string. * `doc.entry_builders.text`: Expects entry data to be a string.
It will be inserted directly into the entry. Useful for entries with It will be inserted directly into the entry. Useful for entries with
a free form text. 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 * `doc.entry_builders.formspec`: Entry data is expected to contain the
complete entry formspec as a string. Useful if your entries. Useful complete entry formspec as a string. Useful if your entries. Useful
if you expect your entries to differ wildly in layouts. if you expect your entries to differ wildly in layouts.