First commit

.gitignore

@@ -0,0 +1,2 @@
+!.gitignore
+book

book.toml

@@ -0,0 +1,16 @@
+[book]
+authors = []
+src = "src"
+
+[language.en]
+name = "English"
+title = "LiberaForms documentation"
+
+[language.es]
+name = "Español"
+title = "LiberaForms documentación"
+
+[language.ca]
+name = "Català"
+title = "LiberaForms documentació"
+

src/ca/SUMMARY.md

@@ -0,0 +1,4 @@
+# Summary
+
+- [LiberaForms](./chapter_1.md)
+  - [Features](about/features.md)

src/ca/about/features.md

@@ -0,0 +1 @@
+# Features

src/ca/chapter_1.md

@@ -0,0 +1 @@
+# Chapter 1

src/en/SUMMARY.md

@@ -0,0 +1,16 @@
+# Summary
+
+- [Introduction](./introduction.md)
+  - [My forms](./my-forms.md)
+  - [Profile](./profile.md)
+- [Create a form](./forms/index.md)
+  - [Form elements](./forms/elements.md)
+- [Form management](./forms/advanced/index.md)
+  - [Email confirmation](./forms/advanced/confirmation.md)
+  - [Expiry conditions](./forms/advanced/expiry.md)
+  - [Multiple editors](./forms/advanced/editors.md)
+  - [Share answers](./forms/advanced/share.md)
+  - [Logs](./forms/advanced/logs.md)
+- [Markdown](./markdown.md)
+- [Administrator](./admin/index.md)
+

src/en/about/features.md

@@ -0,0 +1 @@
+# Features

src/en/admin/index.md

@@ -0,0 +1 @@
+# Administrator

src/en/forms/advanced/confirmation.md

@@ -0,0 +1,21 @@
+# Email confirmation
+
+Send confirmation by email to the user after the form has been submitted.
+
+You can include an option (a checkbox) in your form that will send an email. This email with contain the `Thankyou` message.
+
+Create a `Text Field` with the `type` set as `email` as shown below.
+
+![Enable email confirmation](/images/email_confirmation.en.png)
+
+After you have saved the form, you will have a new option `Confirmation`, that can be enabled or disabled.
+
+When enabled, the user will be able to choose if they wish to recieve confirmation by email.
+
+> If by chance you define two or more Text Fields with the type `email`,
+LiberaForms will use the first field as the recipient address.
+
+
+
+
+

src/en/forms/advanced/editors.md

@@ -0,0 +1,10 @@
+# Multiple editors
+
+
+You can share the responsibilities of form creation and maintanence with other people with an account.
+
+## Editors
+
+
+
+

src/en/forms/advanced/expiry.md

