.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _users-manual:

Users manual
============

Documentation of how to use the extension, how it works.

Create a new record

Target group: **Users**

Records
----------

Event
^^^^^^^
+---------------------------+------------------------------------------------------------------+
| Field:                    | Description                                                      |
+===========================+==================================================================+
| Title                     | Required! Title of an event record                               |
+---------------------------+------------------------------------------------------------------+
| Description               |  Description and information of your event.                      |
+---------------------------+------------------------------------------------------------------+
| Color                     |  Required! An hexadecimal color with a color picker.             |
+---------------------------+------------------------------------------------------------------+
| Start                     |  Required! Date wich your event start.                           |
+---------------------------+------------------------------------------------------------------+
| End                       |  Required! Date wich your event end.                             |
+---------------------------+------------------------------------------------------------------+
| Repeat event              |  Determine if you want your event to repeat itself.              |
|                           |          * Do not repeat                                         |
|                           |          * Each day                                              |
|                           |          * Weekly                                                |
|                           |          * Each 2 week                                           |
|                           |          * Monthly                                               |
|                           |          * Each year                                             |
+---------------------------+------------------------------------------------------------------+
| Number of repetition      |  Determine the number of repetition of this event. 0 = no limit  |
+---------------------------+------------------------------------------------------------------+
| Limit date for repetition |  Determine a date where the repetition will stop.                |
|                           |  This field have priority over the field "NNumber of repetition".|
+---------------------------+------------------------------------------------------------------+

Plugin
----------

Calendar
^^^^^^^^^
+---------------------------+------------------------------------------------------------------+
| Field:                    | Description                                                      |
+===========================+==================================================================+
| Detail page               | Page where detail will be shown                                  |
+---------------------------+------------------------------------------------------------------+
| Return page               |  Page where you will be send to with the back button in detail   |
+---------------------------+------------------------------------------------------------------+
| Startingpoint             |  Required! Storapge page id                                      |
+---------------------------+------------------------------------------------------------------+
| Template Root Path        |  Modify current root path to Templates                           |
+---------------------------+------------------------------------------------------------------+
| Layout Root Path          |  Modify current root path to Layouts                             |
+---------------------------+------------------------------------------------------------------+
| Partial Root Path         |  Modify current root path to Partials                            |
+---------------------------+------------------------------------------------------------------+

List
^^^^^^^^^
+---------------------------+------------------------------------------------------------------+
| Field:                    | Description                                                      |
+===========================+==================================================================+
| Detail page               | Page where detail will be shown                                  |
+---------------------------+------------------------------------------------------------------+
| Return page               |  Page where you will be send to with the back button in detail   |
+---------------------------+------------------------------------------------------------------+
| Period                    |  Determine the type of list.                                     |
|                           |          * Month                                                 |
|                           |          * Week                                                  |
|                           |          * Today                                                 |
|                           |          * Next 30 days                                          |
|                           |          * Next X days                                           |
+---------------------------+------------------------------------------------------------------+
| Number of days            |  Required! Number of days to show in list. Displayed only with   |
|                           |  the option "Next X days" of "Period" field. Require an integer  |
|                           |  input.                                                          |
+---------------------------+------------------------------------------------------------------+
| Startingpoint             |  Required! Storapge page id                                      |
+---------------------------+------------------------------------------------------------------+
| Template Root Path        |  Modify current root path to Templates                           |
+---------------------------+------------------------------------------------------------------+
| Layout Root Path          |  Modify current root path to Layouts                             |
+---------------------------+------------------------------------------------------------------+
| Partial Root Path         |  Modify current root path to Partials                            |
+---------------------------+------------------------------------------------------------------+

Detail
^^^^^^^^^
+---------------------------+------------------------------------------------------------------+
| Field:                    | Description                                                      |
+===========================+==================================================================+
| Startingpoint             |  Required! Storapge page id                                      |
+---------------------------+------------------------------------------------------------------+
| Template Root Path        |  Modify current root path to Templates                           |
+---------------------------+------------------------------------------------------------------+
| Layout Root Path          |  Modify current root path to Layouts                             |
+---------------------------+------------------------------------------------------------------+
| Partial Root Path         |  Modify current root path to Partials                            |
+---------------------------+------------------------------------------------------------------+

FAQ
----------

Nothing for now