..  index:: Configuration
..  _configuration-general:

=====================
General configuration
=====================

..  _configuration-general-content-element-header:

The header of the content elements
==================================

The header and the subheader an editor enters on a :guilabel:`Jobs List`,
:guilabel:`Jobs Detail` or :guilabel:`Jobs New` content element are rendered by
the content element layout of the site, as for any other content element. The
layouts of :guilabel:`EXT:fluid_styled_content` and of the bootstrap package do
that, and the plugins render no header of their own.

A site whose content element layout renders no header, because its element
templates render it instead, lets the plugins render it:

..  code-block:: typoscript
    :caption: TypoScript constants

    plugin.tx_academicjobs.renderContentElementHeader = 1

On TYPO3 v13, for a site that uses the site set, that is the site setting
:guilabel:`Render the content element header in the plugins` of
`fgtclb/academic-jobs`. The templates then render the header partial of
:guilabel:`EXT:fluid_styled_content` above their output. Do not switch it on
where the layout renders the header: the header then appears twice.

For the header layout :guilabel:`Default`, the partial takes the heading level
from :typoscript:`plugin.tx_academicjobs.settings.defaultHeaderType`, which is
mapped from the constant :typoscript:`styles.content.defaultHeaderType` of
:guilabel:`EXT:fluid_styled_content`. A site that does not include the
TypoScript of :guilabel:`EXT:fluid_styled_content` sets the setting itself;
without it, such a header renders as an empty :html:`<header>` element.

..  _configuration-general-detail-page-title:

The title of the job detail page
================================

A :guilabel:`Jobs Detail` content element that shows a job makes the title of
the job the title of the page, through the page title API of TYPO3. Its
provider is registered as :typoscript:`academicJobs` and is asked before the
providers :typoscript:`record` and :typoscript:`seo` of the core:

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

    config.pageTitleProviders {
      academicJobs {
        provider = FGTCLB\AcademicJobs\PageTitle\JobTitleProvider
        before = record,seo
      }
    }

A site changes the order there, or removes the provider with
:typoscript:`config.pageTitleProviders.academicJobs >`. A page without a job
keeps its own title. The detail also writes the meta tags ``og:title`` and
``twitter:title``, and ``description``, ``og:description`` and
``twitter:description`` from the text of the description of the job, the
latter three only when the job has one. A page without them keeps its own
description, the one :guilabel:`EXT:seo` writes for example.

..  _configuration-general-detail-cache-lifetime:

The page cache of the job detail page
=====================================

The job list is rendered outside the page cache, the job detail is cached with
its page. The cache entry of a page that shows a job ends with the next start
or end time of that job, or of a translation of it, so a job that ends is no
longer shown from the page cache. TYPO3 v13 does that itself for the records
Extbase fetches when the feature :php:`frontend.cache.autoTagging` is enabled,
which it does for a new installation and not for an updated one. TYPO3 v12 has
no such feature. The extension limits the lifetime on both versions.

..  _configuration-general-notification-mail:

The notification mail about a submitted job
===========================================

When a visitor submits a job through the :guilabel:`Jobs New` content element,
the job is saved hidden and one plain-text mail announces it, with a link to
the job in the TYPO3 backend. It is sent through the mail configuration of the
installation.

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

    *   -   Constant
        -   Default
        -   Meaning
    *   -   :typoscript:`plugin.tx_academicjobs.email.from`
        -   empty
        -   The sender address.
    *   -   :typoscript:`plugin.tx_academicjobs.email.recipientEmail`
        -   empty
        -   The address the mail is sent to.
    *   -   :typoscript:`plugin.tx_academicjobs.email.subject`
        -   `New job application`
        -   The subject of the mail.

On TYPO3 v13, a site that depends on the aggregate set `fgtclb/academic-jobs`
can set them as site settings instead.

The text of the mail comes from the labels `email.jobCreated.message` and
`email.jobCreated.link` of
:file:`EXT:academic_jobs/Resources/Private/Language/locallang.xlf`, in the
language of the page the form was submitted on. The extension ships them in
English and German, and a site overrides them like any other label.