@@ -0,0 +1,22 @@
+# Expiry conditions
+
+You can set some conditions that, when met, the form will not be available.
+
+## Date / Time
+
+The form will not be available after this date.
+
+## Maximum answers
+
+The form will not be available after this number of answers have been submitted.
+
+## Other conditions
+
+If you include a `Number` field in your form, an option to define a maximum will be displayed.
+LiberaForms will add all the answers together. The form will not be available when the maximum is met.
+
+Learn more about [`Number` field options](/en/forms/elements.html#number).
+
+## When the form has expired
+
+This text will be displayed when the form has expired.

src/en/forms/advanced/index.md

@@ -0,0 +1 @@
+# Advanced form options

src/en/forms/advanced/logs.md

@@ -0,0 +1 @@
+# Logs

src/en/forms/advanced/share.md

@@ -0,0 +1 @@
+# Share answers

src/en/forms/elements.md

@@ -0,0 +1,130 @@
+# Form elements
+
+A form contains `elements`. Elements are the building blocks of a form.
+
+There are two basic types of elements:
+
+1. `Fields`: Fields solicit information from the user.
+2. `Texts`: Texts only display text. They can be used to orientate the user. 
+
+## 1. Fields
+
+There are different types of fields. Short texts, long texts, checkboxes, dates, etc.
+
+Fields share these common options:
+
+* `Required`: The form will not submit if this element is not complete.
+* `Label`: A short text. This is the new element's name.
+* `Help text`: A longer text. Use this to a description.
+
+
+### Text Field
+
+Displays a Text field. Text fields are short, one line texts.  
+
+<label for="name">Name</label><br>
+<input id="name" type="text"></input>
+
+Use this element to solicit information like a Name, Postcode, etc.
+
+
+### Text Area
+
+Displays a Textarea field.
+
+<label for="opinion">Your opinion</label><br>
+<textarea id="opinion" rows="4" cols="50"></textarea>
+
+Use this element to solicit extended information like an Opinion.
+
+
+### Select
+
+Displays a dropdown list of selectable options.
+
+<select>
+ <option>Early morning session</option>
+ <option>Early afternoon session</option>
+ <option>Evening session</option>
+</select>
+
+* `Options`: Define selectable options. See [Multiple options](#multiple-options).
+
+
+### Checkbox Group
+
+Displays a group of checkboxes. Multiple options may be selected.
+
+<input type="checkbox" name="chk_group" />&nbsp; Early morning session <br />
+<input type="checkbox" name="chk_group" />&nbsp; Early afternoon session <br />
+<input type="checkbox" name="chk_group" />&nbsp; Evening session <br />
+
+* `Inline`: Display the options horizontally.
+* `Options`: Define selectable options. See [Multiple options](#multiple-options).
+
+
+### Radio Group
+
+Displays a group of radios. Only one option may be selected.
+
+<input type="radio" id="morning" name="animal">&nbsp;
+<label for="morning">Early morning session</label><br>
+<input type="radio" id="afternoon" name="animal">&nbsp;
+<label for="afternoon">Early afternoon session</label><br>
+<input type="radio" id="evening" name="animal">&nbsp;
+<label for="evening">Evening session</label> 
+
+* `Inline`: Display the options horizontally.
+* `Options`: Define selectable options. See [Multiple options](#multiple-options).
+
+
+### Date Field
+
+Displays a Date field.
+
+<input style="height:2em" type="date" id="birthday" name="birthday" />
+
+
+### Number
+
+Displays a Number field.
+
+<input type="number" min="1" max="5">
+
+---
+
+
+## Multiple options
+
+
+
+The left column contains the text the user will see.
+The right column contains the value that will be saved in the database.
+
+![Select element options](/images/select_element_options.en.png)
+
+For example, you may wish to display an option called 'Early afternoon session'. That is clear for the user of your form, but you only really need to save the word 'afternoon' in the database.
+
+> Using short names for the database will make it easier later when reading spreadsheets for example.
+
+---
+
+## 2. Texts
+
+These elements only display text. They do not solicit information.
+
+### Header
+
+Displays a line of text to the user.
+
+* `Label`: The text to be displayed.
+* `Type`: The size of the text. `h1` biggest, `h6` smallest.
+
+
+### Paragraph
+
+Displays a paragraph of text to the user.
+
+* `Content`: The text to be displayed.
+
+

src/en/forms/index.md

@@ -0,0 +1,49 @@
+# Create a form
+
+Create a form with the `New form` button.
+
+![New form button](/images/new_form_button.en.png)
+
+The New form page has three parts.
+
+1. Introduction text
+2. The form
+3. The form URL
+
+## 1. Introduction text
+Your new form will begin with this text. This is the place to explain what your form is about and why people should fill it out. You can include as much detail as you wish.
+
+The editor may seem a little strange at first because of different symbols, like `#` that get added to your text. This is `Markdown` syntax. You can **safetly ignore** this syntax if you wish, however markdown is widely used in LiberaForms because it is an easy way to write HTML code.
+
+> Markdown is easy. [Learn how in 2 minutes](/en/markdown.html).
+
+
+## 2. The form
+
+A form contains `elements`. Elements are the building blocks of a form.
+
+There are different types of elements. One for short texts, another for long texts, checkboxes, dates, etc.
+
+You build your form by dragging `elements` from the right into the empty box.
+
+To ask for a person's name for example, drag a `Text Field` element into the box. A Text Field is a **one line** text element.
+It is ideal for short texts like a Name.
+  
+> Please see the complete list of [form elements and their options](/en/forms/elements.html)
+
+ 
+### Managing elements
+
+Each element is displayed by a block that contains the `Label` on the left, and `Delete`, `Edit`, and `Duplicate` buttons on the right.
+
+![Element block](/images/element_block.en.png)
+
+You can change the order of the elements within your form by dragging and dropping the blocks.
+
+#### Deleting elements
+
+You can delete an element. 
+
+
+## 3. The form URL
+Your form will have this address. People will use to find your form on the Internet.

src/en/introduction.md

@@ -0,0 +1 @@
+# Introduction

src/en/markdown.md

@@ -0,0 +1,94 @@
+# Markdown
+
+[https://commonmark.org](https://commonmark.org)
+
+## Titles
+
+Titles are lines of text that begin with a `#` followed by a space.
+
+
+**This markdown syntax ..**
+```
+# A big title
+```
+
+**.. produces**
+# A big title
+
+
+Smaller titles begin with two `##`
+
+**This markdown syntax ..**
+```
+## A smaller title
+```
+
+**.. produces**
+## A smaller title
+
+
+
+## Lists
+
+Begin each line with a `*` followed by a space.
+
+**This markdown syntax ..**
+```
+* The first item
+* Number two
+* The last item
+```
+
+**.. produces**
+* The first item
+* Number two
+* The last item
+
+### Numbered lists
+
+Begin each line with `1.` followed by a space.
+
+**This markdown syntax ..**
+```
+1. The first item
+2. Number two
+3. The last item
+```
+
+**.. produces**
+1. The first item
+2. Number two
+3. The last item
+
+### Indented lists
+
+Create an indented list by adding **two** empty spaces to the beginning of the line.
+
+**This markdown syntax ..**
+```
+* The first item
+* Number two
+  1. A sub item
+  2. And another
+* The last item
+  * More last item items
+  * The very last item
+```
+
+**.. produces**
+* The first item
+* Number two
+  1. A sub item
+  2. And another
+* The last item
+  * More last item items
+  * The very last item
+
+
+## Links
+
+
+## Images
+
+
+

src/en/my-forms.md

@@ -0,0 +1,9 @@
+# My forms
+
+A list of forms you have created.
+
+Forms that have been shared with you by other users are also listed here.
+
+
+
+

src/en/profile.md

@@ -0,0 +1,34 @@
+# Profile
+
+This page lets you do some basic stuff like:
+
+* Change your email address
+* Change your password
+* Change the LiberaForms' language
+
+## By default
+
+### New answer notification
+
+When someone answers one of your forms you will be notified by email.
+
+Use this option to set that notification for all the new forms your create.
+
+## Delete my account
+
+When you delete your account, all the forms you have created and their answers will also be deleted.
+
+Before deleting your account you will be prompted to enter your username, just to be sure.
+
+---
+
+## My admin settings
+
+### Notify me when new user has registered
+You will be notified by email when a new user has registered
+
+### Notify me when new form has been created
+You will be notified by email when a new form has been created
+
+
+

src/es/SUMMARY.md

@@ -0,0 +1,3 @@
+# Summary
+
+- [Chapter 1](./chapter_1.md)

src/es/chapter_1.md

@@ -0,0 +1 @@
+# Chapter 1