Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
@@ -0,0 +1,273 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _tsconfigAdministration:
|
||||
|
||||
=====================
|
||||
Administration module
|
||||
=====================
|
||||
|
||||
Configuration of the :guilabel:`Web > News Administration` module
|
||||
|
||||
.. contents:: Properties
|
||||
:backlinks: top
|
||||
:class: compact-list
|
||||
:depth: 1
|
||||
:local:
|
||||
|
||||
.. _tsconfigPreselect:
|
||||
|
||||
preselect
|
||||
=========
|
||||
|
||||
.. confval:: preselect
|
||||
|
||||
:type: array
|
||||
:Path: tx_news > module
|
||||
|
||||
Predefine the form in the administration module. The possible fields for
|
||||
the preselection are:
|
||||
|
||||
- recursive
|
||||
- timeRestriction
|
||||
- topNewsRestriction
|
||||
- sortingField
|
||||
- sortingDirection
|
||||
- categoryConjunction
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.module {
|
||||
preselect {
|
||||
topNewsRestriction = 1
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
.. _tsconfigColumns:
|
||||
|
||||
columns
|
||||
=======
|
||||
|
||||
.. confval:: columns
|
||||
|
||||
:type: string
|
||||
:Path: tx_news > module
|
||||
:Default: teaser,istopnews,datetime,categories
|
||||
|
||||
|
||||
Define a list of columns which are displayed in the administration module.
|
||||
Default is.
|
||||
|
||||
Example: Show the columns datetime, archive and author
|
||||
------------------------------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tx_news.module.columns = datetime,archive,author
|
||||
|
||||
.. _tsconfigDefaultPid:
|
||||
|
||||
defaultPid
|
||||
==========
|
||||
|
||||
.. confval:: defaultPid
|
||||
|
||||
:type: int
|
||||
:Path: tx_news > module
|
||||
|
||||
If no page is selected in the page tree, any record created in the
|
||||
administration module would be saved on the root page.
|
||||
If this is not desired, the pid can be defined by using defaultPid.<tablename>:
|
||||
|
||||
Example: Set default pid for new news records
|
||||
---------------------------------------------
|
||||
|
||||
New news records will be saved on the page with ID 123.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example
|
||||
tx_news.module.defaultPid.tx_news_domain_model_news = 123
|
||||
|
||||
|
||||
localizationView
|
||||
================
|
||||
|
||||
.. confval:: localizationView
|
||||
|
||||
:type: bool
|
||||
:Path: tx_news > module
|
||||
:Default: 1
|
||||
|
||||
Ability to disable the localizationView in the administration module. Example:
|
||||
|
||||
Example: Disable the localization view
|
||||
--------------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tx_news.module.localizationView = 0
|
||||
|
||||
controlPanels
|
||||
=============
|
||||
|
||||
.. confval:: controlPanels
|
||||
|
||||
:type: bool
|
||||
:Path: tx_news > module
|
||||
:Default: 0
|
||||
|
||||
Display control panels to sort, hide and delete records in the administration
|
||||
module.
|
||||
|
||||
Example: Enable the control panels
|
||||
----------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tx_news.module.controlPanels = 1
|
||||
|
||||
allowedCategoryRootIds
|
||||
======================
|
||||
|
||||
.. confval:: allowedCategoryRootIds
|
||||
|
||||
:type: string, comma separated list of integers
|
||||
:Path: tx_news > module
|
||||
|
||||
Reduce the shown categories by defining a list of **root** category IDs.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Example category tree
|
||||
|
||||
├── [10] Cat 1
|
||||
├── [12] Cat 2
|
||||
├ └──[13] Cat 2 b
|
||||
├── [14] Cat 3
|
||||
└── [15] Cat 4
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tx_news.module.allowedCategoryRootIds = 12,15
|
||||
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
Category tree shown
|
||||
|
||||
├── [12] Cat 2
|
||||
├ └──[13] Cat 2 b
|
||||
└── [15] Cat 4
|
||||
|
||||
.. _tsconfigRedirectToPageOnStart:
|
||||
|
||||
redirectToPageOnStart
|
||||
=====================
|
||||
|
||||
.. confval:: redirectToPageOnStart
|
||||
|
||||
:type: integer
|
||||
:Path: tx_news > module
|
||||
|
||||
If no page is selected, the user will be redirected to the given page.
|
||||
|
||||
Example: redirect the user to page 456
|
||||
---------------------------------------
|
||||
|
||||
Redirect the user to the page with the uid 456, if no other page is chosen.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.module.redirectToPageOnStart = 456
|
||||
|
||||
.. _tsconfigAllowedPage:
|
||||
|
||||
allowedPage
|
||||
===========
|
||||
|
||||
.. confval:: allowedPage
|
||||
|
||||
:type: integer
|
||||
:Path: tx_news > module
|
||||
|
||||
If defined, limit the administration module to the given page and always
|
||||
redirect the user, no matter what defined in the page tree.
|
||||
|
||||
Example: Limit the news module to page 123
|
||||
------------------------------------------
|
||||
|
||||
Always redirect the user to the page with the uid 123.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.module.allowedPage = 123
|
||||
|
||||
|
||||
.. _tsconfigAlwaysShowFilter_:
|
||||
|
||||
alwaysShowFilter
|
||||
================
|
||||
|
||||
.. confval:: alwaysShowFilter
|
||||
|
||||
:type: bool
|
||||
:Path: tx_news > module
|
||||
|
||||
If defined, the administration module will always show the filter opened.
|
||||
|
||||
Example: Always show the filter
|
||||
-------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.module.alwaysShowFilter = 1
|
||||
|
||||
The user will be redirected to the page with the uid 123.
|
||||
|
||||
filters
|
||||
=======
|
||||
|
||||
.. confval:: filters
|
||||
|
||||
:type: array
|
||||
:Path: tx_news > module
|
||||
|
||||
Define whether filters should be available or not. By default, all the
|
||||
filters are enabled. The available filters are:
|
||||
|
||||
- searchWord
|
||||
- timeRestriction
|
||||
- topNewsRestriction
|
||||
- hidden
|
||||
- archived
|
||||
- sortingField
|
||||
- number
|
||||
- categories
|
||||
- categoryConjunction
|
||||
- includeSubCategories
|
||||
|
||||
|
||||
.. note::
|
||||
``categoryConjunction`` and ``includeSubCategories`` can only be enabled
|
||||
when ``categories`` is enabled.
|
||||
|
||||
Example: disable the filter of top news restriction
|
||||
---------------------------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.module {
|
||||
filters {
|
||||
topNewsRestriction = 0
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
156
typo3conf/ext/news/Documentation/Reference/TsConfig/General.rst
Normal file
156
typo3conf/ext/news/Documentation/Reference/TsConfig/General.rst
Normal file
@@ -0,0 +1,156 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _tsconfigGeneral:
|
||||
|
||||
=====================
|
||||
General configuration
|
||||
=====================
|
||||
|
||||
The general configuration covers options available during the creation
|
||||
and editing of news records.
|
||||
|
||||
.. contents:: Properties
|
||||
:backlinks: top
|
||||
:class: compact-list
|
||||
:depth: 1
|
||||
:local:
|
||||
|
||||
.. _tsconfigTemplateLayouts:
|
||||
|
||||
templateLayouts
|
||||
===============
|
||||
|
||||
.. confval:: templateLayouts
|
||||
|
||||
:type: array
|
||||
:Path: tx_news
|
||||
|
||||
The select box :guilabel:`Template Layout` inside a plugin can be extended by
|
||||
using TSconfig. Contains an array with key-value pairs. It is possible to
|
||||
define Groups using the :typoscript:`--div--` keyword.
|
||||
|
||||
allowedColPos
|
||||
Limit a layout to a list of colPos values.
|
||||
|
||||
Examples: Add template layouts
|
||||
------------------------------
|
||||
|
||||
Show 3 layout options with the specified key / value pairs.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tx_news.templateLayouts {
|
||||
1 = Foobar
|
||||
2 = Another one
|
||||
3 = --div--,Group 2
|
||||
4 = Blub
|
||||
}
|
||||
|
||||
You can use this setting within the Fluid template by checking
|
||||
:fluid:`{settings.templateLayout}`. See a complete example:
|
||||
:ref:`Template selector tutorial <templatesSelector>`.
|
||||
|
||||
By using the configuration :php:`allowedColPos` it is possible to restrict a
|
||||
template layout to a specific list of colPos values.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
tx_news.templateLayouts {
|
||||
1 = Foobar
|
||||
2 = Another one
|
||||
2.allowedColPos = 1,2,3
|
||||
3 = --div--,Group 2
|
||||
4 = Blub
|
||||
4.allowedColPos = 0,1
|
||||
}
|
||||
|
||||
.. _tsconfigArchive:
|
||||
|
||||
archive
|
||||
=======
|
||||
|
||||
.. confval:: archive
|
||||
|
||||
:type: string
|
||||
:Path: tx_news
|
||||
|
||||
Use strtotime (see `http://www.php.net/strtotime <http://www.php.net/strtotime>`__ )
|
||||
to predefine the archive date
|
||||
|
||||
Example: Set the archive date
|
||||
-----------------------------
|
||||
|
||||
Set the archive date on the the next friday:
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.predefine.archive = next friday
|
||||
|
||||
|
||||
.. _tsconfigTagPid:
|
||||
|
||||
tagPid
|
||||
======
|
||||
|
||||
.. confval:: tagPid
|
||||
|
||||
:type: integer
|
||||
:Path: tx_news
|
||||
|
||||
Besides the configuration in the
|
||||
:ref:`Extension Configuration <extensionConfigurationTagPid>` it is also
|
||||
possible to define the pid of tags created directly in the news record by
|
||||
using TSconfig:
|
||||
|
||||
|
||||
Example: store new tags on page 123
|
||||
-----------------------------------
|
||||
|
||||
Store new tags on page 123.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.tagPid = 123
|
||||
|
||||
|
||||
.. _tsconfigCategoryRestrictionForFlexForms:
|
||||
|
||||
categoryRestrictionForFlexForms
|
||||
===============================
|
||||
|
||||
.. confval:: categoryRestrictionForFlexForms
|
||||
|
||||
:type: bool
|
||||
:Path: tx_news
|
||||
|
||||
After defining the category restriction in the
|
||||
:ref:`Extension Configuration <extensionConfigurationCategoryRestriction>`
|
||||
it is also possible to restrict the categories in the news plugin.
|
||||
This needs to enabled by TsConfig:
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.categoryRestrictionForFlexForms = 1
|
||||
|
||||
|
||||
.. _tsconfigShowContentElementsInNewsSysFolder:
|
||||
|
||||
showContentElementsInNewsSysFolder
|
||||
==================================
|
||||
|
||||
.. confval:: showContentElementsInNewsSysFolder
|
||||
|
||||
:type: bool
|
||||
:Path: tx_news
|
||||
|
||||
If a sys folder is configured with **Contains Plugin:** `News`,
|
||||
content elements are hidden on those pages in the page and list module.
|
||||
If the content elements should be shown, use the Page TsConfig.
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
tx_news.showContentElementsInNewsSysFolder = 1
|
||||
@@ -0,0 +1,66 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _tsconfig:
|
||||
|
||||
========
|
||||
TsConfig
|
||||
========
|
||||
|
||||
This section covers all configurations that can be made with the TSconfig
|
||||
shipped by the extension news. If you are interested in what you can do
|
||||
with the general TsConfig in news records have a look at
|
||||
:ref:`General TSconfig examples <general_tsconfig_examples>`.
|
||||
|
||||
Every TSconfig configuration of extension news starts with :typoscript:`tx_news.`.
|
||||
|
||||
.. note::
|
||||
Just for clarification: TsConfig is in TYPO3 only used for configurations
|
||||
inside the backend!
|
||||
|
||||
|
||||
.. 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:`General TSconfig <tsconfigGeneral>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
The general configuration covers options available during
|
||||
the creation and editing of news records.
|
||||
|
||||
.. 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:`Administration module <tsconfigAdministration>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
Configuration of the :guilabel:`Web > News Administration` module
|
||||
|
||||
.. 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 configuration <tsconfigPlugin>`
|
||||
|
||||
.. container:: card-body
|
||||
|
||||
This section covers settings which influence the news plugin
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
:glob:
|
||||
|
||||
General
|
||||
Administration
|
||||
Plugin
|
||||
@@ -0,0 +1,41 @@
|
||||
.. include:: /Includes.rst.txt
|
||||
|
||||
.. _tsconfigPlugin:
|
||||
|
||||
====================
|
||||
Plugin configuration
|
||||
====================
|
||||
|
||||
This section covers settings which influence the news plugin.
|
||||
|
||||
switchableControllerAction
|
||||
==========================
|
||||
|
||||
.. confval:: switchableControllerAction
|
||||
|
||||
:type: array
|
||||
:Path: TCEFORM > tt_content > pi_flexform > news_pi1.sDEF
|
||||
:Default:
|
||||
- News->list
|
||||
- News->detail
|
||||
- News->dateMenu
|
||||
- News->searchForm
|
||||
- News->searchResult
|
||||
- Category->list
|
||||
- Tag->list
|
||||
|
||||
To remove a specific action from the News Plugin selectbox, use
|
||||
this snippet.
|
||||
|
||||
Example: Remove the action Tag->list
|
||||
------------------------------------
|
||||
|
||||
.. code-block:: typoscript
|
||||
|
||||
# Example:
|
||||
TCEFORM.tt_content.pi_flexform.news_pi1.sDEF {
|
||||
switchableControllerActions.removeItems = Tag->list
|
||||
}
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user