The subject is not translated. A site with more than one language overrides
the setting :typoscript:`plugin.tx_academicjobs.settings.email.subject`, which
the constant :typoscript:`plugin.tx_academicjobs.email.subject` fills, in a
TypoScript condition on the site language. On TYPO3 v13 the site setting does
not help here, because site settings apply to the whole site:

..  code-block:: typoscript

    [siteLanguage("languageId") == 1]
        plugin.tx_academicjobs.settings.email.subject = Neue Stellenanzeige
    [END]

:typoscript:`plugin.tx_academicjobs.email.template`, labelled "Email content",
has no effect in 2.x.

The link opens the job in the record editor of the backend. It carries no
security token, because the frontend has no backend session to create one for.
A backend user who opens it is asked to log in, when not logged in already,
and is then taken to the job. The link uses the host of the request the form
was submitted with. On TYPO3 v13, a
:php:`$GLOBALS['TYPO3_CONF_VARS']['BE']['entryPoint']` configured as a full URL
with a host of its own contributes only its path.

..  _configuration-general-notification-mail-failure:

When the mail cannot be sent
----------------------------

The mail is sent after the job is saved. When it cannot be sent, because the
recipient or the sender address is empty or invalid, or because the mail
transport refuses it or cannot deliver it, the job stays saved and the visitor
gets the same redirect as after a sent mail. The visitor sees the warning
"Notification email could not be sent" instead of the success message, on the
form when no redirect page is set, and on a redirect page that renders the
messages of the form, see :ref:`templates-override-new-job-form-redirect-page`.
With the mode :guilabel:`Suppress when a redirect page is set` and a redirect
page, neither message is queued.

The failure is logged at level error, with the uid of the job and the
exception. The logger is the one of
:php:`\FGTCLB\AcademicJobs\Controller\JobController`, so with the default log
configuration of TYPO3 the entry lands in the log file of the installation, in
:file:`var/log/` of a Composer based installation and in
:file:`typo3temp/var/log/` of a classic one. Check it after changing the mail
configuration of a site.

With a spool, the mail is only queued. A transport that fails later, when the
queue is sent, is not reported by this extension, and the visitor has already
seen the success message.

Any other error while the mail is built or sent still ends the request.

..  _configuration-general-job-form-redirect-page-languages:

The redirect page of the job form in other languages
====================================================

After a saved job, the :guilabel:`Jobs New` content element sends the visitor
to the page of its option :guilabel:`Redirect page after job creation`. On a
site with more than one language, that is the redirect page in the language of
the form page. A translated content element has its own options, so its
translation may name a redirect page of its own.

TYPO3 cannot link every page, for example a page that has no translation into
a language whose fallback is strict, which is the default of a new site
language, a hidden, deleted or missing page, a page outside its publish dates
or one the visitor has no access to. The form then treats the page as no
redirect page: the visitor
returns to the form, which shows the confirmation as the flash message creation
mode decides for a form without a redirect page, see
:ref:`templates-override-new-job-form-confirmation`. So the mode
:guilabel:`Suppress when a redirect page is set` shows it. The job controller
logs a warning that names the redirect page, the page of the form and the
language:

..  code-block:: text

    The redirect page 6 of the job form on page 5 cannot be linked in language 1 (Deutsch), it is missing, hidden, access restricted, not translated or of a type that cannot be linked. The visitor returns to the form.

The default log configuration of TYPO3 writes it to the log file of the
installation, see :ref:`configuration-general-notification-mail-failure` for
where that is. Translate the redirect page into every language of the form, or
choose a page that exists in all of them. This applies to a redirect page from
the setting ``plugin.tx_academicjobs.saveForm.fallbackRedirectPageId``, from a
listener of :php:`\FGTCLB\AcademicJobs\Event\AfterSaveJobEvent` and from the
deprecated setting ``plugin.tx_academicjobs.listPid`` as well.