summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWuzzy <almikes@aol.com>2016-08-03 01:02:55 +0200
committerWuzzy <almikes@aol.com>2016-08-03 01:02:55 +0200
commitbbf32f28e4c306a435a3a7adfc8c985ad36cccd5 (patch)
treeb82f1069e1cc4f3b88283cbd8ba4d8790617195c
parent698609945e48a869594e2a1ac9189985f5fbf521 (diff)
Add size constraints to API doc
-rw-r--r--API.md13
1 files changed, 9 insertions, 4 deletions
diff --git a/API.md b/API.md
index 5efcc2d..10c0324 100644
--- a/API.md
+++ b/API.md
@@ -53,18 +53,23 @@ data.
only parameter (has the data type of the entry data) and must
return a formspec which is inserted in the Entry tab.
-#### Predefined values `build_formspec`
-For `build_formspec` you can either define your own function or use one
-of the following predefined functions:
+#### Using `build_formspec`
+For `build_formspec` you can either define your own function which
+procedurally generates the entry formspec or you use one of the
+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 freeform text.
-
* `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.
+When building your formspec, you have to respect the size limitations.
+The documentation system uses a size of `12,9` and you should place
+all your formspec elements at positions not lower than `0.25,0.5` to
+avoid overlapping.
+
#### Return value
Always `nil`.