Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
@@ -0,0 +1,677 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. highlight:: typoscript
|
||||
.. _typoscriptGeneral:
|
||||
|
||||
================
|
||||
General settings
|
||||
================
|
||||
|
||||
Any setting needs to be prefixed with :typoscript:`plugin.tx_news.settings.`.
|
||||
|
||||
|
||||
.. only:: html
|
||||
|
||||
.. contents:: Properties
|
||||
:depth: 1
|
||||
:local:
|
||||
|
||||
.. _tsCssFile:
|
||||
|
||||
cssFile
|
||||
=======
|
||||
|
||||
.. confval:: cssFile
|
||||
|
||||
:type: string
|
||||
:Default: Depends on the chosen layout
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Path to the css file. This is included with the Layouts.
|
||||
|
||||
.. _tsFormat:
|
||||
|
||||
format
|
||||
======
|
||||
|
||||
.. confval:: format
|
||||
|
||||
:type: string
|
||||
:Default: html
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Set a different format for the output. Use e.g. :code:`xml` for RSS feeds.
|
||||
|
||||
useStdWrap
|
||||
==========
|
||||
|
||||
.. confval:: useStdWrap
|
||||
|
||||
:type: string
|
||||
:Default: singleNews
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Add all TypoScript properties as a comma separated list which need
|
||||
support for stdWrap.
|
||||
|
||||
As an example: ::
|
||||
|
||||
settings {
|
||||
useStdWrap = singleNews
|
||||
|
||||
singleNews.stdWrap.cObject = CONTENT
|
||||
singleNews.stdWrap.cObject {
|
||||
# ...
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.. _tsOverrideFlexformSettingsIfEmpty:
|
||||
|
||||
overrideFlexformSettingsIfEmpty
|
||||
===============================
|
||||
|
||||
|
||||
.. confval:: overrideFlexformSettingsIfEmpty
|
||||
|
||||
:type: string
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: cropMaxCharacters,dateField,timeRestriction,orderBy,orderDirection,
|
||||
backPid,listPid,startingpoint,
|
||||
recursive,list.paginate.itemsPerPage,list.paginate.templatePath
|
||||
|
||||
|
||||
The default behaviour of Extbase is to override settings from
|
||||
TypoScript by the one of the FlexForms. This is even valid if the setting is
|
||||
left empty in the FlexForms.
|
||||
|
||||
Therefore you can define those settings which value should be taken from
|
||||
TypoScript if nothing is set in the plugin.
|
||||
|
||||
.. _tsDisplayDummyIfNoMedia:
|
||||
|
||||
displayDummyIfNoMedia
|
||||
=====================
|
||||
|
||||
|
||||
.. confval:: displayDummyIfNoMedia
|
||||
|
||||
:type: boolean
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: 1
|
||||
|
||||
If set and no preview image is defined in the record, a placeholder
|
||||
image defined via :confval:`list.media.dummyImage` is shown.
|
||||
|
||||
.. confval:: list.media.dummyImage
|
||||
|
||||
:type: string
|
||||
:Default: typo3conf/ext/news/Resources/Public/Images/dummy-preview-image.png
|
||||
|
||||
If preview image is defined, the defined placeholder is displayed.
|
||||
|
||||
Example: Display a dummy image from your sitepackage
|
||||
----------------------------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
:caption: my_sitepackage/Configuration/TypoScript/setup.typoscript
|
||||
|
||||
plugin.tx_news.settings {
|
||||
displayDummyIfNoMedia = 1
|
||||
list.media.dummyImage = EXT:my_sitepackage/Resources/Public/Images/News/MyPreviewImage.png
|
||||
}
|
||||
|
||||
|
||||
Example: Remove dummy image from list view
|
||||
------------------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
:caption: my_sitepackage/Configuration/TypoScript/setup.typoscript
|
||||
|
||||
plugin.tx_news.settings {
|
||||
displayDummyIfNoMedia = 0
|
||||
}
|
||||
|
||||
.. _tsDetailPidDetermination:
|
||||
|
||||
detailPidDetermination
|
||||
======================
|
||||
|
||||
.. confval:: detailPidDetermination
|
||||
|
||||
:type: string, comma separated list of keywords
|
||||
:Default: "flexform, categories, default"
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
This setting defines which page is used for the link to the detail view.
|
||||
3 possible options are available which processed in the given order until
|
||||
a page has been found.
|
||||
|
||||
flexform
|
||||
This setting tries to get the detail page from the plugin's setting
|
||||
:confval:`detailPid` :guilabel:`PageId for single news display` which
|
||||
can also be set by using TypoScript::
|
||||
|
||||
# If set via TypoScript, also add detailPid to the setting "overrideFlexformSettingsIfEmpty"
|
||||
plugin.tx_news.settings.detailPid = 123
|
||||
|
||||
categories
|
||||
A detail page can also be defined for every category. Use the field
|
||||
**Single-view page for news from this category** for that.
|
||||
|
||||
**default**
|
||||
This type tries to get the value from the setting :confval:`defaultDetailPid`::
|
||||
|
||||
plugin.tx_news.settings.defaultDetailPid = 456
|
||||
|
||||
.. _tsDefaultDetailPid:
|
||||
|
||||
defaultDetailPid
|
||||
================
|
||||
|
||||
.. confval:: defaultDetailPid
|
||||
|
||||
:type: int
|
||||
:Default: 0
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
If :confval:`detailPidDetermination` contains the keyword "default" this
|
||||
value is used to determine the pid used for detail links of news records.
|
||||
|
||||
.. _tsHideIdList:
|
||||
|
||||
hideIdList
|
||||
==========
|
||||
|
||||
.. confval:: hideIdList
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
|
||||
Define a list of ids of news articles which are excluded in the view. This
|
||||
is similar to the setting :confval:`excludeAlreadyDisplayedNews` but the
|
||||
exclusion is defined in TypoScript instead of the template.
|
||||
|
||||
Example: Hide current news in the list
|
||||
--------------------------------------
|
||||
|
||||
As an example this excludes the news record of a detail action of the
|
||||
same page::
|
||||
|
||||
plugin.tx_news.settings {
|
||||
useStdWrap := addToList(hideIdList)
|
||||
hideIdList.cObject = TEXT
|
||||
hideIdList.cObject {
|
||||
data = GP:tx_news_pi1|news
|
||||
}
|
||||
}
|
||||
|
||||
.. _tsOrderByAllowed:
|
||||
|
||||
orderByAllowed
|
||||
==============
|
||||
|
||||
.. confval:: orderByAllowed
|
||||
|
||||
:type: string
|
||||
:Default: sorting,author,uid,title,teaser,author,tstamp,crdate,datetime,categories.title
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
|
||||
Due to restrictions of Extbase itself it is required to define all fields
|
||||
which are allowed for sorting results.
|
||||
|
||||
.. _tsAnalyticsSocial:
|
||||
|
||||
analytics.social
|
||||
================
|
||||
|
||||
.. confval:: analytics.social
|
||||
|
||||
:type: array
|
||||
|
||||
Use additional code for google analytics tracking of the social
|
||||
functionalities.
|
||||
|
||||
Default::
|
||||
|
||||
analytics.social {
|
||||
facebookLike = 1
|
||||
facebookShare = 1
|
||||
twitter = 1
|
||||
}
|
||||
|
||||
.. _tsDemandClass:
|
||||
|
||||
demandClass
|
||||
===========
|
||||
|
||||
.. confval:: demandClass
|
||||
|
||||
:type: string
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Overload the demand object which is used to build the queries. Read more
|
||||
about how to use and extend :ref:`demands <demands>`.
|
||||
|
||||
.. _tsLinkHrDate:
|
||||
|
||||
link.hrDate
|
||||
===========
|
||||
|
||||
.. confval:: link.hrDate
|
||||
|
||||
:type: boolean / array
|
||||
:Default: 0
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
The url to a single news record contains only the uid of the record.
|
||||
Sometimes it is nice to have the date in url too (for example
|
||||
:samp:`https://example.org/news/2021/8/news-title.html`).
|
||||
|
||||
If this setting is enabled parameters for year, month and day are added
|
||||
to the URL. A :ref:`Routing configuration <routing>` can then be used
|
||||
to create a human readable date like the example above.
|
||||
|
||||
Each parameter (day, month, year) can be separately configured by using
|
||||
the full options of the `php function date()
|
||||
<http://at2.php.net/manual/en/function.date.php>`_ . This example will
|
||||
add the day as a number without leading zeros, the month with leading
|
||||
zeros and the year by using 4 digits::
|
||||
|
||||
link = 1
|
||||
link {
|
||||
hrDate = 1
|
||||
hrDate {
|
||||
day = j
|
||||
month = m
|
||||
year = Y
|
||||
}
|
||||
}
|
||||
|
||||
This option is only applied if the build-in
|
||||
:ref:`LinkViewHelper <viewHelperLink>` is used
|
||||
|
||||
.. _tsLinkTypesOpeningInNewWindow:
|
||||
|
||||
link.typesOpeningInNewWindow
|
||||
============================
|
||||
|
||||
.. confval:: link.typesOpeningInNewWindow
|
||||
|
||||
:type: string
|
||||
:Default: 2
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Comma separated list of news types which open with :html:`target="_blank"`
|
||||
Default is 2 which is the news type "Link to external page".
|
||||
|
||||
This option is only applied if the build-in
|
||||
:ref:`LinkViewHelper <viewHelperLink>` is used.
|
||||
|
||||
.. _tsFacebookLocale:
|
||||
|
||||
facebookLocale
|
||||
==============
|
||||
|
||||
.. confval:: facebookLocale
|
||||
|
||||
:type: string
|
||||
:Default: en\_US
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Facebook locale which is used to translate facebook texts.
|
||||
|
||||
Examples are de\_DE, fr\_FR, ...
|
||||
|
||||
|
||||
.. _tsOpengraph:
|
||||
|
||||
opengraph
|
||||
=========
|
||||
|
||||
.. confval:: opengraph
|
||||
|
||||
:type: array
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Additional open graph properties can be defined using TypoScript.
|
||||
Those are included in the the template partial
|
||||
:file:`EXT:news/Resources/Private/Partials/Detail/Opengraph.html`.
|
||||
|
||||
The most important properties are filled automatically:
|
||||
|
||||
og:title
|
||||
is filled with the field **Alternative title** or if that is empty
|
||||
with the **Title**.
|
||||
|
||||
og:description
|
||||
is filled with the field **Description** or if that is empty with
|
||||
the **Teaser**.
|
||||
|
||||
og:image
|
||||
is filled with the first preview image.
|
||||
|
||||
og:url
|
||||
is filled with the current url.
|
||||
|
||||
Check out https://dev.twitter.com/cards/getting-started for more information
|
||||
regarding the twitter cards.
|
||||
|
||||
Default::
|
||||
|
||||
opengraph {
|
||||
site_name = {$plugin.tx_news.opengraph.site_name}
|
||||
type = article
|
||||
locale =
|
||||
admins =
|
||||
twitter {
|
||||
card = {$plugin.tx_news.opengraph.twitter.card}
|
||||
site = {$plugin.tx_news.opengraph.twitter.site}
|
||||
creator = {$plugin.tx_news.opengraph.twitter.creator}
|
||||
}
|
||||
}
|
||||
|
||||
.. _tsDetailMedia:
|
||||
|
||||
detail.media
|
||||
============
|
||||
|
||||
.. confval:: detail.media
|
||||
|
||||
:type: array
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Configuration for media elements in the detail view.
|
||||
|
||||
.. attention::
|
||||
If you need different options like using **width** instead of
|
||||
**maxWidth** you need also to adopt the template files.
|
||||
|
||||
Default::
|
||||
|
||||
detail.media {
|
||||
image {
|
||||
maxWidth = 282
|
||||
maxHeight =
|
||||
|
||||
# If using fluid_styled_content
|
||||
lightbox {
|
||||
enabled = {$styles.content.textmedia.linkWrap.lightboxEnabled}
|
||||
class = {$styles.content.textmedia.linkWrap.lightboxCssClass}
|
||||
width = {$styles.content.textmedia.linkWrap.width}
|
||||
height = {$styles.content.textmedia.linkWrap.height}
|
||||
}
|
||||
# If using css_styled_content, use those ssettings
|
||||
# lightbox {
|
||||
# enabled = {$styles.content.imgtext.linkWrap.lightboxEnabled}
|
||||
# class = {$styles.content.imgtext.linkWrap.lightboxCssClass}
|
||||
# width = {$styles.content.imgtext.linkWrap.width}
|
||||
# height = {$styles.content.imgtext.linkWrap.height}
|
||||
# rel = lightbox[myImageSet]
|
||||
# }
|
||||
}
|
||||
|
||||
video {
|
||||
width = 282
|
||||
height = 300
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
|
||||
.. _tsDetailErrorHandling:
|
||||
|
||||
detail.errorHandling
|
||||
====================
|
||||
|
||||
.. confval:: detail.errorHandling
|
||||
|
||||
:type: string
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: "showStandaloneTemplate,EXT:news/Resources/Private/Templates/News/DetailNotFound.html,404"
|
||||
|
||||
If no news entry is found, it is possible to use various types of error handling.
|
||||
|
||||
showStandaloneTemplate
|
||||
A template is rendered. The syntax is
|
||||
`showStandaloneTemplate,<path>,<errorCode>`, for example
|
||||
`showStandaloneTemplate,EXT:news/Resources/Private/Templates/News/DetailNotFound.html,404`
|
||||
|
||||
redirectToListView
|
||||
Redirect to the list view on the same page.
|
||||
|
||||
redirectToPage
|
||||
Redirect to any page by using the syntax redirectToPage,<pageid>,<status>.
|
||||
This means e.g. redirectToPage,123,404 to redirect to the page with UID 123 and error code 404.
|
||||
|
||||
pageNotFoundHandler
|
||||
The page not found handler defined in the site configuration is called.
|
||||
|
||||
Example: Show a custom not found template
|
||||
-----------------------------------------
|
||||
|
||||
If the current news record is not found, show the custom template instead and
|
||||
return the HTTP-code `404` (not found)::
|
||||
|
||||
plugin.tx_news.settings.detail.errorHandling = showStandaloneTemplate,EXT:my_sitepackage/Resources/Private/Templates/NotFound.html,404
|
||||
|
||||
Example: Redirect to page 123 if news record is not found
|
||||
---------------------------------------------------------
|
||||
|
||||
If the current news record is not found, forward to page 123 with
|
||||
the HTTP-code `301` (moved permanently)::
|
||||
|
||||
plugin.tx_news.settings.detail.errorHandling = redirectToPage,123,301
|
||||
|
||||
|
||||
.. _tsDetailCheckPidOfNewsRecord:
|
||||
|
||||
detail.checkPidOfNewsRecord
|
||||
===========================
|
||||
|
||||
.. confval:: detail.checkPidOfNewsRecord
|
||||
|
||||
:type: boolean
|
||||
:Default: 0
|
||||
|
||||
If set, the detail view checks the incoming news record against the defined
|
||||
:confval:`startingpoint`.
|
||||
|
||||
If those don't match, the news record won't be displayed and
|
||||
:confval:`detail.errorHandling` applied.
|
||||
|
||||
.. _tsDetailShowMetaTags:
|
||||
|
||||
detail.showMetaTags
|
||||
===================
|
||||
|
||||
.. confval:: detail.showMetaTags
|
||||
|
||||
:type: boolean
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: 1
|
||||
|
||||
If enabled, the meta tags including title, description and various
|
||||
open graph tags (defined in :confval:`opengraph`) are rendered.
|
||||
|
||||
.. _tsDetailShowPrevNext:
|
||||
|
||||
detail.showPrevNext
|
||||
===================
|
||||
|
||||
.. confval:: detail.showPrevNext
|
||||
|
||||
:type: boolean
|
||||
:Default: 0
|
||||
|
||||
If enabled, links to the previous and next news records are shown
|
||||
|
||||
.. _tsDetailRegisterProperties:
|
||||
|
||||
detail.registerProperties
|
||||
=========================
|
||||
|
||||
.. confval:: detail.registerProperties
|
||||
|
||||
:type: string
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: keywords,title
|
||||
|
||||
This property is currently not used.
|
||||
|
||||
.. _tsDetailShowSocialShareButtons:
|
||||
|
||||
detail.showSocialShareButtons
|
||||
=============================
|
||||
|
||||
.. confval:: detail.showSocialShareButtons
|
||||
|
||||
:type: boolean
|
||||
:Default: 1
|
||||
|
||||
If the extension `rx_shariff <https://extensions.typo3.org/extension/rx_shariff>`__
|
||||
is installed and this option is enabled,
|
||||
the social share functionality provided by rx\_shariff is shown.
|
||||
|
||||
You can install this extension with composer:
|
||||
|
||||
.. code-block:: bash
|
||||
:caption: bash
|
||||
|
||||
composer req reelworx/rx-shariff
|
||||
|
||||
list.media
|
||||
==========
|
||||
|
||||
.. confval:: list.media
|
||||
|
||||
:type: array
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Configuration for media elements in the list view.
|
||||
|
||||
.. attention::
|
||||
If you need different options like using **width** instead of **maxWidth** you need also
|
||||
to adopt the template files!
|
||||
|
||||
Default::
|
||||
|
||||
list.media {
|
||||
image {
|
||||
maxWidth = 100
|
||||
maxHeight = 100
|
||||
}
|
||||
}
|
||||
|
||||
.. _tsListPaginate:
|
||||
|
||||
list.paginate
|
||||
=============
|
||||
|
||||
.. confval:: list.paginate
|
||||
|
||||
:type: array
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
|
||||
EXT:news uses a custom ViewHelper to render the pagination.
|
||||
|
||||
The following settings are available:
|
||||
|
||||
class
|
||||
The class that should be used for the pagination
|
||||
|
||||
itemsPerPage
|
||||
Define how many items are shown on one page.
|
||||
|
||||
insertAbove
|
||||
Set it to `0` to hide the pagination before the actual news items.
|
||||
|
||||
insertBelow
|
||||
Set it to `0` to hide the pagination after the actual news items.
|
||||
|
||||
maximumNumberOfLinks
|
||||
If set, not all pages of the pagination are shown but only the given amount. Imagine
|
||||
1000 news records and 10 items per page. This would result in 100
|
||||
links in the frontend.
|
||||
|
||||
Default::
|
||||
|
||||
list.paginate {
|
||||
class = GeorgRinger\NumberedPagination\NumberedPagination
|
||||
itemsPerPage = 10
|
||||
insertAbove = 1
|
||||
insertBelow = 1
|
||||
maximumNumberOfLinks = 3
|
||||
}
|
||||
|
||||
.. _tsListRss:
|
||||
|
||||
list.rss
|
||||
========
|
||||
|
||||
|
||||
.. confval:: list.rss
|
||||
|
||||
:type: array
|
||||
:Path: plugin.tx_news.settings
|
||||
|
||||
Additional settings for the RSS view.
|
||||
|
||||
See the :ref:`RSS configuration <rss>`.
|
||||
|
||||
Default::
|
||||
|
||||
rss {
|
||||
channel {
|
||||
title = {$plugin.tx_news.rss.channel.title}
|
||||
description = {$plugin.tx_news.rss.channel.description}
|
||||
language = {$plugin.tx_news.rss.channel.language}
|
||||
copyright = {$plugin.tx_news.rss.channel.copyright}
|
||||
generator = {$plugin.tx_news.rss.channel.generator}
|
||||
link = {$plugin.tx_news.rss.channel.link}
|
||||
}
|
||||
}
|
||||
|
||||
.. _tsSearchFields:
|
||||
|
||||
search.fields
|
||||
=============
|
||||
|
||||
.. confval:: search.fields
|
||||
|
||||
:type: string
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: teaser,title,bodytext
|
||||
|
||||
Comma separated list of fields which are used for the search.
|
||||
|
||||
.. hint::
|
||||
You can also search in relations, e.g. the category title by using
|
||||
:code:`categories.title`
|
||||
|
||||
search.splitSearchWord
|
||||
======================
|
||||
|
||||
|
||||
.. confval:: search.splitSearchWord
|
||||
|
||||
:type: boolean
|
||||
:Path: plugin.tx_news.settings
|
||||
:Default: 0
|
||||
|
||||
|
||||
If set to `1`, the search subject will be split by spaces and it will
|
||||
not only find the phrase but also if the search terms are scattered
|
||||
in a field.
|
||||
|
||||
As an example: Searching for *hello world* will give you as result also
|
||||
the news item with the title `hello the world`. The search terms must be
|
||||
found in the same field, which means that a news item with the world
|
||||
*hello* in the `title` and the word *world* in the bodytext won't be found.
|
||||
|
||||
.. hint::
|
||||
If you need a better search experience, think about using something like EXT:solr!
|
||||
@@ -0,0 +1,47 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. Set default language for code-blocks to TypoScript for this page!
|
||||
.. highlight:: typoscript
|
||||
|
||||
.. _ts:
|
||||
.. _typoscript:
|
||||
|
||||
==========
|
||||
TypoScript
|
||||
==========
|
||||
|
||||
This page is divided into the following sections which are all configurable by using TypoScript:
|
||||
|
||||
.. container:: row m-0 p-0
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`Plugin settings <typoscriptPlugin>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
This section covers all settings, which can be defined in the
|
||||
plugin itself.
|
||||
|
||||
.. container:: col-12 col-md-6 pl-0 pr-3 py-3 m-0
|
||||
|
||||
.. container:: card px-0 h-100
|
||||
|
||||
.. rst-class:: card-header h3
|
||||
|
||||
.. rubric:: :ref:`General settings <typoscriptGeneral>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Configuration of the :guilabel:`Web > News Administration` module
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:glob:
|
||||
|
||||
PluginSettings
|
||||
GeneralSettings
|
||||
@@ -0,0 +1,635 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. highlight:: typoscript
|
||||
.. _typoscriptPlugin:
|
||||
|
||||
===============
|
||||
Plugin settings
|
||||
===============
|
||||
|
||||
This section covers all settings, which can be defined in the plugin itself.
|
||||
To improve the usability, only those settings are shown which are needed by
|
||||
the chosen view (The setting :confval:`orderBy` is for example not needed in the single view).
|
||||
|
||||
.. important::
|
||||
Every setting can also be defined by TypoScript setup. However, please inform
|
||||
yourself about the setting :confval:`overrideFlexformSettingsIfEmpty`.
|
||||
|
||||
|
||||
.. only:: html
|
||||
|
||||
.. contents:: Properties
|
||||
:depth: 1
|
||||
:local:
|
||||
|
||||
|
||||
Sheet general
|
||||
=============
|
||||
|
||||
.. _tsOrderBy:
|
||||
|
||||
Sort by `orderBy`
|
||||
-----------------
|
||||
|
||||
.. confval:: orderBy
|
||||
|
||||
:type: string
|
||||
:Default: 'datetime'
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Define the sorting of displayed news records.
|
||||
The chapter ":ref:`Extend news > Extend flexforms <extendFlexforms>`"
|
||||
shows how the select box can be extended.
|
||||
|
||||
.. _tsOrderDirection:
|
||||
|
||||
Sort direction `orderDirection`
|
||||
-------------------------------
|
||||
|
||||
.. confval:: orderDirection
|
||||
|
||||
:type: string
|
||||
:Default: 'desc'
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Define the sorting direction which can either be "asc" for
|
||||
ascending or "desc" descending. This can be either *asc* or *desc*.
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.orderDirection = asc
|
||||
|
||||
.. _tsDateField:
|
||||
|
||||
Date field to use `dateField`
|
||||
-----------------------------
|
||||
|
||||
.. confval:: dateField
|
||||
|
||||
:type: string
|
||||
:Default: 'datetime'
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
The date menu builds a menu by year and month and the given news records.
|
||||
The menu can either be built by using the date field or the archive field.
|
||||
|
||||
.. _tsCategories:
|
||||
|
||||
Category selection `categories`
|
||||
-------------------------------
|
||||
|
||||
.. confval:: categories
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Define the news categories which are taken into account when getting the
|
||||
correct news records
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.categories = 1,2,3
|
||||
|
||||
.. caution::
|
||||
|
||||
Don't forget to set the category mode too! See property below.
|
||||
|
||||
.. _tsCategoryConjunction:
|
||||
|
||||
Category mode `categoryConjunction`
|
||||
-----------------------------------
|
||||
|
||||
.. confval:: categoryConjunction
|
||||
|
||||
:type: int
|
||||
:Default: 0 (Don't care, show all)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
|
||||
The category mode defines how selected categories are checked. 5 options are available:
|
||||
|
||||
`1` (Don't care, show all)
|
||||
There is no restriction based on categories, even if categories are defined.
|
||||
|
||||
`2` (Show items with selected categories (OR))
|
||||
All news records which belong to at least one of the selected categories are shown.
|
||||
|
||||
`3` (Show items with selected categories (AND))
|
||||
All news records which belong to all selected categories are shown.
|
||||
|
||||
`4` (Do NOT show items with selected categories (OR))
|
||||
This is the negation of #2. All news records which don't belong to any of the selected categories are shown.
|
||||
|
||||
`5` (Do NOT show items with selected categories (AND))
|
||||
This is the negation of #3. All news records which don't belong to all selected categories are shown.
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.categoryConjunction = 2
|
||||
|
||||
.. _tsIncludeSubCategories:
|
||||
|
||||
Include subcategories `includeSubCategories`
|
||||
--------------------------------------------
|
||||
|
||||
.. confval:: includeSubCategories
|
||||
|
||||
:type: boolean
|
||||
:Default: 0
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Include subcategories in the category selection
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.includeSubCategories = 1
|
||||
|
||||
|
||||
.. _tsArchiveRestriction:
|
||||
|
||||
Archive `archiveRestriction`
|
||||
----------------------------
|
||||
|
||||
.. confval:: archiveRestriction
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.archiveRestriction = active
|
||||
|
||||
News records can hold an optional archive date. 2 modes are available:
|
||||
|
||||
`active`: Only active (non archived)
|
||||
All news records with an archive date in the future are shown.
|
||||
|
||||
`archived`: Archived
|
||||
All news records with an archive date in the past are shown.
|
||||
|
||||
.. hint:: Records with no archive date aren't shown in any of the selected modes.
|
||||
|
||||
.. _tsTimeRestriction:
|
||||
|
||||
Time limit (LOW) `timeRestriction`
|
||||
----------------------------------
|
||||
|
||||
.. confval:: timeRestriction
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.timeRestriction =-1 week
|
||||
|
||||
The time limit offers 3 different options.
|
||||
|
||||
**Date**
|
||||
|
||||
A date in the format `HH:mm DD-MM-YYYY` can be set and only news records that are newer than this date are shown.
|
||||
|
||||
Example: 15:30 01-04-2020 (April 1st, 2020 at 3.30 pm)
|
||||
|
||||
**Time in seconds**
|
||||
|
||||
Only news records with a maximum age (compared to the :guilabel:`Date & Time` field) are shown.
|
||||
|
||||
Example: An input like :code:`86400` shows only news records which are one day (60 seconds \* 60 minutes \* 24 hours) old.
|
||||
|
||||
**Time in words**
|
||||
|
||||
It is also possible to define the maximum age in words. Examples are:
|
||||
|
||||
- -3 days
|
||||
- last Monday
|
||||
- -10 months 3 days 2 hours
|
||||
|
||||
Words need to be in English and are translated by using `strtotime <http://de.php.net/strtotime>`__ .
|
||||
|
||||
.. _tsTimeRestrictionHigh:
|
||||
|
||||
Time limit (HIGH) `timeRestrictionHigh`
|
||||
---------------------------------------
|
||||
|
||||
.. confval:: timeRestrictionHigh
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
See :confval:`timeRestriction` above. The configuration is the same but for the higher time end.
|
||||
|
||||
.. _tsTopNewsRestriction:
|
||||
|
||||
Top news `topNewsRestriction`
|
||||
-----------------------------
|
||||
|
||||
.. confval:: topNewsRestriction
|
||||
|
||||
:type: int
|
||||
:Default: 0
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.topNewsRestriction =2
|
||||
|
||||
Any news record can be set as :guilabel:`Top News`. Therefore it is possible
|
||||
to show news records depending on this flag.
|
||||
|
||||
`1`: Only Top News records
|
||||
Only news records which the checkbox set are shown.
|
||||
|
||||
`2`: Except Top News records
|
||||
Only news records which don't have the checkbox set are shown.
|
||||
|
||||
.. _tsSingleNews:
|
||||
|
||||
Show a single news record `singleNews`
|
||||
--------------------------------------
|
||||
|
||||
.. confval:: singleNews
|
||||
|
||||
:type: int
|
||||
:Default: 0
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.singleNews =789
|
||||
|
||||
It is possible to show a specific news record in the Detail view if the uid is set with this property.
|
||||
|
||||
.. _tsPreviewHiddenRecords:
|
||||
|
||||
Allow preview of hidden records `previewHiddenRecords`
|
||||
------------------------------------------------------
|
||||
|
||||
.. confval:: previewHiddenRecords
|
||||
|
||||
:type: int
|
||||
:Default: 0
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.previewHiddenRecords = 1
|
||||
|
||||
If set, also records which are normally hidden are displayed. This is
|
||||
especially helpful when using a detail view as preview mode for editors.
|
||||
The setting :confval:`enablePreviewOfHiddenRecords` is needed (instead of
|
||||
:confval:`previewHiddenRecords`) if the detail view plugin is used and the plugin
|
||||
configuration option :confval:`previewHiddenRecords` is set to
|
||||
"Defined in TypoScript" (value `2`).
|
||||
|
||||
.. note::
|
||||
Be aware to secure the page (e.g. using a TypoScript condition to make it
|
||||
available only if an backend user is logged in) as this page could
|
||||
be called by anyone using any news record uid to see its content.
|
||||
|
||||
.. note::
|
||||
If set, any hidden records on the current page are shown as well!
|
||||
|
||||
|
||||
.. confval:: enablePreviewOfHiddenRecords
|
||||
|
||||
:type: int
|
||||
:Default: 0
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.previewHiddenRecords = 2
|
||||
plugin.tx_news.settings.enablePreviewOfHiddenRecords = 1
|
||||
|
||||
If :confval:`previewHiddenRecords` is set to `2` the setting of
|
||||
:confval:`enablePreviewOfHiddenRecords` is used instead.
|
||||
|
||||
.. _tsStartingpoint:
|
||||
|
||||
Startingpoint `startingpoint`
|
||||
-----------------------------
|
||||
|
||||
.. confval:: startingpoint
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.startingpoint =12,345
|
||||
|
||||
If a startingpoint is set, all news records which are saved on one
|
||||
of the selected pages are shown, otherwise news of all pages are shown.
|
||||
|
||||
.. _tsRecursive:
|
||||
|
||||
Recursive `recursive`
|
||||
---------------------
|
||||
|
||||
.. confval:: recursive
|
||||
|
||||
:type: int
|
||||
:Default: 0 (No recursion)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.recursive = 2
|
||||
|
||||
The search for pages as startingpoint can be extended by setting a recursive
|
||||
level.
|
||||
|
||||
Sheet additional
|
||||
================
|
||||
|
||||
.. _tsDetailPid:
|
||||
|
||||
PageId for single news display `detailPid`
|
||||
------------------------------------------
|
||||
|
||||
.. confval:: detailPid
|
||||
|
||||
:type: int
|
||||
:Default: 0 (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.detailPid =12
|
||||
|
||||
This page is used as target for the detail view. If nothing set, the current
|
||||
page is used.
|
||||
|
||||
.. hint::
|
||||
Be aware that this setting might not be used, depending on the setting
|
||||
:confval:`detailPidDetermination`.
|
||||
|
||||
.. _tsListPid:
|
||||
|
||||
PageId for list display `listPid`
|
||||
=================================
|
||||
|
||||
.. confval:: listPid
|
||||
|
||||
:type: int
|
||||
:Default: 0 (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.listPid =12
|
||||
|
||||
This page is used as target for the listings, for example the date menu and
|
||||
the search form.
|
||||
|
||||
.. _tsBackPid:
|
||||
|
||||
PageId to return to `backPid`
|
||||
-----------------------------
|
||||
|
||||
.. confval:: backPid
|
||||
|
||||
:type: int
|
||||
:Default: 0 (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.backPid =12
|
||||
|
||||
Define a page for the detail view to return to. This is typically the page on which the list view can be found.
|
||||
|
||||
.. _tsLimit:
|
||||
|
||||
Max records displayed `limit`
|
||||
-----------------------------
|
||||
|
||||
.. confval:: limit
|
||||
|
||||
:type: int
|
||||
:Default: 0 (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.limit =10
|
||||
|
||||
Define the maximum records shown.
|
||||
|
||||
.. _tsOffset:
|
||||
|
||||
Starting with given news record `offset`
|
||||
----------------------------------------
|
||||
|
||||
.. confval:: offset
|
||||
|
||||
:type: int
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.offset = 3
|
||||
|
||||
Define the offset. If set to e.g. 2, the first 2 records are not
|
||||
shown. This is especially useful in combination with multiple plugins on
|
||||
the same page and the setting :confval:`limit`.
|
||||
|
||||
.. _tsTags:
|
||||
|
||||
Tags `tags`
|
||||
-----------
|
||||
|
||||
.. confval:: tags
|
||||
|
||||
:type: string
|
||||
:Default: (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Add a constraint to the given tags
|
||||
|
||||
.. _tsHidePagination:
|
||||
|
||||
Hide the pagination `hidePagination`
|
||||
------------------------------------
|
||||
|
||||
.. confval:: hidePagination
|
||||
|
||||
:type: boolean
|
||||
:Default: 0 (do not hide)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
If defined, the pagination is not shown.
|
||||
|
||||
.. _tsListPaginateItemsPerPage:
|
||||
|
||||
Items per Page `list.paginate.itemsPerPage`
|
||||
-------------------------------------------
|
||||
|
||||
.. confval:: list.paginate.itemsPerPage
|
||||
|
||||
:type: int
|
||||
:Default: 10
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Define the amount of news items shown per page in the pagination.
|
||||
|
||||
.. _tsTopNewsFirst:
|
||||
|
||||
Sort "Top news" before `topNewsFirst`
|
||||
-------------------------------------
|
||||
|
||||
.. confval:: topNewsFirst
|
||||
|
||||
:type: boolean
|
||||
:Default: 0 (Do not show top news first)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.topNewsFirst =1
|
||||
|
||||
If set, news records with the checkbox **"Top News"** are shown before
|
||||
the others, no matter which sorting configuration is used.
|
||||
|
||||
.. _tsExcludeAlreadyDisplayedNews:
|
||||
|
||||
Exclude already displayed news `excludeAlreadyDisplayedNews`
|
||||
-------------------------------------------------------------
|
||||
|
||||
.. confval:: excludeAlreadyDisplayedNews
|
||||
|
||||
:type: boolean
|
||||
:Default: 0 (Do not exclude)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.excludeAlreadyDisplayedNews =1
|
||||
|
||||
If checked, news items which are already rendered are excluded in the
|
||||
current plugin.
|
||||
|
||||
**To exclude news items, the viewHelper <n:excludeDisplayedNews newsItem="{newsItem}" />
|
||||
needs to be added to the template.**
|
||||
|
||||
.. note::
|
||||
The order of rendering in the frontend is essential as the information
|
||||
which news record is shown and should not be included anymore is fetched
|
||||
during runtime.
|
||||
|
||||
.. _tsDisableOverrideDemand:
|
||||
|
||||
Disable override demand `disableOverrideDemand`
|
||||
-----------------------------------------------
|
||||
|
||||
.. confval:: disableOverrideDemand
|
||||
|
||||
:type: boolean
|
||||
:Default: 1 (Disable override)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.disableOverrideDemand =1
|
||||
|
||||
If set, the settings of the plugin can't be overridden by arguments in
|
||||
the URL. Read more about :ref:`demands <demands>`.
|
||||
|
||||
Sheet template
|
||||
==============
|
||||
|
||||
.. _tsMediaMaxWidth:
|
||||
|
||||
Max width for media elements `media.maxWidth`
|
||||
---------------------------------------------
|
||||
|
||||
.. confval:: media.maxWidth
|
||||
|
||||
:type: int
|
||||
:Default: 0 (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Maximum width of assets
|
||||
|
||||
.. _tsMediaMaxHeight:
|
||||
|
||||
Max height for media elements `media.maxHeight`
|
||||
-----------------------------------------------
|
||||
|
||||
.. confval:: media.maxHeight
|
||||
|
||||
:type: int
|
||||
:Default: 0 (none)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
Maximum height of assets
|
||||
|
||||
.. _tsCropMaxCharacters:
|
||||
|
||||
Length of teaser (in chars) `cropMaxCharacters`
|
||||
-----------------------------------------------
|
||||
|
||||
.. confval:: cropMaxCharacters
|
||||
|
||||
:type: int
|
||||
:Default: 0 (do not crop)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.cropMaxCharacters =100
|
||||
|
||||
Define the maximum length of the teaser text before it is cropped.
|
||||
|
||||
.. _tsTemplateLayout:
|
||||
|
||||
Template Layout `templateLayout`
|
||||
--------------------------------
|
||||
|
||||
.. confval:: templateLayout
|
||||
|
||||
:type: string
|
||||
:Default: (none, use default)
|
||||
:Path: plugin.tx_news.settings
|
||||
:Scope: Plugin, TypoScript Setup
|
||||
|
||||
::
|
||||
|
||||
plugin.tx_news.settings.templateLayout = 123
|
||||
|
||||
Select different layouts. See :ref:`this section <tsconfigTemplateLayouts>`
|
||||
how to add layouts.
|
||||
Reference in New Issue
Block a user