From bbb44d485c800f18daac7d59a7557a1b3c3db517 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Mon, 15 Apr 2024 10:47:37 +0200 Subject: [PATCH] [TASK] Switch to confvals for mod.web_list (#461) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [TASK] Switch to confvals for mod.web_list * use confvals * correct indentation * Give headers to examples No other text changes made releases: main, 12.4 * Apply suggestions from code review Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> * Update Documentation/PageTsconfig/Mod/WebList.rst --------- Co-authored-by: Chris Müller <2566282+brotkrueml@users.noreply.github.com> --- Documentation/PageTsconfig/Mod/WebList.rst | 735 +++++++++++---------- 1 file changed, 390 insertions(+), 345 deletions(-) diff --git a/Documentation/PageTsconfig/Mod/WebList.rst b/Documentation/PageTsconfig/Mod/WebList.rst index eac62cb3..8bfc046e 100644 --- a/Documentation/PageTsconfig/Mod/WebList.rst +++ b/Documentation/PageTsconfig/Mod/WebList.rst @@ -1,9 +1,9 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. index:: - mod; web_list - Modules; List -.. _pageweblist: +.. index:: + mod; web_list + Modules; List +.. _pageweblist: ======== web_list @@ -11,554 +11,599 @@ web_list Configuration options of the "Web > List" module. -.. contents:: - :local: +.. contents:: + :local: -.. index:: - allowedNewTables - Buttons; Create new -.. _pageTsConfigWebListAllowedNewTables: +.. index:: + allowedNewTables + Buttons; Create new +.. _pageTsConfigWebListAllowedNewTables: allowedNewTables ================ -:aspect:`Datatype` - list of table names +.. confval:: allowedNewTables + :name: mod-web-list-allowedNewTables + :type: list of table names -:aspect:`Description` - If this list is set, then only tables listed here will have a link to "create new" in the page and sub pages. - This also affects the "Create new record" content element wizard. + If this list is set, then only tables listed here will have a link to "create new" in the page and sub pages. + This also affects the "Create new record" content element wizard. - This is the opposite of :ref:`deniedNewTables property `. + This is the opposite of :ref:`deniedNewTables property `. - .. note:: + .. note:: - Technically records can be created (e.g. by copying/moving), so this is not a security feature. - The point is to reduce the number of options for new records visually. + Technically records can be created (e.g. by copying/moving), so this is not a security feature. + The point is to reduce the number of options for new records visually. -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. _pageTsConfigWebListAllowedNewTable-example: - mod.web_list { - # Only pages and sys_category table elements will be linked to in the new record wizard - allowedNewTables = pages, sys_category - } +Example: Only allow records of type pages or sys_category in the new record wizard +---------------------------------------------------------------------------------- - .. figure:: /Images/ManualScreenshots/List/PageTsModWebListAllowedNewTables.png - :alt: The New record screen after modifying the allowed elements +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - The New record screen after modifying the allowed elements + mod.web_list { + # Only pages and sys_category table elements will be linked to in the new record wizard + allowedNewTables = pages, sys_category + } +.. figure:: /Images/ManualScreenshots/List/PageTsModWebListAllowedNewTables.png + :alt: The New record screen after modifying the allowed elements -.. index:: clickTitleMode + The New record screen after modifying the allowed elements -clickTitleMode -============== -:aspect:`Datatype` - string +.. index:: clickTitleMode +.. _pageTsConfigWebList-clickTitleMode: -:aspect:`Description` - Keyword which defines what happens when a user clicks a record title in the list. +clickTitleMode +============== - The following values are possible: +.. confval:: clickTitleMode + :name: mod-web-list-clickTitleMode + :type: string + :Default: edit - edit - Edits record + Keyword which defines what happens when a user clicks a record title in the list. - info - Shows information + The following values are possible: - show - Shows page in the frontend + edit + Edits record -:aspect:`Default` - edit + info + Shows information + show + Shows page in the frontend -.. index:: - csvDelimiter - CSV Exports; Delimiter +.. index:: + csvDelimiter + CSV Exports; Delimiter +.. _pageTsConfigWebList-csvDelimiter: csvDelimiter ============ -:aspect:`Datatype` - string +.. confval:: csvDelimiter + :name: mod-web-list-csvDelimiter + :type: string + :Default: `,` -:aspect:`Description` - Defines the default delimiter for CSV downloads (Microsoft Excel expects - `;` to be set). The value set will be displayed as default delimiter in the - download dialog in the list module. + Defines the default delimiter for CSV downloads (Microsoft Excel expects + `;` to be set). The value set will be displayed as default delimiter in the + download dialog in the list module. -:aspect:`Default` - , +Example: Use semicolon as delimiter CSV downloads +------------------------------------------------- -:aspect:`Example` - .. include:: /CodeSnippets/PageTSconfig/Mod/CsvExport.rst.txt +.. include:: /CodeSnippets/PageTSconfig/Mod/CsvExport.rst.txt - .. include:: /Images/AutomaticScreenshots/WebList/ExportDialog.rst.txt +.. include:: /Images/AutomaticScreenshots/WebList/ExportDialog.rst.txt -.. index:: - csvQuote - CSV Downloads; Quoting character +.. index:: + csvQuote + CSV Downloads; Quoting character +.. _pageTsConfigWebList-csvQuote: csvQuote ======== -:aspect:`Datatype` - string +.. confval:: csvQuote + :name: mod-web-list-csvQuote + :type: string + :Default: `"` -:aspect:`Description` - Defines the default quoting character for CSV downloads. The value set will - be displayed as default quoting in the download dialog in the list module. + Defines the default quoting character for CSV downloads. The value set will + be displayed as default quoting in the download dialog in the list module. +.. _pageTsConfigWebList-csvQuote-example: -:aspect:`Default` - " +Example: Use single quotes as quoting character for CSV downloads +----------------------------------------------------------------- -:aspect:`Example` - .. include:: /CodeSnippets/PageTSconfig/Mod/CsvExport.rst.txt +.. include:: /CodeSnippets/PageTSconfig/Mod/CsvExport.rst.txt - .. include:: /Images/AutomaticScreenshots/WebList/ExportDialog.rst.txt +.. include:: /Images/AutomaticScreenshots/WebList/ExportDialog.rst.txt -.. index:: - deniedNewTables - Buttons; Create new -.. _pageTsConfigWebListDeniedNewTables: +.. index:: + deniedNewTables + Buttons; Create new +.. _pageTsConfigWebListDeniedNewTables: deniedNewTables =============== -:aspect:`Datatype` - list of table names +.. confval:: deniedNewTables + :name: mod-web-list-deniedNewTables + :type: list of table names + + If this list is set, then the tables listed here won't have a link to "create new record" in the page + and sub pages. This also affects the "Create new record" content element wizard. -:aspect:`Description` - If this list is set, then the tables listed here won't have a link to "create new record" in the page - and sub pages. This also affects the "Create new record" content element wizard. + This is the opposite of :ref:`allowedNewTables property `. - This is the opposite of :ref:`allowedNewTables property `. + If `allowedNewTables` and `deniedNewTables` contain a common subset, `deniedNewTables` takes precedence. - If `allowedNewTables` and `deniedNewTables` contain a common subset, `deniedNewTables` takes precedence. +Hide "Create new record" links in tables sys_category and tt_content +-------------------------------------------------------------------- -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - mod.web_list { - deniedNewTables = sys_category, tt_content - } + mod.web_list { + deniedNewTables = sys_category, tt_content + } -.. index:: disableSingleTableView +.. index:: disableSingleTableView +.. _pageTsConfigWebList-disableSingleTableView: disableSingleTableView ====================== -:aspect:`Datatype` - boolean - -:aspect:`Description` - If set, then the links on the table titles which shows a single table - listing will not be available - including sorting links on columns - titles, because these links jumps to the table-only view. +.. confval:: disableSingleTableView + :name: mod-web-list-disableSingleTableView + :type: boolean + If set, then the links on the table titles which shows a single table + listing will not be available - including sorting links on columns + titles, because these links jumps to the table-only view. -.. index:: displayColumnSelector +.. index:: displayColumnSelector +.. _pageTsConfigWebList-displayColumnSelector: displayColumnSelector ===================== -:aspect:`Datatype` - boolean +.. confval:: displayColumnSelector + :name: mod-web-list-displayColumnSelector + :type: boolean + :Default: `true` -:aspect:`Default` - true + The column selector is enabled by default and can be disabled with this + option. The column selector is displayed at the top of each record list in + the :guilabel:`List` module. It can be used to compare different fields of + the listed records. -:aspect:`Description` - The column selector is enabled by default and can be disabled with this - option. The column selector is displayed at the top of each record list in - the :guilabel:`List` module. It can be used to compare different fields of - the listed records. +.. _pageTsConfigWebList-displayColumnSelector-example: -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Example: Hide the column selector +--------------------------------- - # disable the column selector completely - mod.web_list.displayColumnSelector = 0 +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig -.. index:: - enableClipBoard - Buttons; Show clipboard - Clipboard; Enable + mod.web_list.displayColumnSelector = 0 -enableClipBoard -=============== +.. index:: + enableClipBoard + Buttons; Show clipboard + Clipboard; Enable -:aspect:`Datatype` - list of keywords +.. _pageTsConfigWebList-enableClipBoard: -:aspect:`Description` - Determines whether the checkbox "Show clipboard" in the list module is - shown or hidden. If it is hidden, you can predefine it to be always - activated or always deactivated. +enableClipBoard +=============== - The following values are possible: +.. confval:: enableClipBoard + :name: mod-web-list-enableClipBoard + :type: list of keywords + :Default: `selectable` - activated - The option is activated and the checkbox is hidden. + Determines whether the checkbox "Show clipboard" in the list module is + shown or hidden. If it is hidden, you can predefine it to be always + activated or always deactivated. - deactivated - The option is deactivated and the checkbox is hidden. + The following values are possible: - selectable - The checkbox is shown so that the option can be selected by the user. + activated + The option is activated and the checkbox is hidden. -:aspect:`Default` - selectable + deactivated + The option is deactivated and the checkbox is hidden. + selectable + The checkbox is shown so that the option can be selected by the user. -.. index:: - enableDisplayBigControlPanel - List module; Extended view +.. index:: + enableDisplayBigControlPanel + List module; Extended view +.. _pageTsConfigWebList-enableDisplayBigControlPanel: enableDisplayBigControlPanel ============================ -.. versionchanged:: 11.3 - The checkbox :guilabel:`Extended view` was removed with TYPO3 v11.3. - Therefore the option :typoscript:`mod.web_list.enableDisplayBigControlPanel` - has no effect anymore. +.. versionchanged:: 11.3 + The checkbox :guilabel:`Extended view` was removed with TYPO3 v11.3. + Therefore the option :typoscript:`mod.web_list.enableDisplayBigControlPanel` + has no effect anymore. -.. index:: - hideTables - List module; Hide tables +.. index:: + hideTables + List module; Hide tables +.. _pageTsConfigWebList-hideTables: hideTables ========== -:aspect:`Datatype` - list of table names, or * +.. confval:: hideTables + :name: mod-web-list-hideTables + :type: list of table names, or * -:aspect:`Description` - Hide these tables in record listings (comma-separated) + Hide these tables in record listings (comma-separated) - If `*` is used, all tables will be hidden + If `*` is used, all tables will be hidden -.. index:: - hideTranslations - List module; Hide translations - Localization; Hide translations in List module +.. index:: + hideTranslations + List module; Hide translations + Localization; Hide translations in List module +.. _pageTsConfigWebList-hideTranslations: hideTranslations ================ -:aspect:`Datatype` - list of table names, or * +.. confval:: hideTranslations + :name: mod-web-list-hideTranslations + :type: list of table names, or * + + For tables in this list all their translated records in additional website languages will be hidden + in the List module. -:aspect:`Description` - For tables in this list all their translated records in additional website languages will be hidden - in the List module. + Use `*` to hide all records of additional website languages in all tables or set + single table names as comma-separated list. - Use `*` to hide all records of additional website languages in all tables or set - single table names as comma-separated list. +.. _pageTsConfigWebList-hideTranslations-example-all: -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Example: Hide all translated records +------------------------------------ - mod.web_list.hideTranslations = * +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig + mod.web_list.hideTranslations = * - mod.web_list.hideTranslations = tt_content, tt_news +.. _pageTsConfigWebList-hideTranslations-example: +Example: Hide translated records in tables tt_content and tt_news +----------------------------------------------------------------- -.. index:: - itemsLimitPerTable - List module; Items per table +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig + + mod.web_list.hideTranslations = tt_content, tt_news + +.. index:: + itemsLimitPerTable + List module; Items per table +.. _pageTsConfigWebList-itemsLimitPerTable: itemsLimitPerTable ================== -:aspect:`Datatype` - positive integer +.. confval:: itemsLimitPerTable + :name: mod-web-list-itemsLimitPerTable + :type: positive integer + :Default: 20 +` + Set the default maximum number of items to show per table. + The number must be between `5` and `10000`. If below or above this range, + the nearest valid number will be used. -:aspect:`Description` - Set the default maximum number of items to show per table. - The number must be between `5` and `10000`. If below or above this range, - the nearest valid number will be used. +.. _pageTsConfigWebList-itemsLimitPerTable-example: -:aspect:`Default` - 20 +Example: Limit items per table in overview to 10 +------------------------------------------------ -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - mod.web_list { - itemsLimitPerTable = 10 - } + mod.web_list { + itemsLimitPerTable = 10 + } -.. index:: - itemsLimitSingleTable - List module; Items per table in single table view +.. index:: + itemsLimitSingleTable + List module; Items per table in single table view +.. _pageTsConfigWebList-itemsLimitSingleTable: itemsLimitSingleTable ===================== -:aspect:`Datatype` - positive integer +.. confval:: itemsLimitSingleTable + :name: mod-web-list-itemsLimitSingleTable + :type: positive integer + :Default: 100 -:aspect:`Description` - Set the default maximum number of items to show in single table view. - The number must be between `5` and `10000`. If below or above this range, - the nearest valid number will be used. + Set the default maximum number of items to show in single table view. + The number must be between `5` and `10000`. If below or above this range, + the nearest valid number will be used. -:aspect:`Default` - 100 +.. _pageTsConfigWebList-itemsLimitSingleTable-example: -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Example: Limit items in single table view to 10 +----------------------------------------------- - mod.web_list { - itemsLimitSingleTable = 10 - } +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig + mod.web_list { + itemsLimitSingleTable = 10 + } -.. index:: - listOnlyInSingleTableView - List module; Records in single table view only +.. index:: + listOnlyInSingleTableView + List module; Records in single table view only +.. _pageTsConfigWebList-listOnlyInSingleTableView: listOnlyInSingleTableView ========================= -:aspect:`Datatype` - boolean +.. confval:: listOnlyInSingleTableView + :name: mod-web-list-listOnlyInSingleTableView + :type: boolean + :Default: 0 + + If set, the default view will not show the single records inside a + table anymore, but only the available tables and the number of records + in these tables. The individual records will only be listed in the + single table view, that means when a table has been clicked. This is + very practical for pages containing many records from many tables! -:aspect:`Description` - If set, the default view will not show the single records inside a - table anymore, but only the available tables and the number of records - in these tables. The individual records will only be listed in the - single table view, that means when a table has been clicked. This is - very practical for pages containing many records from many tables! +.. _pageTsConfigWebList-listOnlyInSingleTableView-example: -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Example: Only list records of tables in single-table mode +--------------------------------------------------------- - mod.web_list { - listOnlyInSingleTableView = 1 - } +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - The result will be that records from tables are only listed in the single-table mode: + mod.web_list { + listOnlyInSingleTableView = 1 + } - .. figure:: /Images/ManualScreenshots/List/PageTsModWebListListOnlyInSingleTableView.png - :alt: The list module after activating the single-table mode + The result will be that records from tables are only listed in the single-table mode: - The list module after activating the single-table mode +.. figure:: /Images/ManualScreenshots/List/PageTsModWebListListOnlyInSingleTableView.png + :alt: The list module after activating the single-table mode -:aspect:`Default` - 0 + The list module after activating the single-table mode -.. index:: - newPageWizard.override - Pages; New wizard +.. index:: + newPageWizard.override + Pages; New wizard +.. _pageTsConfigWebList-newPageWizard-override: newPageWizard.override ====================== -:aspect:`Datatype` - string +.. confval:: newPageWizard.override + :name: mod-web-list-newPageWizard-override + :type: string -:aspect:`Description` - If set to an extension key, then the specified module or route will be used for creating - new elements on the page. + If set to an extension key, then the specified module or route will be used for creating + new elements on the page. -.. index:: - noCreateRecordsLink - Buttons; Create new record +.. index:: + noCreateRecordsLink + Buttons; Create new record +.. _pageTsConfigWebList-noCreateRecordsLink: noCreateRecordsLink =================== -:aspect:`Datatype` - boolean +.. confval:: noCreateRecordsLink + :name: mod-web-list-noCreateRecordsLink + :type: boolean + :Default: 0 -:aspect:`Description` - If set, the link "Create new record" is hidden. + If set, the link "Create new record" is hidden. -:aspect:`Default` - 0 +.. _pageTsConfigWebList-noCreateRecordsLink-example: -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +Example: Hide the "Create new record" link. +------------------------------------------- - mod.web_list { - noCreateRecordsLink = 1 - } +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig + mod.web_list { + noCreateRecordsLink = 1 + } -.. index:: - noExportRecordsLinks - Buttons; Export - Buttons; Download + +.. index:: + noExportRecordsLinks + Buttons; Export + Buttons; Download +.. _pageTsConfigWebList-noExportRecordsLinks: noExportRecordsLinks ==================== -:aspect:`Datatype` - boolean +.. confval:: noExportRecordsLinks + :name: mod-web-list-noExportRecordsLinks + :type: boolean + :Default: 0 -:aspect:`Description` - If set, the :guilabel:`Download` and :guilabel:`Export` buttons are hidden - in the list module. This applies to - the :guilabel:`Export` button located at the top left for t3d exports, the - :guilabel:`Download` button directly on the table - listing for csv download and the :guilabel:`Download` button in the tables - single view. + If set, the :guilabel:`Download` and :guilabel:`Export` buttons are hidden + in the list module. This applies to + the :guilabel:`Export` button located at the top left for t3d exports, the + :guilabel:`Download` button directly on the table + listing for csv download and the :guilabel:`Download` button in the tables + single view. - This option is for example important to disable batch - download of sensitive data via CSV or t3d exports. + This option is for example important to disable batch + download of sensitive data via CSV or t3d exports. - .. include:: /Images/AutomaticScreenshots/WebList/WithExportButtons.rst.txt + .. include:: /Images/AutomaticScreenshots/WebList/WithExportButtons.rst.txt - .. include:: /Images/AutomaticScreenshots/WebList/NoExportButtons.rst.txt + .. include:: /Images/AutomaticScreenshots/WebList/NoExportButtons.rst.txt - .. note:: - This option only hides the buttons in the list module. Bulk export of - data is still possible via the context menu of the page tree. + .. note:: + This option only hides the buttons in the list module. Bulk export of + data is still possible via the context menu of the page tree. -:aspect:`Default` - 0 +.. _pageTsConfigWebList-noExportRecordsLinks-example: -:aspect:`Example` - .. include:: /CodeSnippets/PageTSconfig/Mod/noExportRecordsLinks.rst.txt +Example: Hide the "Download" and "Export" links +----------------------------------------------- +.. include:: /CodeSnippets/PageTSconfig/Mod/noExportRecordsLinks.rst.txt -.. index:: - noViewWithDokTypes - Buttons; View page +.. index:: + noViewWithDokTypes + Buttons; View page +.. _pageTsConfigWebList-noViewWithDokTypes: noViewWithDokTypes ================== -:aspect:`Datatype` - string - -:aspect:`Description` - Hide view icon for the defined :ref:`doktypes ` - (comma-separated). - -:aspect:`Default` - 254,255 +.. confval:: noViewWithDokTypes + :name: mod-web-list-noViewWithDokTypes + :type: string (comma-separated list of integers) + :Default: `254,255` + Hide view icon for the defined :ref:`doktypes `. -.. index:: - table.[tableName].hideTable - List module; Hide tables +.. index:: + table.[tableName].hideTable + List module; Hide tables +.. _pageTsConfigWebList-table-tableName-hideTable: table.[tableName].hideTable =========================== -:aspect:`Datatype` - boolean +.. confval:: table.[tableName].hideTable + :name: mod-web-list-table-tableName-hideTable + :type: boolean + :Default: 0 -:aspect:`Description` - If set to non-zero, the table is hidden. If it is zero, table is shown - even if table name is listed in "hideTables" list. + If set to non-zero, the table is hidden. If it is zero, table is shown + even if table name is listed in "hideTables" list. -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. _pageTsConfigWebList-table-tableName-hideTable-example: - mod.web_list.table.tt_content.hideTable = 1 +Example: Hide table tt_content +------------------------------ +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig -.. index:: - table.[tableName].displayColumnSelector - List module; columns selector + mod.web_list.table.tt_content.hideTable = 1 + + +.. index:: + table.[tableName].displayColumnSelector + List module; columns selector +.. _pageTsConfigWebList-table-tableName-displayColumnSelector: table.[tableName].displayColumnSelector ======================================= -:aspect:`Datatype` - boolean +.. confval:: table.[tableName].displayColumnSelector + :name: mod-web-list-table-tableName-displayColumnSelector + :type: boolean + + If set to false, the column selector in the title row of the specified + table gets hidden. If the column selctors have been disabled globally + this option can be used to enable it for a specific table. + +.. _pageTsConfigWebList-table-tableName-displayColumnSelector-example-disable: + +Example: Hide the column selector for tt_content +------------------------------------------------ -:aspect:`Description` - If set to false, the column selector in the title row of the specified - table gets hidden. If the column selctors have been disabled globally - this option can be used to enable it for a specific table. +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig -:aspect:`Example` - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig + mod.web_list.table.tt_content.displayColumnSelector = 0 - # disable the column selector for tt_content - mod.web_list.table.tt_content.displayColumnSelector = 0 +.. _pageTsConfigWebList-table-tableName-displayColumnSelector-example-enable: +Example: Hide the column selector for all tables but sys_category +----------------------------------------------------------------- - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig +.. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - # Disable the column selector everywhere except for a specific table - mod.web_list.displayColumnSelector = 0 - mod.web_list.table.sys_category.displayColumnSelector = 1 + mod.web_list.displayColumnSelector = 0 + mod.web_list.table.sys_category.displayColumnSelector = 1 -.. index:: - tableDisplayOrder - List module; Order tables +.. index:: + tableDisplayOrder + List module; Order tables +.. _pageTsConfigWebList-tableDisplayOrder: tableDisplayOrder ================= -:aspect:`Datatype` - array +.. confval:: tableDisplayOrder.[tableName] + :name: mod-web-list-tableDisplayOrder + :type: array -:aspect:`Description` - Flexible configuration of the order in which tables are displayed. + Flexible configuration of the order in which tables are displayed. - The keywords `before` and `after` can be used to specify an order relative to other table names. + The keywords `before` and `after` can be used to specify an order relative + to other table names. -:aspect:`Example` - .. code-block:: typoscript + .. code-block:: typoscript - mod.web_list.tableDisplayOrder. { - before = , , ... - after = , , ... - } + mod.web_list.tableDisplayOrder. { + before = , , ... + after = , , ... + } -.. index:: - searchLevel.items - Items; Search level +.. index:: + searchLevel.items + Items; Search level +.. _pageTsConfigWebList-searchLevel-items: searchLevel.items ================= -:aspect:`Datatype` - array +.. confval:: searchLevel.items + :name: mod-web-list-searchLevel-items + :type: array -:aspect:`Description` - Sets labels for each level label in the search level select box + Sets labels for each level label in the search level select box - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/page.tsconfig + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/page.tsconfig - mod.web_list.searchLevel.items { - -1 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.infinite - 0 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.0 - 1 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.1 - 2 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.2 - 3 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.3 - 4 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.4 - } + mod.web_list.searchLevel.items { + -1 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.infinite + 0 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.0 + 1 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.1 + 2 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.2 + 3 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.3 + 4 = EXT:core/Resources/Private/Language/locallang_core.xlf:labels.searchLevel.4 + }