.. include:: /Includes.rst.txt

.. highlight:: typoscript

.. _typoscript-settings:

==========
TypoScript
==========

If you don't use the Site Set, the defaults are set with TypoScript constants of the static
template :guilabel:`Fullcalendar`. The constants have the same names and default values as the
:ref:`Site Set settings <site-settings>`. The Site Set uses the same keys, so both can be used
in the same way with :typoscript:`plugin.fullcalendar.settings.defaults.<name>`.

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

.. _typoscript-constants:

Constants
=========

View and persistence
--------------------

.. confval:: plugin.fullcalendar.view.templateRootPath
   :name: ts-templaterootpath
   :type: string
   :Default: EXT:fullcalendar/Resources/Private/Templates/

   Template root path. Copy the template :file:`Calendar/App.html` there to override it.

.. confval:: plugin.fullcalendar.view.partialRootPath
   :name: ts-partialrootpath
   :type: string
   :Default: EXT:fullcalendar/Resources/Private/Partials/

   Partial root path.

.. confval:: plugin.fullcalendar.view.layoutRootPath
   :name: ts-layoutrootpath
   :type: string
   :Default: EXT:fullcalendar/Resources/Private/Layouts/

   Layout root path.

.. confval:: plugin.fullcalendar.persistence.storagePid
   :name: ts-storagepid
   :type: int

   Storage pages of the records (feeds, category filters).

Default settings
----------------

All following constants start with :typoscript:`plugin.fullcalendar.settings.defaults.`

.. list-table::
   :header-rows: 1
   :widths: 25 25 50

   * - Constant
     - Default
     - Description
   * - :typoscript:`header`
     - :typoscript:`1`
     - Show the header toolbar
   * - :typoscript:`header.start`
     - :typoscript:`prev,next today filter`
     - Left part of the header
   * - :typoscript:`header.center`
     - :typoscript:`title`
     - Center part of the header
   * - :typoscript:`header.end`
     - :typoscript:`dayGridMonth,timeGridWeek,timeGridDay,listWeek`
     - Right part of the header
   * - :typoscript:`footer`
     - :typoscript:`0`
     - Show the footer toolbar
   * - :typoscript:`footer.start` / :typoscript:`center` / :typoscript:`end`
     - like the header
     - Parts of the footer
   * - :typoscript:`filterIcon`
     - :typoscript:`bi bi-filter`
     - CSS classes of the icon of the filter button (any Bootstrap Icons class)
   * - :typoscript:`defaultView`
     - :typoscript:`timeGridWeek`
     - View on the first visit
   * - :typoscript:`allDaySlot`
     - :typoscript:`0`
     - Show the all-day slot
   * - :typoscript:`firstDay`
     - :typoscript:`1`
     - First day of the week (0 = Sunday)
   * - :typoscript:`weekends`
     - :typoscript:`0`
     - Show weekends
   * - :typoscript:`weekNumbers`
     - :typoscript:`0`
     - Show week numbers
   * - :typoscript:`weekNumberCalculation`
     - :typoscript:`ISO`
     - :typoscript:`ISO` or :typoscript:`local`
   * - :typoscript:`minTime` / :typoscript:`maxTime`
     - :typoscript:`00:00:00` / :typoscript:`24:00:00`
     - Visible time range
   * - :typoscript:`scrollTime`
     - :typoscript:`08:00:00`
     - Initial scroll position of the time grid
   * - :typoscript:`dayHeaders`
     - :typoscript:`0`
     - Day headers, see below
   * - :typoscript:`eventLimit`
     - :typoscript:`0`
     - Maximum number of event rows per day, see :confval:`plugin-eventlimit`
   * - :typoscript:`titleFormat`
     - :typoscript:`MMM y`
     - Format of the title
   * - :typoscript:`timeZone`
     - (empty)
     - Time zone, e.g. :typoscript:`Europe/Berlin`. If empty, the time zone of the browser is used.
   * - :typoscript:`height`
     - :typoscript:`auto`
     - Height of the calendar. :typoscript:`auto` follows the aspect ratio.
   * - :typoscript:`aspectRatio`
     - :typoscript:`1.35`
     - Width-to-height ratio, larger numbers make a smaller height
   * - :typoscript:`locale`
     - :typoscript:`de`
     - Language key of the calendar. The language German is bundled, other languages use the English texts of FullCalendar.
   * - :typoscript:`showAbstract`
     - :typoscript:`0`
     - see :ref:`plugin-sheet-eventdetails`
   * - :typoscript:`generateGoogleMapsLink`
     - :typoscript:`0`
     - see :ref:`plugin-sheet-eventdetails`
   * - :typoscript:`showIcalDownloadButton`
     - :typoscript:`0`
     - see :ref:`plugin-sheet-eventdetails`
   * - :typoscript:`showAddtoGoogleCalendarButton`
     - :typoscript:`0`
     - see :ref:`plugin-sheet-eventdetails`
   * - :typoscript:`calendarizeStorageRecursiveDepth`
     - :typoscript:`0`
     - see :ref:`plugin-sheet-eventsources`
   * - :typoscript:`icsUrlPrefix`
     - :typoscript:`/event.ics?`
     - see :ref:`ics-download`

Further constants
-----------------

.. confval:: plugin.fullcalendar.settings.overrideFlexformSettingsIfEmpty
   :name: ts-overrideflexformsettingsifempty
   :type: string (comma separated)

   Settings which fall back to the defaults, if the FlexForm value is empty,
   see :ref:`plugin-settings-defaults`.

.. confval:: plugin.fullcalendar.settings.convertSettingsToBoolean / convertSettingsToInteger / convertSettingsToFloat
   :name: ts-convertsettings
   :type: string (comma separated)

   Settings which are converted to the type, since FlexForm and TypoScript deliver strings.

.. note::
   The constants for the former jQuery version (:typoscript:`views.*`, :typoscript:`timeFormat`, :typoscript:`themeSystem`,
   :typoscript:`fontAwesomeFilterIcon`) still exist, but are not used by the current frontend.