.. include:: /Includes.rst.txt .. _plugin-settings: =============== Plugin settings =============== The plugin :guilabel:`Fullcalendar` is configured with a FlexForm in the tab :guilabel:`Plugin`. The FlexForm has five sheets. The setting names below are the keys under :typoscript:`settings.` in the FlexForm and in the TypoScript (:typoscript:`plugin.fullcalendar.settings.`). .. contents:: :local: :depth: 2 .. _plugin-settings-defaults: Defaults and overrides ====================== Most settings can be set on three levels. The first non-empty value wins: #. the plugin (FlexForm) #. TypoScript :typoscript:`plugin.fullcalendar.settings.` #. the default :typoscript:`plugin.fullcalendar.settings.defaults.`, which are the :ref:`Site Set settings ` or the :ref:`TypoScript constants ` Settings listed in :typoscript:`plugin.fullcalendar.settings.overrideFlexformSettingsIfEmpty` (constant of the same name) fall back to the default if the FlexForm value is empty, e.g. the option *Defined by TypoScript* of select fields. Checkboxes and numbers are converted according to :typoscript:`convertSettingsToBoolean`, :typoscript:`convertSettingsToInteger` and :typoscript:`convertSettingsToFloat`. .. _plugin-sheet-general: General settings ================ .. include:: /Images/PluginGeneral.rst.txt .. confval:: defaultView :name: plugin-defaultview :type: select :Default: Defined by TypoScript (:typoscript:`timeGridWeek`) The view shown on the first visit. Possible views: :typoscript:`timeGridDay`, :typoscript:`timeGridWeek`, :typoscript:`dayGridWeek`, :typoscript:`dayGridMonth`, :typoscript:`listDay`, :typoscript:`listWeek`, :typoscript:`listMonth` and :typoscript:`listYear`. If a visitor changes the view, the last view is stored in the browser and used instead. .. confval:: allDaySlot :name: plugin-alldayslot :type: boolean Show the slot for all-day events in the time grid views. .. confval:: weekends :name: plugin-weekends :type: boolean Show Saturday and Sunday. .. confval:: weekNumbers :name: plugin-weeknumbers :type: boolean :Default: 0 Show the week numbers. How they are calculated is defined by the constant :typoscript:`weekNumberCalculation` (:typoscript:`ISO` or :typoscript:`local`). .. confval:: eventLimit :name: plugin-eventlimit :type: boolean :Default: 0 Show a "more" link, if the events of a day do not fit into the cell. .. confval:: firstDay :name: plugin-firstday :type: select :Default: Defined by TypoScript (Monday) First day of the week: Sunday (0) or Monday (1). .. confval:: minTime :name: plugin-mintime :type: string (hh:mm:ss) :Default: 08:00:00 Start of the visible time range in the time grid views. .. confval:: maxTime :name: plugin-maxtime :type: string (hh:mm:ss) :Default: 18:00:00 End of the visible time range in the time grid views. .. confval:: scrollTime :name: plugin-scrolltime :type: string (hh:mm:ss) Time the time grid views scroll to initially. .. note:: The FlexForm field *Show column header* (:typoscript:`settings.columnHeader`) is a leftover of the former jQuery version and is not evaluated by the current frontend. Use the constant :typoscript:`dayHeaders` to control the day headers. .. _plugin-sheet-header: Header/Footer ============= .. include:: /Images/PluginHeaderFooter.rst.txt The toolbar above (header) and below (footer) the calendar has three areas: start, center and end. Each area contains a list of buttons and elements, separated by commas, a space between two entries means that they are shown side by side with a small gap. .. confval:: header :name: plugin-header :type: boolean :Default: 1 Show the header toolbar. .. confval:: header.start / header.center / header.end :name: plugin-header-areas :type: select (multiple) :Default: :typoscript:`prev,next today filter` / :typoscript:`title` / :typoscript:`dayGridMonth,timeGridWeek,timeGridDay,listWeek` Elements of the three areas. Possible values: :typoscript:`title`, :typoscript:`prev`, :typoscript:`next`, :typoscript:`today`, :typoscript:`filter`, all views of :confval:`plugin-defaultview` and the spaces :typoscript:`[SPACE1]` and :typoscript:`[SPACE2]`. The element :typoscript:`filter` is the button which opens the :ref:`filter `. .. confval:: footer :name: plugin-footer :type: boolean :Default: 0 Show the footer toolbar. .. confval:: footer.start / footer.center / footer.end :name: plugin-footer-areas :type: select (multiple) Elements of the footer, same values as the header. .. _plugin-sheet-eventdetails: Event details settings ====================== .. include:: /Images/PluginEventDetails.rst.txt Settings for the modal which opens when an event is clicked. .. confval:: showAbstract :name: plugin-showabstract :type: boolean :Default: 0 Show the abstract of the event (if it has one, e.g. from calendarize). .. confval:: generateGoogleMapsLink :name: plugin-generategooglemapslink :type: boolean :Default: 0 Link the location of the event to Google Maps. .. confval:: showIcalDownloadButton :name: plugin-showicaldownloadbutton :type: boolean :Default: 1 Show a button to download the event as :file:`.ics` file, see :ref:`ics-download`. .. confval:: showAddtoGoogleCalendarButton :name: plugin-showaddtogooglecalendarbutton :type: boolean :Default: 1 Show the button with the link of the event itself. For events of a Google calendar feed it is labeled *Add to Google Calendar*, for other events, which provide a link (e.g. of an iCal feed), it is labeled *Details*. .. _plugin-sheet-eventsources: Event sources ============= .. include:: /Images/PluginEventSources.rst.txt .. confval:: googleCalendarFeedRecords :name: plugin-googlecalendarfeedrecords :type: records Records of :ref:`Google calendar feeds `. .. confval:: icalFeedRecords :name: plugin-icalfeedrecords :type: records Records of :ref:`iCal feeds `. .. confval:: calendarizeStoragePids :name: plugin-calendarizestoragepids :type: pages Pages with the events of EXT:calendarize. Only if EXT:calendarize is installed and at least one page is selected, the calendarize feed is added to the calendar. .. confval:: calendarizeStorageRecursiveDepth :name: plugin-calendarizestoragerecursivedepth :type: select (0 to 6) :Default: 0 Levels of subpages of the storage pages, which are searched for events, too. .. confval:: calendarizeDetailPid :name: plugin-calendarizedetailpid :type: page Page with the calendarize detail plugin. If set, the modal of an event gets a button *Details* with a link to this page. .. confval:: calendarizeBookingPid :name: plugin-calendarizebookingpid :type: page Page with the calendarize booking plugin. If set, the modal gets a button *Booking*. .. _plugin-sheet-filter: Event filter ============ .. include:: /Images/PluginEventFilter.rst.txt .. confval:: categoryFilters :name: plugin-categoryfilters :type: records :ref:`Category filters `. Every filter is a group of categories in the filter modal and an additional condition for the events, see :ref:`filter`. .. confval:: categoryFilterRoot :name: plugin-categoryfilterroot :type: category (one) Root category of the category tree, from which the feeds are selected, **if at least one category filter is set**: a Google calendar or iCal feed is only added to the calendar if its first category is part of this tree (including all subcategories). If empty, all categories are allowed. .. confval:: categoryFilterExcludes :name: plugin-categoryfilterexcludes :type: categories Categories (and their subcategories), which are excluded from the tree of :confval:`plugin-categoryfilterroot`. Feeds with such a first category are not added. .. confval:: categoryPreFilter :name: plugin-categoryprefilter :type: categories Only events of **calendarize** which have at least one of these categories are loaded. This is a fixed restriction on the server, visitors cannot change it. It does not apply to Google calendar and iCal feeds.