..  index:: Configuration; Labels
..  _configuration-labels:

======
Labels
======

The labels this extension shows in the frontend come from
:file:`EXT:academic_programs/Resources/Private/Language/locallang.xlf` and its
translations; the table below names the ones that come from another file. A site
changes a label without copying a template, in TypoScript:
under :typoscript:`plugin.tx_academicprograms._LOCAL_LANG` for every content element
of the extension, or under :typoscript:`plugin.tx_academicprograms_<plugin>._LOCAL_LANG`
for one of them. A label set for the plugin wins over one set for the extension.

..  code-block:: typoscript
    :caption: EXT:my_sitepackage/Configuration/TypoScript/setup.typoscript

    plugin.tx_academicprograms._LOCAL_LANG {
      default.page.backToList = All study programs
      de.page.backToList = Alle Studiengänge
    }

    # Only in one content element:
    plugin.tx_academicprograms_programlist._LOCAL_LANG.default.page.backToList = All study programs

The dots of a key need no escaping: TypoScript reads them as levels of its tree,
and TYPO3 joins the levels to the key again. A label of another language goes
under its language key, :typoscript:`de` for German.

..  list-table:: The path of each content element
    :header-rows: 1

    *   - Content element
        - Path
    *   - :guilabel:`Course List` (:typoscript:`academicprograms_programlist`)
        - :typoscript:`plugin.tx_academicprograms_programlist._LOCAL_LANG`
    *   - :guilabel:`Course Data` (:typoscript:`academicprograms_programdetails`)
        - :typoscript:`plugin.tx_academicprograms_programdetails._LOCAL_LANG`
    *   - :guilabel:`Course Finder` (:typoscript:`academicprograms_programfinder`)
        - :typoscript:`plugin.tx_academicprograms_programfinder._LOCAL_LANG`

The page template of a program page is not rendered by a plugin: a site sets
its labels, the facts it shows among them, under the path of the extension.

A language file override works as well, and replaces the label of the file
itself: :php:`$GLOBALS['TYPO3_CONF_VARS']['SYS']['locallangXMLOverride']` on
TYPO3 v13, :php:`$GLOBALS['TYPO3_CONF_VARS']['LANG']['resourceOverrides']` on
TYPO3 v14.

Earlier versions of this extension read these overrides on TYPO3 v13 from
:typoscript:`plugin.tx_academic_programs` instead, see
:ref:`the changelog <important-label-overrides-use-the-documented-path>`.

..  _configuration-labels-category-types:

Category types of a project
===========================

A category type is named by the label :xml:`sys_category.programs.<type>`. The
language file of this extension has one for each type it ships. A type a
project registers for the group `programs` has none, and is named by the title
it is registered with in :file:`Configuration/CategoryTypes.yaml` instead,
translated into the language of the page when the title is an :php:`LLL:`
reference. A label set under
:typoscript:`plugin.tx_academicprograms._LOCAL_LANG`, or under the path of one
content element, wins over the title:

..  code-block:: typoscript
    :caption: EXT:my_sitepackage/Configuration/TypoScript/setup.typoscript

    plugin.tx_academicprograms._LOCAL_LANG {
      default.sys_category.programs.teaching_form = Mode of study
      de.sys_category.programs.teaching_form = Studienform
    }

A template override hands the label to the title view helper, see
:ref:`the changelog <feature-1791035982>`.

Where the labels are shown
==========================

Placeholders in angle brackets stand for a part of the key that the template
or the code fills in, a category type or a field name for example.

..  list-table::
    :header-rows: 1
    :widths: 45 55

    *   - Key
        - Shown by
    *   - :xml:`filter.activeFilters.label`, :xml:`filter.activeFilters.remove`, :xml:`filter.reset`
        - :file:`Partials/Program/ActiveFilters.html`
    *   - :xml:`filter.moreFilters`
        - :file:`Partials/Program/DemandCategories.html`
    *   - :xml:`finder.submit`
        - :file:`Templates/Program/Finder.html`
    *   - :xml:`list.noProgramsFound`
        - :file:`Partials/Program/ItemList.html`
    *   - :xml:`list.resultCount.singular`, :xml:`list.resultCount.plural`
        - :file:`Partials/Program/ResultCount.html`, and the announcement after an update in place, :file:`Templates/Program/List.html`
    *   - :xml:`list.submit`
        - :file:`Partials/Program/SortingAndFilters.html`, the submit button for a visitor without JavaScript
    *   - :xml:`page.applicationLink.defaultLabel`
        - :file:`Partials/Program/Page/CallToAction.html`
    *   - :xml:`page.backToList`
        - :file:`Partials/Program/Page/Header.html`
    *   - :xml:`sorting.direction.label`
        - :file:`Partials/Program/DemandSorting.html`
    *   - :xml:`sorting.field.label`
        - :file:`Partials/Program/DemandSorting.html`
    *   - :xml:`sys_category.programs.<type>`
        - :file:`Partials/Program/DemandCategories.html`, :file:`Templates/Program/Finder.html`
    *   - :xml:`sys_category.programs.allOptions`
        - :file:`Partials/Program/DemandCategories.html`, :file:`Templates/Program/Finder.html`
    *   - :xml:`sys_category.programs.allOptions.<type>`
        - :file:`Partials/Program/DemandCategories.html`, :file:`Templates/Program/Finder.html`
    *   - :xml:`sorting.field.<field>`, :xml:`sorting.direction.<direction>`
        - The options of the sorting select, translated by its view helper
    *   - :xml:`sys_category.programs.<type>`, :xml:`program.<field>`
        - The labels of the program facts, :file:`Partials/Program/Facts/Item.html`; the key is built from the configured fact