From 74f7567a00b27717befd18f481c1c746bccdfb13 Mon Sep 17 00:00:00 2001 From: Ferry Boender Date: Wed, 1 Apr 2015 09:01:50 +0200 Subject: [PATCH] User manual updated with new field options and documentation. --- doc/MANUAL.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/doc/MANUAL.md b/doc/MANUAL.md index 22c9fa8..7394a5f 100644 --- a/doc/MANUAL.md +++ b/doc/MANUAL.md @@ -189,10 +189,32 @@ The `date` field type supports the following additional options: ### Text +The `text` field presents the user with a field in which they can enter +multi-lined text. + +The `text` field type supports the following additional options: + +- **`rows`**: The number of rows to make the input field +- **`cols`**: The number of cols to make the input filed. +- **`minlen`**: The minimum allowed length for the field. +- **`maxlen`**: The maximum allowed length for the field. + ### Password +- **`minlen`**: The minimum allowed length for the field. + ### File +The `file` field type presents the user with a field through which they can +upload a file. Uploaded files are streamed to temporary files by Scriptform, +after which the original field value is replaced with this temporary file name. +This allows users to upload large files. + +The original file name of the uploaded file is stored in a new variable +'<field_name>__name'. + +No additional validation is done on the file contents, or the file name. + ## Callbacks Callbacks are called after the form has been submitted and its values have been