.. include:: /Includes.rst.txt

.. _records:

=======
Records
=======

The extension has three record types, which can be stored on any page or folder.
The :ref:`plugin <plugin-sheet-eventsources>` selects them by record, so they don't have
to be on the same page as the plugin.

.. contents::
   :local:
   :depth: 1

.. _records-icalfeed:

iCal feed
=========

Table :sql:`tx_fullcalendar_domain_model_icalfeed`

.. include:: /Images/IcalFeedRecord.rst.txt

.. confval:: title
   :name: icalfeed-title
   :type: string

   Name of the feed.

.. confval:: url
   :name: icalfeed-url
   :type: string

   URL of the iCal file (:file:`.ics`).

.. confval:: color
   :name: icalfeed-color
   :type: color

   Color of the events. If empty, the color of the first category is used.

.. confval:: class_name
   :name: icalfeed-class-name
   :type: string

   Additional CSS classes of the events.

.. confval:: categories
   :name: icalfeed-categories
   :type: categories

   The categories are added as CSS class `fc-category-<uid>` to the events and are
   used by the filter. A feed should have at least one category, see :ref:`pitfalls`.

.. confval:: starttime / endtime / fe_group
   :name: icalfeed-access
   :type: access

   Publish dates and frontend user groups (tab :guilabel:`Access`).

.. _records-googlecalendarfeed:

Google calendar feed
====================

Table :sql:`tx_fullcalendar_domain_model_googlecalendarfeed`

.. include:: /Images/GoogleCalendarFeedRecord.rst.txt

Has the fields title, color, class_name, categories and the access fields of the
iCal feed and additionally:

.. confval:: google_calendar_api_key
   :name: googlecalendarfeed-api-key
   :type: string

   API key for the Google Calendar API, see :ref:`google-api-key`.

.. confval:: google_calendar_id
   :name: googlecalendarfeed-calendar-id
   :type: string

   ID of the calendar.

.. _records-categoryfilter:

Category filter
===============

Table :sql:`tx_fullcalendar_domain_model_categoryfilter`

.. include:: /Images/CategoryFilterRecord.rst.txt

.. confval:: title
   :name: categoryfilter-title
   :type: string

   Headline of the group in the filter modal.

.. confval:: categories
   :name: categoryfilter-categories
   :type: categories

   The categories of the group. They are sorted by title in the filter. Categories with a frontend user
   group restriction are only shown to users of these groups.

.. _records-category:

Category (system category)
==========================

The extension adds the tab :guilabel:`Fullcalendar` to the table :sql:`sys_category`.

.. include:: /Images/CategoryColor.rst.txt

.. confval:: color
   :name: category-color
   :type: color

   Color of the category. Used for the events and for the checkbox in the filter.

.. confval:: fullcalendar_fe_group_restriction
   :name: category-fe-group-restriction
   :type: frontend user groups

   Restricts the category (and events with it) to frontend user groups.