summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2020-12-14 10:18:20 +0100
committerMatthias Beyer <mail@beyermatthias.de>2020-12-14 10:18:20 +0100
commitc8c6317bf35b956d0b4e518ff48679b57336d673 (patch)
treeec83a320bf2005ab3fe8ed244812c3a51fc642a5 /doc
parent04d6c5d1662943592e011cea1678d6e2668c9016 (diff)
Add documentation about other handlebar helpers
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
Diffstat (limited to 'doc')
-rw-r--r--doc/scripting.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/doc/scripting.md b/doc/scripting.md
index 0b514e1..e8a2553 100644
--- a/doc/scripting.md
+++ b/doc/scripting.md
@@ -80,3 +80,28 @@ For the packaging progress itself it is not required.
earlier builds of the same package using heuristics. This might or might not
deprecate this feature).
+
+### Other helpers
+
+The (handlebars) templating engine we use to provide helpers for the package
+script building provides some basic helpers, e.g.:
+
+* if-else
+* each
+* boolean helpers for if conditions
+
+For a full list see
+[the handlebars documentation](https://docs.rs/handlebars/3.5.1/handlebars/#built-in-helpers).
+The "logging" feature of handlebars is _not_ enabled, thus, the logging helpers
+are not included.
+
+butido provides some more helpers:
+
+* `join` for joining several strings to one string:
+ `{{join "foo" "bar}}` -> `foobar`
+ Arguments can also be variables.
+
+* `joinwith` for joining several strings to one string seperated
+ `{{joinwith ", " "foo" "bar}}` -> `foo, bar`
+ Arguments can also be variables.
+