Skip to content

Commit

Permalink
[TASK] Switch to confvals for mod.web_info (#454)
Browse files Browse the repository at this point in the history
releases: main, 12.4, 11.5

Co-authored-by: lina.wolf <[email protected]>
  • Loading branch information
github-actions[bot] and linawolf committed Apr 13, 2024
1 parent 3a83d8b commit f2d0f28
Showing 1 changed file with 81 additions and 74 deletions.
155 changes: 81 additions & 74 deletions Documentation/PageTsconfig/Mod/WebInfo.rst
Original file line number Diff line number Diff line change
@@ -1,109 +1,116 @@
.. include:: /Includes.rst.txt
.. include:: /Includes.rst.txt

.. index::
mod; web_info
Modules; Info
.. index::
mod; web_info
Modules; Info

========
web_info
========

Configuration options of the "Web > Info" module.

.. contents::
:local:
.. contents::
:local:

.. index::
fieldDefinitions
Pagetree overview; Available fields
.. _fieldDefinitions-webinfo:
.. index::
fieldDefinitions
Pagetree overview; Available fields
.. _fieldDefinitions-webinfo:

fieldDefinitions
================

:aspect:`Datatype`
array
.. confval:: fieldDefinitions
:name: mod-web-info-fieldDefinitions
:type: array

:aspect:`Description`
The available fields in the "Pagetree overview" module under the Info module, by default ship with the entries
"Basic settings", "Record overview", and "Cache and age".
The available fields in the "Pagetree overview" module under the Info module, by default ship with the entries
"Basic settings", "Record overview", and "Cache and age".

.. figure:: /Images/ManualScreenshots/Info/PageTsModWebInfoFieldDefinitions.png
:alt: Default entries of Pagetree Overview
.. figure:: /Images/ManualScreenshots/Info/PageTsModWebInfoFieldDefinitions.png
:alt: Default entries of Pagetree Overview

Default entries of Pagetree Overview
Default entries of Pagetree Overview

By using page TsConfig it is possible to change the available fields and add additional entries to the select box.
By using page TsConfig it is possible to change the available fields and add additional entries to the select box.

Next to using a list of fields from the `pages` table you can add counters for records in a given table by prefixing a
table name with `table_` and adding it to the list of fields.
Next to using a list of fields from the `pages` table you can add counters for records in a given table by prefixing a
table name with `table_` and adding it to the list of fields.

The string `###ALL_TABLES###` is replaced with a list of all table names an editor has access to.
The string `###ALL_TABLES###` is replaced with a list of all table names an editor has access to.

:aspect:`Example`
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
.. _fieldDefinitions-webinfo-example:

mod.web_info.fieldDefinitions {
0 {
Example: Override the field definitions in the info module
----------------------------------------------------------

.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
mod.web_info.fieldDefinitions {
0 {
# Basic settings
label = LLL:EXT:info/Resources/Private/Language/locallang_webinfo.xlf:pages_0
fields = title,uid,slug,alias,starttime,endtime,fe_group,target,url,shortcut,shortcut_mode
}
1 {
}
1 {
# Record overview
label = LLL:EXT:info/Resources/Private/Language/locallang_webinfo.xlf:pages_1
fields = title,uid,###ALL_TABLES###
}
2 {
}
2 {
# Cache and age
label = LLL:EXT:info/Resources/Private/Language/locallang_webinfo.xlf:pages_2
fields = title,uid,table_tt_content,table_fe_users
}
}
}
}
.. index::
web_info.menu.function
Module menu; Info
.. _pageblindingfunctionmenuoptions-webinfo:
.. index::
web_info.menu.function
Module menu; Info
.. _pageblindingfunctionmenuoptions-webinfo:

menu.function
=============

:aspect:`Datatype`
array

:aspect:`Description`
Disable elements of the "Function selector" in the document header of the module. The keys for single
items can be found by browsing *System > Configuration > $GLOBALS['TBE_MODULES_EXT']*.

.. figure:: /Images/ManualScreenshots/Info/FunctionMenuInfoModule.png
:alt: The function menu of the Info module

The function menu of the Info module

.. warning::

Blinding the function mMenu items is not hardcore access control! All it
does is hide the possibility of accessing that module functionality
from the interface. It might be possible for users to hack their way
around it and access the functionality anyways. You should use the
option of blinding elements mostly to remove otherwise distracting options.

:aspect:`Example`
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
mod.web_info.menu.function {
# Disable item "Page Tsconfig"
TYPO3\CMS\Info\Controller\InfoPageTyposcriptConfigController = 0
# Disable item "Log"
TYPO3\CMS\Belog\Module\BackendLogModuleBootstrap = 0
# Disable item "Pagetree Overview"
TYPO3\CMS\Info\Controller\PageInformationController = 0
# Disable item "Localization Overview"
TYPO3\CMS\Info\Controller\TranslationStatusController = 0
# Disable item "Linkvalidator"
TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport = 0
}
.. confval:: menu.function
:name: mod-web-info-menu-function
:type: array

Disable elements of the "Function selector" in the document header of the module. The keys for single
items can be found by browsing *System > Configuration > $GLOBALS['TBE_MODULES_EXT']*.

.. figure:: /Images/ManualScreenshots/Info/FunctionMenuInfoModule.png
:alt: The function menu of the Info module

The function menu of the Info module

.. warning::

Blinding the function menu items is not hardcore access control! All it
does is hide the possibility of accessing that module functionality
from the interface. It might be possible for users to hack their way
around it and access the functionality anyways. You should use the
option of blinding elements mostly to remove otherwise distracting options.

.. _pageblindingfunctionmenuoptions-webinfo-example:

Example: Remove some options from the functions menu
----------------------------------------------------

.. code-block:: typoscript
:caption: EXT:site_package/Configuration/page.tsconfig
mod.web_info.menu.function {
# Disable item "Page Tsconfig"
TYPO3\CMS\Info\Controller\InfoPageTyposcriptConfigController = 0
# Disable item "Log"
TYPO3\CMS\Belog\Module\BackendLogModuleBootstrap = 0
# Disable item "Pagetree Overview"
TYPO3\CMS\Info\Controller\PageInformationController = 0
# Disable item "Localization Overview"
TYPO3\CMS\Info\Controller\TranslationStatusController = 0
# Disable item "Linkvalidator"
TYPO3\CMS\Linkvalidator\Report\LinkValidatorReport = 0
}

0 comments on commit f2d0f28

Please sign in to comment.