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

.. include:: ../../Includes.txt


.. _template_objects:

Template objects
================

The following objects are available in the different views.

Please have a look at the templates included with the extension, since they show many of the properties
of the given objects and how to use them.

Tip: You can use <f:debug>{object}</f:debug> in your template to see available properties of each object.

List view
~~~~~~~~~

.. t3-field-list-table::
 :header-rows: 1

 - :Object:
         Object:

   :Description:
         Description:

 - :Object:
         {events}

   :Description:
         An object holding all events that matched the configured demand in the plugin settings

 - :Object:
         {categories}

   :Description:
         All available categories

 - :Object:
         {selectedCategoryUid}

   :Description:
         The UID of the selected category

Detail view
~~~~~~~~~~~

.. t3-field-list-table::
 :header-rows: 1

 - :Object:
         Object:

   :Description:
         Description:

 - :Object:
         {event}

   :Description:
         An object holding the given event

Registration view
~~~~~~~~~~~~~~~~~

.. t3-field-list-table::
 :header-rows: 1

 - :Object:
         Object:

   :Description:
         Description:

 - :Object:
         {event}

   :Description:
         An object holding the given event

Notification views
~~~~~~~~~~~~~~~~~~

.. t3-field-list-table::
 :header-rows: 1

 - :Object:
         Object:

   :Description:
         Description:

 - :Object:
         {event}

   :Description:
         An object holding the given event

 - :Object:
         {registration}

   :Description:
         An object holding the given registration

 - :Object:
         {settings}

   :Description:
         An array of extension settings

 - :Object:
         {hmac}

   :Description:
         HMAC for the registration UID

 - :Object:
         {reghmac}

   :Description:
         Appended HMAC for the registration UID

iCalendar view
~~~~~~~~~~~~~~

The iCalendar view is used to render an iCal file which can be downloaded by the user for the given event.
Please note, that the iCalendar view is a simple textfile. If you choose to extend the view, be sure that
new fields are compliant with RFC 5545 https://tools.ietf.org/html/rfc5545


.. t3-field-list-table::
 :header-rows: 1

 - :Object:
         Object:

   :Description:
         Description:

 - :Object:
         {event}

   :Description:
         An object holding the given event