From 305d3303912cc6b194009a380fd8995ed11e1c56 Mon Sep 17 00:00:00 2001 From: Jeremy Stretch Date: Thu, 15 Aug 2019 16:07:15 -0400 Subject: [PATCH] Docs updates --- docs/additional-features/custom-scripts.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/additional-features/custom-scripts.md b/docs/additional-features/custom-scripts.md index 41aeb8fb1..7c74a9079 100644 --- a/docs/additional-features/custom-scripts.md +++ b/docs/additional-features/custom-scripts.md @@ -63,6 +63,15 @@ The order in which the variable fields should appear. This is optional, however fields = ['var1', 'var2', 'var3'] ``` +## Reading Data from Files + +The Script class provides two convenience methods for reading data from files: + +* `load_yaml` +* `load_json` + +These two methods will load data in YAML or JSON format, respectively, from files within the local path (i.e. `SCRIPTS_ROOT`). + ## Logging The Script object provides a set of convenient functions for recording messages at different severity levels: @@ -73,7 +82,7 @@ The Script object provides a set of convenient functions for recording messages * `log_warning` * `log_failure` -Log messages are returned to the user upon execution of the script. +Log messages are returned to the user upon execution of the script. Markdown rendering is supported for log messages. ## Variable Reference @@ -87,6 +96,10 @@ Stores a string of characters (i.e. a line of text). Options include: Note: `min_length` and `max_length` can be set to the same number to effect a fixed-length field. +### TextVar + +Arbitrary text of any length. Renders as multi-line text input field. + ### IntegerVar Stored a numeric integer. Options include: