From b63d83317e8c437450026a3e4215aa671b2ba19a Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Mon, 28 Oct 2024 09:46:47 +0100 Subject: [PATCH] Use confval-menu for user TSconfig options releases: main, 13.4, 12.4 --- Documentation/UserTsconfig/Options.rst | 1682 ++++++++++-------------- 1 file changed, 721 insertions(+), 961 deletions(-) diff --git a/Documentation/UserTsconfig/Options.rst b/Documentation/UserTsconfig/Options.rst index da58be1..d4254d3 100644 --- a/Documentation/UserTsconfig/Options.rst +++ b/Documentation/UserTsconfig/Options.rst @@ -21,1265 +21,1025 @@ upper right toolbar cache menu for non-admin users: Properties ========== -.. contents:: - :depth: 2 - :local: +.. confval-menu:: + :name: confval-group-1 + :display: table + :type: + :Default: + .. _useroptions-additionalPreviewLanguages: -.. todo:: How does this work with site configurations? -.. index:: Localization; preview languages -.. _useroptions-additionalPreviewLanguages: + .. confval:: additionalPreviewLanguages + :name: useroptions-additionalPreviewLanguages + :type: list of sys_language IDs -additionalPreviewLanguages --------------------------- + .. todo:: How does this work with site configurations? -.. confval:: additionalPreviewLanguages - :name: useroptions-additionalPreviewLanguages - :type: list of sys_language IDs + The user will see these additional languages when localizing stuff in + TCEforms. The list are IDs of site languages, as defined in the + :yaml:`languageId` property of the + :ref:`site configuration `. - The user will see these additional languages when localizing stuff in - TCEforms. The list are IDs of site languages, as defined in the - :yaml:`languageId` property of the - :ref:`site configuration `. + .. _useroptions-alertPopups: -.. index:: Backend; Alert popups -.. _useroptions-alertPopups: + .. confval:: alertPopups + :name: useroptions-alertPopups + :type: bitmask + :Default: 255 (show all warnings) -alertPopups ------------ + Configure which Javascript popup alerts have to be displayed and which not: -.. confval:: alertPopups - :name: useroptions-alertPopups - :type: bitmask - :Default: 255 (show all warnings) + * 1 – onTypeChange + * 2 – copy / move / paste + * 4 – delete + * 8 – FE editing + * 128 – other (not used yet) - Configure which Javascript popup alerts have to be displayed and which not: - * 1 – onTypeChange - * 2 – copy / move / paste - * 4 – delete - * 8 – FE editing - * 128 – other (not used yet) + .. _useroptions-bookmarkGroups: + .. confval:: bookmarkGroups + :name: useroptions-bookmarkGroups + :type: Array of integers / strings -.. index:: Backend; Bookmark groups -.. _useroptions-bookmarkGroups: + Set groups of bookmarks that can be accessed by the user. This affects the + bookmarks toolbar item in the top right of the backend. -bookmarkGroups --------------- + By default, 5 default groups will be defined globally (shared, can + only be set by admins) and also for each user (personal bookmarks): -.. confval:: bookmarkGroups - :name: useroptions-bookmarkGroups - :type: Array of integers / strings + 1. Pages + 2. Records + 3. Files + 4. Tools + 5. Miscellaneous - Set groups of bookmarks that can be accessed by the user. This affects the - bookmarks toolbar item in the top right of the backend. + Set 0 to disable one of these group IDs, 1 to enable it (this is the + default) or "string" to change the label accordingly. - By default, 5 default groups will be defined globally (shared, can - only be set by admins) and also for each user (personal bookmarks): + Example: - 1. Pages - 2. Records - 3. Files - 4. Tools - 5. Miscellaneous + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - Set 0 to disable one of these group IDs, 1 to enable it (this is the - default) or "string" to change the label accordingly. + bookmarkGroups { + 1 = 1 + 2 = My Group + 3 = 0 + 4 = + } - Example: + Bookmark group 1 is loaded with the default label (Pages), group 2 is + loaded and labeled as "My Group" and groups 3 and 4 are disabled. + Group 5 has not been set, so it will be displayed by default, just + like group 1. - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. versionadded:: 11.0 - bookmarkGroups { - 1 = 1 - 2 = My Group - 3 = 0 - 4 = - } + Custom language labels can also be used instead of a fixed label: - Bookmark group 1 is loaded with the default label (Pages), group 2 is - loaded and labeled as "My Group" and groups 3 and 4 are disabled. - Group 5 has not been set, so it will be displayed by default, just - like group 1. + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - .. versionadded:: 11.0 + bookmarkGroups { + 2 = LLL:EXT:sitepackage/Resources/Private/Language/locallang_be.xlf:bookmarkGroups.2 + } - Custom language labels can also be used instead of a fixed label: + .. _useroptions-clearCache: - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. confval:: clearCache + :name: useroptions-clearCache - bookmarkGroups { - 2 = LLL:EXT:sitepackage/Resources/Private/Language/locallang_be.xlf:bookmarkGroups.2 - } + .. _useroptions-clearCache-all: -.. _useroptions-clearCache: + .. confval:: all + :name: useroptions-clearCache-all + :type: boolean + :Default: 0 + :Path: options.clearCache.all -clearCache ----------- + This will allow a non-admin user to clear frontend and page-related caches, + plus some backend-related caches (that is everything including templates); + if it is explicitly set to 0 for an admin user, it will remove the clear all + option on toolbar for that user. -.. index:: Clear cache; Clear all button for non admins -.. _useroptions-clearCache-all: + .. _useroptions-clearCache-pages: -clearCache.all -~~~~~~~~~~~~~~ + .. confval:: pages + :name: useroptions-clearCache-pages + :type: boolean + :Default: 0 + :Path: options.clearCache.pages -.. confval:: clearCache.all - :name: useroptions-clearCache-all - :type: boolean - :Default: 0 + If set to 1, this will allow a non-admin user to clear frontend and + page-related caches. + .. _useroptions-clipboardNumberPads: - This will allow a non-admin user to clear frontend and page-related caches, - plus some backend-related caches (that is everything including templates); - if it is explicitly set to 0 for an admin user, it will remove the clear all - option on toolbar for that user. + .. confval:: clipboardNumberPads + :name: useroptions-clipboardNumberPads + :type: integer (0-20) + :Default: 3 + This allows you to enter how many pads you want on the clipboard. -.. index:: Clear cache; Clear pages button for non admins -.. _useroptions-clearCache-pages: + .. _useroptions-contextMenu-key-disableItems: -clearCache.pages -~~~~~~~~~~~~~~~~ + .. confval:: contextMenu.table.[tableName][.context].disableItems + :name: useroptions-contextMenu-key-disableItems + :type: list of items -.. confval:: clearCache.pages - :name: useroptions-clearCache-pages - :type: boolean - :Default: 0 + List of :ref:`context menu ` ("clickmenu") items to + disable. - If set to 1, this will allow a non-admin user to clear frontend and - page-related caches. + .. figure:: /Images/ManualScreenshots/List/PagesContextMenu.png + :alt: Context menu of the page tree + :class: with-shadow + Context menu of the page tree -.. index:: Clipboard; Number of pads -.. _useroptions-clipboardNumberPads: + The :typoscript:`[tableName]` refers to the type of the record (database + table name) the context menu is shown for, for example, :sql:`pages`, + :sql:`sys_file`, :sql:`tt_content`, etc. -clipboardNumberPads -------------------- + The optional key :typoscript:`[.context]` refers to the place from which the + context menu is triggered. The Core uses just one context called `tree` for + context menus triggered from page tree and folder tree. This way you can + disable certain options for one context, but keep them for another. -.. confval:: clipboardNumberPads - :name: useroptions-clipboardNumberPads - :type: integer (0-20) - :Default: 3 + Items to disable for "page" type are: - This allows you to enter how many pads you want on the clipboard. + * :typoscript:`view` + * :typoscript:`edit` + * :typoscript:`new` + * :typoscript:`info` + * :typoscript:`copy` + * :typoscript:`copyRelease` + * :typoscript:`cut` + * :typoscript:`cutRelease` + * :typoscript:`pasteAfter` + * :typoscript:`pasteInto` + * :typoscript:`newWizard` + * :typoscript:`pagesSort` + * :typoscript:`pagesNewMultiple` + * :typoscript:`openListModule` + * :typoscript:`mountAsTreeRoot` + * :typoscript:`hideInMenus` + * :typoscript:`showInMenus` + * :typoscript:`permissions` + * :typoscript:`enable` + * :typoscript:`disable` + * :typoscript:`delete` + * :typoscript:`history` + * :typoscript:`clearCache` + Items to disable for "sys_file" type (that is files/folders) are: -.. index:: ContextMenu; Disable items -.. _useroptions-contextMenu-key-disableItems: + * :typoscript:`edit` + * :typoscript:`rename` + * :typoscript:`upload` + * :typoscript:`new` + * :typoscript:`info` + * :typoscript:`copy` + * :typoscript:`copyRelease` + * :typoscript:`cut` + * :typoscript:`cutRelease` + * :typoscript:`pasteInto` + * :typoscript:`delete` -contextMenu disableItems ------------------------- + When the system extension Import/Export (EXT:impexp) is installed then two + more options become available: -.. confval:: contextMenu.table.[tableName][.context].disableItems - :name: useroptions-contextMenu-key-disableItems - :type: list of items + * :typoscript:`exportT3d` + * :typoscript:`importT3d` - List of :ref:`context menu ` ("clickmenu") items to - disable. + Example: - .. figure:: /Images/ManualScreenshots/List/PagesContextMenu.png - :alt: Context menu of the page tree - :class: with-shadow + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - Context menu of the page tree + # Remove "New" and "Create New wizard" for pages context menu (list module) + options.contextMenu.table.pages.disableItems = new,newWizard - The :typoscript:`[tableName]` refers to the type of the record (database - table name) the context menu is shown for, for example, :sql:`pages`, - :sql:`sys_file`, :sql:`tt_content`, etc. + # Remove "New" and "Create New wizard" in page tree context menu + options.contextMenu.table.pages.tree.disableItems = new,newWizard - The optional key :typoscript:`[.context]` refers to the place from which the - context menu is triggered. The Core uses just one context called `tree` for - context menus triggered from page tree and folder tree. This way you can - disable certain options for one context, but keep them for another. + # Remove the "More options" item in the page tree context menu and all its subelements + options.contextMenu.table.pages.tree.disableItems = newWizard, pagesSort, pagesNewMultiple, openListModule, mountAsTreeRoot, exportT3d, importT3d, hideInMenus, showInMenus, permissions - Items to disable for "page" type are: + .. _useroptions-dashboard: - * :typoscript:`view` - * :typoscript:`edit` - * :typoscript:`new` - * :typoscript:`info` - * :typoscript:`copy` - * :typoscript:`copyRelease` - * :typoscript:`cut` - * :typoscript:`cutRelease` - * :typoscript:`pasteAfter` - * :typoscript:`pasteInto` - * :typoscript:`newWizard` - * :typoscript:`pagesSort` - * :typoscript:`pagesNewMultiple` - * :typoscript:`openListModule` - * :typoscript:`mountAsTreeRoot` - * :typoscript:`hideInMenus` - * :typoscript:`showInMenus` - * :typoscript:`permissions` - * :typoscript:`enable` - * :typoscript:`disable` - * :typoscript:`delete` - * :typoscript:`history` - * :typoscript:`clearCache` + .. confval:: dashboard + :name: useroptions-dashboard - Items to disable for "sys_file" type (that is files/folders) are: + .. _useroptions-dashboard-dashboardPresetsForNewUsers: - * :typoscript:`edit` - * :typoscript:`rename` - * :typoscript:`upload` - * :typoscript:`new` - * :typoscript:`info` - * :typoscript:`copy` - * :typoscript:`copyRelease` - * :typoscript:`cut` - * :typoscript:`cutRelease` - * :typoscript:`pasteInto` - * :typoscript:`delete` + .. confval:: dashboardPresetsForNewUsers + :name: useroptions-dashboard-dashboardPresetsForNewUsers + :type: list of dashboard identifiers + :Default: default + :Path: options.dashboard.dashboardPresetsForNewUsers - When the system extension Import/Export (EXT:impexp) is installed then two - more options become available: + List of dashboard identifiers to be used on initial dashboard module access. - * :typoscript:`exportT3d` - * :typoscript:`importT3d` + Example: - Example: + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + options.dashboard.dashboardPresetsForNewUsers := addToList(customDashboard) - # Remove "New" and "Create New wizard" for pages context menu (list module) - options.contextMenu.table.pages.disableItems = new,newWizard + .. _useroptions-defaultResourcesViewMode: - # Remove "New" and "Create New wizard" in page tree context menu - options.contextMenu.table.pages.tree.disableItems = new,newWizard + .. confval:: defaultResourcesViewMode + :name: useroptions-defaultResourcesViewMode + :type: `list` or `tiles` + :Default: `tiles` - # Remove the "More options" item in the page tree context menu and all its subelements - options.contextMenu.table.pages.tree.disableItems = newWizard, pagesSort, pagesNewMultiple, openListModule, mountAsTreeRoot, exportT3d, importT3d, hideInMenus, showInMenus, permissions + The option :typoscript:`options.defaultResourcesViewMode` has + been introduced, which allows to define the initial display mode. Valid + values are therefore `list` and `tiles`, e.g.: + The listing of resources in the TYPO3 Backend, e.g. in the + :guilabel:`File > Filelist` module or the `FileBrowser` can be changed + between `list` and `tiles`. TYPO3 serves by default `tiles`, if the user + has not already made a choice. -.. index:: Element browser; Create Folders -.. _useroptions-createFoldersInEB: + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig -createFoldersInEB ------------------ + options.defaultResourcesViewMode = list -.. versionchanged:: 12.4 - With the :ref:`migration of the "Create folder" view into a separate modal ` - used in EXT:filelist, which is based on the element browser as well, this - option became useless and is not evaluated anymore. + .. _useroptions-defaultUploadFolder: -.. _useroptions-dashboard: + .. confval:: defaultUploadFolder + :name: useroptions-defaultUploadFolder + :type: string -dashboard ---------- + When a user uploads files they are stored in the default upload folder + of the first file storage that user may access. The folder is used for + uploads in the TCEforms fields. In general, this will be + :file:`fileadmin/user_upload/`. -.. index:: Dashboard; Presets -.. _useroptions-dashboard-dashboardPresetsForNewUsers: + With this property it is possible to set a specific upload folder. -dashboard.dashboardPresetsForNewUsers -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + The syntax is "storage_uid:file_path". -.. confval:: dashboard.dashboardPresetsForNewUsers - :name: useroptions-dashboard-dashboardPresetsForNewUsers - :type: list of dashboard identifiers - :Default: default + .. note:: + It is also possible to set a default upload folder for a page via + :ref:`page TSconfig `. - List of dashboard identifiers to be used on initial dashboard module access. + Example: - Example: + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + options.defaultUploadFolder = 2:user_folders/my_folder/ - options.dashboard.dashboardPresetsForNewUsers := addToList(customDashboard) + .. _useroptions-disableDelete: -.. _useroptions-defaultResourcesViewMode: + .. confval:: disableDelete + :name: useroptions-disableDelete + :type: boolean -defaultResourcesViewMode ------------------------- + Disables the :guilabel:`Delete` button in TCEFORMs. -.. confval:: defaultResourcesViewMode - :name: useroptions-defaultResourcesViewMode - :type: `list` or `tiles` - :Default: `tiles` + Note, it is possible to set this for single tables using + :typoscript:`options.disableDelete.`. Any value set for a single + table will override the default value set for :typoscript:`disableDelete`. - The option :typoscript:`options.defaultResourcesViewMode` has - been introduced, which allows to define the initial display mode. Valid - values are therefore `list` and `tiles`, e.g.: + Example: - The listing of resources in the TYPO3 Backend, e.g. in the - :guilabel:`File > Filelist` module or the `FileBrowser` can be changed - between `list` and `tiles`. TYPO3 serves by default `tiles`, if the user - has not already made a choice. + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + options.disableDelete.tt_content = 1 - options.defaultResourcesViewMode = list + .. _useroptions-dontMountAdminMounts: + .. confval:: dontMountAdminMounts + :name: useroptions-dontMountAdminMounts + :type: boolean -.. index:: Upload folder; Default -.. _useroptions-defaultUploadFolder: + This options prevents the root to be mounted for an admin user. -defaultUploadFolder -------------------- + .. note:: + Only for admin users. For other users it has no effect. -.. confval:: defaultUploadFolder - :name: useroptions-defaultUploadFolder - :type: string + .. _useroptions-enableBookmarks: - When a user uploads files they are stored in the default upload folder - of the first file storage that user may access. The folder is used for - uploads in the TCEforms fields. In general, this will be - :file:`fileadmin/user_upload/`. + .. confval:: enableBookmarks + :name: useroptions-enableBookmarks + :type: boolean + :Default: 1 - With this property it is possible to set a specific upload folder. + Enables the usage of bookmarks in the backend. - The syntax is "storage_uid:file_path". + .. _useroptions-file_list: - .. note:: - It is also possible to set a default upload folder for a page via - :ref:`page TSconfig `. + .. confval:: file_list + :name: useroptions-file_list - Example: + .. _useroptions-file_list-enableClipBoard: - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. confval:: enableClipBoard + :name: useroptions-enableClipBoard + :type: list of keywords + :Default: selectable + :Path: options.file_list.enableClipBoard - options.defaultUploadFolder = 2:user_folders/my_folder/ + Determines whether the checkbox :guilabel:`Show clipboard` in the file list + module is shown or hidden. If it is hidden, you can predefine it to be + always activated or always deactivated. + The following values are possible: -.. index:: Records; Delete disabled -.. _useroptions-disableDelete: + :typoscript:`activated` + The option is activated and the checkbox is hidden. -disableDelete -------------- + :typoscript:`deactivated` + The option is deactivated and the checkbox is hidden. -.. confval:: disableDelete - :name: useroptions-disableDelete - :type: boolean + :typoscript:`selectable` + The checkbox is shown so that the option can be selected by the user. - Disables the :guilabel:`Delete` button in TCEFORMs. + .. _useroptions-file_list-displayColumnSelector: - Note, it is possible to set this for single tables using - :typoscript:`options.disableDelete.`. Any value set for a single - table will override the default value set for :typoscript:`disableDelete`. + .. confval:: displayColumnSelector + :name: useroptions-file_list-displayColumnSelector + :type: boolean + :Default: true + :Path: options.file_list.displayColumnSelector - Example: + The column selector is enabled by default and can be disabled with this + option. The column selector is displayed at the top of each file list. - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + It can be used to manage the fields displayed for each file / folder, + while containing convenience actions such as "filter", "check all / none" + and "toggle selection". - options.disableDelete.tt_content = 1 + The fields to be selected are a combination of special fields, such as + `references` or `read/write` permissions, the corresponding :sql:`sys_file` + record fields, as well as all available :sql:`sys_file_metadata` fields. + Example: -.. index:: DB mounts; Hide root from admins -.. _useroptions-dontMountAdminMounts: + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig -dontMountAdminMounts --------------------- + # Disable the column selector + file_list.displayColumnSelector = 0 -.. confval:: dontMountAdminMounts - :name: useroptions-dontMountAdminMounts - :type: boolean + .. _useroptions-file_list-enableDisplayThumbnails: - This options prevents the root to be mounted for an admin user. + .. confval:: file_list.enableDisplayThumbnails + :name: useroptions-file_list-enableDisplayThumbnails + :type: list of keywords + :Default: selectable - .. note:: - Only for admin users. For other users it has no effect. + Determines whether the checkbox :guilabel:`Display thumbnails` in the + file list module is shown or hidden. If it is hidden, you can predefine it + to be always activated or always deactivated. + The following values are possible: -.. index:: Bookmarks; enable -.. _useroptions-enableBookmarks: + :typoscript:`activated` + The option is activated and the checkbox is hidden. -enableBookmarks ---------------- + :typoscript:`deactivated` + The option is deactivated and the checkbox is hidden. -.. confval:: enableBookmarks - :name: useroptions-enableBookmarks - :type: boolean - :Default: 1 + :typoscript:`selectable` + The checkbox is shown so that the option can be selected by the user. - Enables the usage of bookmarks in the backend. + .. _useroptions-file_list-filesPerPage: + .. confval:: filesPerPage + :name: useroptions-file_list-filesPerPage + :type: integer + :Default: 40 + :Path: options.file_list.filesPerPage -.. index:: File list + The maximum number of files shown per page in the :guilabel:`File > List` + module. -.. _useroptions-file_list: + .. _useroptions-file_list-primaryActions: -file_list ---------- -.. index:: File list; Clipboard enable -.. _useroptions-file_list-enableClipBoard: + .. confval:: primaryActions + :name: useroptions-useroptions-file_list-primaryActions + :type: string + :Default: :typoscript:`view,metadata,translations,delete` + :Path: options.file_list.primaryActions -file_list.enableClipBoard -~~~~~~~~~~~~~~~~~~~~~~~~~ + Option to add more primary actions to the list view, + which are otherwise only accessible through the "..." menu in the file list + module. -.. confval:: file_list.enableClipBoard - :name: useroptions-enableClipBoard - :type: list of keywords - :Default: selectable + The list of actions to be displayed can be given in the TSConfig of + the backend user. The actions that can be set are - Determines whether the checkbox :guilabel:`Show clipboard` in the file list - module is shown or hidden. If it is hidden, you can predefine it to be - always activated or always deactivated. + * :typoscript:`copy` + * :typoscript:`cut` + * :typoscript:`delete` + * :typoscript:`download` + * :typoscript:`edit` + * :typoscript:`info` + * :typoscript:`metadata` + * :typoscript:`paste` + * :typoscript:`rename` + * :typoscript:`replace` + * :typoscript:`translations` (always active) + * :typoscript:`updateOnlineMedia` + * :typoscript:`upload` + * :typoscript:`view` - The following values are possible: + Example: - :typoscript:`activated` - The option is activated and the checkbox is hidden. + .. code-block:: tsconfig + :caption: EXT:site_package/Configuration/user.tsconfig - :typoscript:`deactivated` - The option is deactivated and the checkbox is hidden. + # This will add "copy", "cut" and "replace" buttons in addition to the three default + # buttons. "translations" can be omitted, as it will be added by default, + # if a TYPO3 site is set up multilingual. + options.file_list.primaryActions = view,metadata,delete,copy,cut,replace - :typoscript:`selectable` - The checkbox is shown so that the option can be selected by the user. + .. figure:: /Images/ManualScreenshots/List/FileListPrimaryActions.png + :alt: Show primary action with additional copy, cut and replace buttons + :class: with-shadow + See option `primaryActions` with three default buttons and the three + additional buttons "copy", "cut" and "replace". As there is no TYPO3 + site set up multilingual the button "translations" is not rendered in + that TYPO3 environment. -.. index:: File list; Column Selector -.. _useroptions-file_list-displayColumnSelector: + .. _useroptions-file_list-thumbnail-height: -file_list.displayColumnSelector -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. confval:: thumbnail.height + :name: useroptions-file_list-thumbnail-height + :type: integer + :Default: 64 + :Path: options.file_list.thumbnail.height -.. confval:: file_list.displayColumnSelector - :name: useroptions-file_list-displayColumnSelector - :type: boolean - :Default: true + All preview images in the file list will be rendered with the configured + thumbnail height. - The column selector is enabled by default and can be disabled with this - option. The column selector is displayed at the top of each file list. + .. _useroptions-file_list-thumbnail-width: - It can be used to manage the fields displayed for each file / folder, - while containing convenience actions such as "filter", "check all / none" - and "toggle selection". + .. confval:: thumbnail.width + :name: useroptions-file_list-thumbnail-width + :type: integer + :Default: 64 + :Path: options.file_list.thumbnail.width - The fields to be selected are a combination of special fields, such as - `references` or `read/write` permissions, the corresponding :sql:`sys_file` - record fields, as well as all available :sql:`sys_file_metadata` fields. + All preview images in the file list will be rendered with the configured + thumbnail width. - Example: + .. _useroptions-file_list-uploader-defaultaction: - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. confval:: uploader.defaultAction + :name: useroptions-file_list-uploader-defaultaction + :type: string + :Default: :typoscript:`Cancel` + :Path: options.file_list.uploader.defaultAction - # Disable the column selector - file_list.displayColumnSelector = 0 + Default action for the modal that appears when during file upload a name + collision occurs. Possible values: + :typoscript:`cancel` + Abort the action. -.. index:: File list; Extended view enable -.. _useroptions-file_list-enableDisplayBigControlPanel: + :typoscript:`rename` + Append the file name with a numerical index. -file_list.enableDisplayBigControlPanel -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + :typoscript:`replace` + Override the file with the uploaded one. -.. versionchanged:: 11.3 - The checkbox :guilabel:`Extended view` was removed with TYPO3 v11.3. - Therefore the option :typoscript:`file_list.enableDisplayBigControlPanel` - has no effect anymore. + .. confval:: folderTree + :name: useroptions-folderTree + .. _useroptions-folderTree-altElementBrowserMountPoints: -.. index:: File list; Thumbnails enable -.. _useroptions-file_list-enableDisplayThumbnails: + .. confval:: altElementBrowserMountPoints + :name: useroptions-folderTree-altElementBrowserMountPoints + :type: list of "storageUid:folderName" items + :Path: options.folderTree.altElementBrowserMountPoints -file_list.enableDisplayThumbnails -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Sets alternative filemounts for use in any folder tree, including in the + :guilabel:`File > List` module, in the element browser and in file + selectors. -.. confval:: file_list.enableDisplayThumbnails - :name: useroptions-file_list-enableDisplayThumbnails - :type: list of keywords - :Default: selectable + Each item consists of storage UID followed by a colon + and the folder name inside that storage. Separate multiple items by + a comma. - Determines whether the checkbox :guilabel:`Display thumbnails` in the - file list module is shown or hidden. If it is hidden, you can predefine it - to be always activated or always deactivated. + For backwards compatibility, defining only a folder name but no + storage uid and colon prepended is still supported. Folders + without a storage UID prepended are assumed to be located in the default + storage, which by default is the :file:`fileadmin/` folder. If a folder + you specify does not exist it will not get mounted. - The following values are possible: + Settings this option is effective in + :ref:`workspaces ` too. - :typoscript:`activated` - The option is activated and the checkbox is hidden. + The alternative file mounts are added to the existing ones defined in + the user or group configuration. - :typoscript:`deactivated` - The option is deactivated and the checkbox is hidden. + Example: - :typoscript:`selectable` - The checkbox is shown so that the option can be selected by the user. + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig + options.folderTree.altElementBrowserMountPoints = _temp_/, 2:/templates, 1:/files/images -.. index:: File list; Files per page -.. _useroptions-file_list-filesPerPage: + .. _useroptions-folderTree-uploadFieldsInLinkBrowser: -file_list.filesPerPage -~~~~~~~~~~~~~~~~~~~~~~ + .. confval:: uploadFieldsInLinkBrowser + :name: useroptions-folderTree-uploadFieldsInLinkBrowser + :type: integer + :Default: 3 + :Path: options.folderTree.uploadFieldsInLinkBrowser -.. confval:: file_list.filesPerPage - :name: useroptions-file_list-filesPerPage - :type: integer - :Default: 40 + This value defines the number of upload fields in the element browser. + Default value is 3, if set to 0, no upload form will be shown. - The maximum number of files shown per page in the :guilabel:`File > List` - module. + .. _useroptions-hideModules: + .. confval:: hideModules + :name: useroptions-hideModules + :type: list of module groups or modules -.. index:: - File list; Primary actions - File list; Allowed actions -.. _useroptions-file_list-primaryActions: + Configure which module groups or modules should be hidden from the main menu. -file_list.primaryActions -~~~~~~~~~~~~~~~~~~~~~~~~ + .. attention:: + It is not an access restriction but makes defined modules invisible. + This means that in principle these modules can still be accessed if the + rights allow this. -.. confval:: file_list.primaryActions - :name: useroptions-useroptions-file_list-primaryActions - :type: string - :Default: :typoscript:`view,metadata,translations,delete` + .. hint:: + A list of all available module groups and modules can be found in in the + backend module :guilabel:`System > Configuration > Backend Modules`. The + system extension "lowlevel" has to be available for accessing this list. - Option to add more primary actions to the list view, - which are otherwise only accessible through the "..." menu in the file list - module. + Example: - The list of actions to be displayed can be given in the TSConfig of - the backend user. The actions that can be set are + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - * :typoscript:`copy` - * :typoscript:`cut` - * :typoscript:`delete` - * :typoscript:`download` - * :typoscript:`edit` - * :typoscript:`info` - * :typoscript:`metadata` - * :typoscript:`paste` - * :typoscript:`rename` - * :typoscript:`replace` - * :typoscript:`translations` (always active) - * :typoscript:`updateOnlineMedia` - * :typoscript:`upload` - * :typoscript:`view` + # Hide only module groups "file" and "help" + options.hideModules = file, help - Example: + # Hide additional modules "info" and "ts" from the "web" group + options.hideModules := addToList(web_info, web_ts) - .. code-block:: tsconfig - :caption: EXT:site_package/Configuration/user.tsconfig + # Hide only module BeLogLog from "system" group + options.hideModules = system_BelogLog - # This will add "copy", "cut" and "replace" buttons in addition to the three default - # buttons. "translations" can be omitted, as it will be added by default, - # if a TYPO3 site is set up multilingual. - options.file_list.primaryActions = view,metadata,delete,copy,cut,replace + .. _useroptions-hideRecords: - .. figure:: /Images/ManualScreenshots/List/FileListPrimaryActions.png - :alt: Show primary action with additional copy, cut and replace buttons - :class: with-shadow + .. confval:: hideRecords - See option `primaryActions` with three default buttons and the three - additional buttons "copy", "cut" and "replace". As there is no TYPO3 - site set up multilingual the button "translations" is not rendered in - that TYPO3 environment. + .. _useroptions-hideRecords-pages: -.. index:: File list; Thumbnails height -.. _useroptions-file_list-thumbnail-height: + .. confval:: pages + :name: useroptions-hideRecords-pages + :type: list of page IDs + :Path: options.hideRecords.pages -file_list.thumbnail.height -~~~~~~~~~~~~~~~~~~~~~~~~~~ + This setting hides records in the backend user interface. It is not an + access restriction but makes defined records invisible. That means in + principle those records can still be edited if the user rights allow. + This makes sense if only a specialized module should be used to edit those + otherwise hidden records. -.. confval:: file_list.thumbnail.height - :name: useroptions-file_list-thumbnail-height - :type: integer - :Default: 64 + This option is currently implemented for the pages table only and has an + effect in the following places: - All preview images in the file list will be rendered with the configured - thumbnail height. + * Page tree navigation frame + * :guilabel:`Web > List` module + * New record wizard + Example: -.. index:: File list; Thumbnails width -.. _useroptions-file_list-thumbnail-width: + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig -file_list.thumbnail.width -~~~~~~~~~~~~~~~~~~~~~~~~~ + options.hideRecords.pages = 12,45 -.. confval:: file_list.thumbnail.width - :name: useroptions-file_list-thumbnail-width - :type: integer - :Default: 64 + .. _useroptions-impexp: - All preview images in the file list will be rendered with the configured - thumbnail width. + .. confval:: impexp + :name: useroptions-impexp + .. _useroptions-impexp-enableExportForNonAdminUser: -.. index:: Uploader; Name collision default action -.. _useroptions-file_list-uploader-defaultaction: + .. confval:: enableExportForNonAdminUser + :name: useroptions-impexp-enableExportForNonAdminUser + :type: boolean + :Default: 0 + :Path: options.impexp.enableExportForNonAdminUser -file_list.uploader.defaultAction -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. note:: + This option was introduced to avoid `information disclosure + `__. -.. confval:: file_list.uploader.defaultAction - :name: useroptions-file_list-uploader-defaultaction - :type: string - :Default: :typoscript:`Cancel` + The import/export module of `EXT:impexp` is disabled by default for + non-admin users. Enable this option, if non-admin users need to use the + module and export data. This should only be enabled for trustworthy + backend users, as it might impose a security risk. - Default action for the modal that appears when during file upload a name - collision occurs. Possible values: + .. _useroptions-impexp-enableImportForNonAdminUser: - :typoscript:`cancel` - Abort the action. + .. confval:: enableImportForNonAdminUser + :name: useroptions-impexp-enableImportForNonAdminUser + :type: boolean + :Default: 0 + :Path: options.impexp.enableImportForNonAdminUser - :typoscript:`rename` - Append the file name with a numerical index. + .. note:: + This option was introduced to avoid `information disclosure `__. - :typoscript:`replace` - Override the file with the uploaded one. + The import/export module of `EXT:impexp` is disabled by default for + non-admin users. Enable this option, if non-admin users need to use the + module and import data. This should only be enabled for trustworthy + backend users, as it might impose a security risk. + .. _useroptions-mayNotCreateEditBookmarks: -.. index:: Folder tree + .. confval:: mayNotCreateEditBookmarks + :name: useroptions-mayNotCreateEditBookmarks + :type: boolean -folderTree ----------- + If set, the user can not create or edit bookmarks. -.. index:: Folder tree; File mounts in element browser -.. _useroptions-folderTree-altElementBrowserMountPoints: -folderTree.altElementBrowserMountPoints -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. _useroptions-noThumbsInEB: -.. confval:: folderTree.altElementBrowserMountPoints - :name: useroptions-folderTree-altElementBrowserMountPoints - :type: list of "storageUid:folderName" items + .. confval:: noThumbsInEB + :name: useroptions-noThumbsInEB + :type: boolean - Sets alternative filemounts for use in any folder tree, including in the - :guilabel:`File > List` module, in the element browser and in file - selectors. + If set, then image thumbnails are not shown in the element browser. - Each item consists of storage UID followed by a colon - and the folder name inside that storage. Separate multiple items by - a comma. + .. _useroptions-overridePageModule: - For backwards compatibility, defining only a folder name but no - storage uid and colon prepended is still supported. Folders - without a storage UID prepended are assumed to be located in the default - storage, which by default is the :file:`fileadmin/` folder. If a folder - you specify does not exist it will not get mounted. - Settings this option is effective in - :ref:`workspaces ` too. + .. _useroptions-pageTree: - The alternative file mounts are added to the existing ones defined in - the user or group configuration. + .. confval:: pageTree + :name: useroptions-pageTree - Example: + .. confval:: overridePageModule + :name: useroptions-pageTree-overridePageModule - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. versionchanged:: 13.0 + This setting has been removed. - options.folderTree.altElementBrowserMountPoints = _temp_/, 2:/templates, 1:/files/images + In order to replace the :guilabel:`Web > Page` module within a third-party + extension, such as TemplaVoila, it is possible to create a custom module entry + in an extension's :file:`Configuration/Backend/Modules.php` with the following + entry: + .. code-block:: php + :caption: EXT:my_extension/Configuration/Backend/Modules.php -.. index:: Folder tree; Create folder; hide -.. _useroptions-folderTree-hideCreateFolder: + return [ + 'my_module' => [ + 'parent' => 'web', + 'position' => ['before' => '*'], + 'access' => 'user', + 'aliases' => ['web_layout'], + 'path' => '/module/my_module', + 'iconIdentifier' => 'module-page', + 'labels' => 'LLL:EXT:backend/Resources/Private/Language/locallang_mod.xlf', + 'routes' => [ + '_default' => [ + 'target' => \MyVendor\MyExtension\Controller\MyController::class . '::mainAction', + ], + ], + ], + ]; -folderTree.hideCreateFolder -~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. _useroptions-pageTree-altElementBrowserMountPoints: -.. versionchanged:: 12.4 - With the :ref:`migration of the "Create folder" view into a separate modal ` - used in EXT:filelist, which is based on the element browser as well, this - option became useless and is not evaluated anymore. + .. confval:: altElementBrowserMountPoints + :name: useroptions-pageTree-altElementBrowserMountPoints + :type: list of integers + :Path: options.pageTree.altElementBrowserMountPoints + Sets alternative webmounts for use in the element browser. You + separate page IDs by a comma. Non-existing page IDs are ignored. If + you insert a non-integer it will evaluate to "0" (zero) and the root + of the page tree is mounted. Effective in + :ref:`workspaces ` too. -.. index:: - Uploader; File number - Uploader; Hide -.. _useroptions-folderTree-uploadFieldsInLinkBrowser: + These alternative webmounts **replace** configured DB mount points + unless you use the + :ref:`altElementBrowserMountPoints.append ` + option. -folderTree.uploadFieldsInLinkBrowser -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Example: -.. confval:: folderTree.uploadFieldsInLinkBrowser - :name: useroptions-folderTree-uploadFieldsInLinkBrowser - :type: integer - :Default: 3 + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - This value defines the number of upload fields in the element browser. - Default value is 3, if set to 0, no upload form will be shown. + options.pageTree.altElementBrowserMountPoints = 34,123 -.. index:: Modules; Hide -.. _useroptions-hideModules: + .. _useroptions-pageTree-altElementBrowserMountPoints-append: -hideModules ------------ + .. confval:: altElementBrowserMountPoints.append + :name: useroptions-pageTree-altElementBrowserMountPoints-append + :type: boolean + :Path: options.pageTree.altElementBrowserMountPoints.append -.. versionchanged:: 12.0 - In TYPO3 versions before 12.0 the :typoscript:`hideModules` option was - appended with the module group. This changed with the introduction of the - new :ref:`module registration API ` - in TYPO3 v12. If you are using an older version of TYPO3 please use the - version switcher on the top left of this document to go to the respective - version. + This option allows administrators to add additional mount points + in the RTE and the wizard element browser instead of replacing + the configured database mount points of the user when using the + existing user TSconfig option. -.. confval:: hideModules - :name: useroptions-hideModules - :type: list of module groups or modules + Example: - Configure which module groups or modules should be hidden from the main menu. + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - .. attention:: - It is not an access restriction but makes defined modules invisible. - This means that in principle these modules can still be accessed if the - rights allow this. + options.pageTree.altElementBrowserMountPoints = 34,123 + options.pageTree.altElementBrowserMountPoints.append = 1 - .. hint:: - A list of all available module groups and modules can be found in in the - backend module :guilabel:`System > Configuration > Backend Modules`. The - system extension "lowlevel" has to be available for accessing this list. + .. _useroptions-pageTree-backgroundColor: - Example: + .. confval:: backgroundColor + :name: useroptions-pageTree-backgroundColor + :type: string + :Path: options.pageTree.backgroundColor - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. deprecated:: 13.1 + This setting has been deprecated and will be removed in TYPO3 v14 due to its + lack of accessibility. It is being replaced with a + :ref:`new label system ` for tree nodes. - # Hide only module groups "file" and "help" - options.hideModules = file, help + In TYPO3 v13 the setting will be migrated to the new label system. Since the + use case is unknown, the generated label will be "Color: ". This + information will be displayed on all affected nodes. - # Hide additional modules "info" and "ts" from the "web" group - options.hideModules := addToList(web_info, web_ts) + Set background colors for tree branches. - # Hide only module BeLogLog from "system" group - options.hideModules = system_BelogLog + The color can be any valid CSS color value. The best results can be achieved + by using RGBa values. -.. _useroptions-hideRecords: + Example: -hideRecords ------------ + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig -.. index:: Records; Hide on pages -.. _useroptions-hideRecords-pages: + # The syntax is: + # options.pageTree.backgroundColor. = + options.pageTree.backgroundColor.147 = orange + options.pageTree.backgroundColor.148 = #AFAFAF + options.pageTree.backgroundColor.151 = rgba(0, 255, 0, 0.1) -hideRecords.pages -~~~~~~~~~~~~~~~~~ + .. figure:: /Images/ManualScreenshots/List/optionsPageTreeBackgroundColor.png + :alt: Tree branches with configured background colors + :class: with-shadow -.. confval:: hideRecords.pages - :name: useroptions-hideRecords-pages - :type: list of page IDs + Tree branches with configured background colors - This setting hides records in the backend user interface. It is not an - access restriction but makes defined records invisible. That means in - principle those records can still be edited if the user rights allow. - This makes sense if only a specialized module should be used to edit those - otherwise hidden records. + .. _useroptions-pageTree-doktypesToShowInNewPageDragArea: - This option is currently implemented for the pages table only and has an - effect in the following places: + .. confval:: doktypesToShowInNewPageDragArea + :name: useroptions-pageTree-doktypesToShowInNewPageDragArea + :type: string + :Default: 1,6,4,7,3,254,255,199 + :Path: options.pageTree.doktypesToShowInNewPageDragArea - * Page tree navigation frame - * :guilabel:`Web > List` module - * New record wizard + If set, the node top panel feature can be configured by a comma-separated + list. Each number stands for a :ref:`doktype ID ` + that should be added to the node top panel. - Example: + .. figure:: /Images/ManualScreenshots/List/PanelNormal.png + :alt: Top panel in normal mode + :class: with-shadow - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + Top panel in normal mode - options.hideRecords.pages = 12,45 + .. figure:: /Images/ManualScreenshots/List/PanelModified.png + :alt: Top panel modified + :class: with-shadow -.. _useroptions-impexp: + Top panel modified -impexp ------- + .. _useroptions-pageTree-excludeDoktypes: -.. index:: Import export; Enable for non admins -.. _useroptions-impexp-enableExportForNonAdminUser: + .. confval:: excludeDoktypes + :name: useroptions-pageTree-excludeDoktypes + :type: list of integers + :Path: options.pageTree.excludeDoktypes -impexp.enableExportForNonAdminUser -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Excludes nodes (pages) with one of the defined + :ref:`doktypes ` from the page tree. + Can be used, for example, for hiding + :ref:`custom doktypes `. -.. versionadded:: 10.4.29/11.5.11 - This option was introduced to avoid `information disclosure - `__. + Example: -.. confval:: impexp.enableExportForNonAdminUser - :name: useroptions-impexp-enableExportForNonAdminUser - :type: boolean - :Default: 0 + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - The import/export module of `EXT:impexp` is disabled by default for - non-admin users. Enable this option, if non-admin users need to use the - module and export data. This should only be enabled for trustworthy - backend users, as it might impose a security risk. + options.pageTree.excludeDoktypes = 254,1 + .. _useroptions-pageTree-label: -.. index:: Import export; Enable for non admins -.. _useroptions-impexp-enableImportForNonAdminUser: + .. confval:: label. + :name: useroptions-pageTree-label + :type: list of page IDs + :Path: options.pageTree.label. -impexp.enableImportForNonAdminUser -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. versionadded:: 13.1 + This setting is the successor of :ref:`useroptions-pageTree-backgroundColor`. -This option was introduced to avoid `information disclosure -`__. + Labels offer customizable color markings for tree nodes and require an + associated label for accessibility. -.. confval:: impexp.enableImportForNonAdminUser - :name: useroptions-impexp-enableImportForNonAdminUser - :type: boolean - :Default: 0 + Example: - The import/export module of `EXT:impexp` is disabled by default for - non-admin users. Enable this option, if non-admin users need to use the - module and import data. This should only be enabled for trustworthy - backend users, as it might impose a security risk. + .. code-block:: typoscript + :caption: EXT:my_extension/Configuration/user.tsconfig + options.pageTree.label.296 { + label = Campaign A + color = #ff8700 + } -.. index:: Bookmarks; Create and delete disabled -.. _useroptions-mayNotCreateEditBookmarks: + Display: -mayNotCreateEditBookmarks -------------------------- + .. figure:: /Images/ManualScreenshots/List/optionsPageTreeLabel.png + :alt: Page with configured color and label + :class: with-shadow -.. confval:: mayNotCreateEditBookmarks - :name: useroptions-mayNotCreateEditBookmarks - :type: boolean + Page with configured color and label - If set, the user can not create or edit bookmarks. + .. note:: + Only one label per page can be set through this method. Use the + PSR-14 event :ref:`t3coreapi:AfterPageTreeItemsPreparedEvent` to assign + multiple labels to a page. + .. todo:: does this still work with site configuration? + .. _useroptions-pageTree-showDomainNameWithTitle: -.. index:: - Thumbnails; Disable in element browser - Element browser; Disable thumbnails -.. _useroptions-noThumbsInEB: + .. confval:: showDomainNameWithTitle + :name: useroptions-pageTree-showDomainNameWithTitle + :type: boolean + :Path: options.pageTree.showDomainNameWithTitle -noThumbsInEB ------------- + If set, the domain name will be appended to the page title for + pages that have :guilabel:`Is root of web site?` checked in the page properties. + Useful if there are several domains in one page tree. -.. confval:: noThumbsInEB - :name: useroptions-noThumbsInEB - :type: boolean - If set, then image thumbnails are not shown in the element browser. + .. _useroptions-pageTree-showNavTitle: + .. confval:: showNavTitle + :name: useroptions-pageTree-showNavTitle + :type: boolean + :Path: options.pageTree.showNavTitle -.. _useroptions-overridePageModule: + If set, the navigation title is displayed in the page navigation tree + instead of the normal page title. The page title is shown in a + tooltip if the mouse hovers the navigation title. -overridePageModule ------------------- -.. versionchanged:: 13.0 - This setting has been removed. + .. _useroptions-pageTree-showPageIdWithTitle: -Migration -~~~~~~~~~ + .. confval:: showPageIdWithTitle + :name: useroptions-pageTree-showPageIdWithTitle + :type: boolean + :Path: options.pageTree.showPageIdWithTitle -In order to replace the :guilabel:`Web > Page` module within a third-party -extension, such as TemplaVoila, it is possible to create a custom module entry -in an extension's :file:`Configuration/Backend/Modules.php` with the following -entry: + If set, the titles in the page tree will have their ID numbers printed + before the title. -.. code-block:: php - :caption: EXT:my_extension/Configuration/Backend/Modules.php - return [ - 'my_module' => [ - 'parent' => 'web', - 'position' => ['before' => '*'], - 'access' => 'user', - 'aliases' => ['web_layout'], - 'path' => '/module/my_module', - 'iconIdentifier' => 'module-page', - 'labels' => 'LLL:EXT:backend/Resources/Private/Language/locallang_mod.xlf', - 'routes' => [ - '_default' => [ - 'target' => \MyVendor\MyExtension\Controller\MyController::class . '::mainAction', - ], - ], - ], - ]; + .. _useroptions-pageTree-showPathAboveMounts: + .. confval:: showPathAboveMounts + :name: useroptions-pageTree-showPathAboveMounts + :type: boolean + :Path: options.pageTree.showPathAboveMounts -.. index:: Page tree + If set, the user db mount path above the mount itself is shown. + This is useful if you work a lot with user db mounts. -.. _useroptions-pageTree: + .. figure:: /Images/ManualScreenshots/List/PanelUserDB.png + :alt: Active user db mount + :class: with-shadow -pageTree --------- + Active user db mount -.. index:: Page tree; Webmounts replace -.. _useroptions-pageTree-altElementBrowserMountPoints: + .. _useroptions-passwordReset: -pageTree.altElementBrowserMountPoints -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. confval:: passwordReset + :name: useroptions-passwordReset + :type: boolean + :Default: 1 -.. confval:: pageTree.altElementBrowserMountPoints - :name: useroptions-pageTree-altElementBrowserMountPoints - :type: list of integers + If set to `0` the initiating of the password reset in the backend + will be disabled. This does not affect the password reset by + CLI command. - Sets alternative webmounts for use in the element browser. You - separate page IDs by a comma. Non-existing page IDs are ignored. If - you insert a non-integer it will evaluate to "0" (zero) and the root - of the page tree is mounted. Effective in - :ref:`workspaces ` too. + To completely disable the password reset in the backend for all users, you + can set the user TSconfig globally in your :file:`Configuration/user.tsconfig`: - These alternative webmounts **replace** configured DB mount points - unless you use the - :ref:`altElementBrowserMountPoints.append ` - option. + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig - Example: + options.passwordReset = 0 - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + If required, this setting can be overridden on a per user basis + in the corresponding :guilabel:`TSconfig` field of the backend + usergroup or user. - options.pageTree.altElementBrowserMountPoints = 34,123 + The password reset functionality can also be disabled globally by setting: + .. code-block:: php + :caption: config/system/settings.php | typo3conf/system/settings.php -.. index:: Page tree; Webmounts append -.. _useroptions-pageTree-altElementBrowserMountPoints-append: + $GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = false -pageTree.altElementBrowserMountPoints.append -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. _useroptions-saveClipboard: -.. confval:: pageTree.altElementBrowserMountPoints.append - :name: useroptions-pageTree-altElementBrowserMountPoints-append - :type: boolean + .. confval:: saveClipboard + :name: useroptions-saveClipboard + :type: boolean - This option allows administrators to add additional mount points - in the RTE and the wizard element browser instead of replacing - the configured database mount points of the user when using the - existing user TSconfig option. + If set, the clipboard content will be preserved for the next login. + Normally the clipboard content lasts only during the session. - Example: - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + .. _useroptions-saveDocNew: - options.pageTree.altElementBrowserMountPoints = 34,123 - options.pageTree.altElementBrowserMountPoints.append = 1 + .. confval:: saveDocNew + :name: useroptions-saveDocNew + :type: boolean / "top" + :Default: 1 + If set, a button :guilabel:`Save and create new` will appear in TCEFORMs. -.. index:: Page tree; Background colors -.. _useroptions-pageTree-backgroundColor: + Note, it is possible to set this for single tables using + :typoscript:`options.saveDocNew.[tableName]`. + Any value set for a single table will override the default value set for + :typoscript:`saveDocNew`. -pageTree.backgroundColor -~~~~~~~~~~~~~~~~~~~~~~~~ + Example: -.. deprecated:: 13.1 - This setting has been deprecated and will be removed in TYPO3 v14 due to its - lack of accessibility. It is being replaced with a - :ref:`new label system ` for tree nodes. + In this example the button is disabled for all tables, except + :sql:`tt_content` where it will appear, and in addition create the records + in the top of the page (default is after instead of top). - In TYPO3 v13 the setting will be migrated to the new label system. Since the - use case is unknown, the generated label will be "Color: ". This - information will be displayed on all affected nodes. + .. code-block:: typoscript + :caption: EXT:site_package/Configuration/user.tsconfig -.. confval:: pageTree.backgroundColor - :name: useroptions-pageTree-backgroundColor - :type: string + options.saveDocNew = 0 + options.saveDocNew.tt_content = top - Set background colors for tree branches. + .. _useroptions-saveDocView: - The color can be any valid CSS color value. The best results can be achieved - by using RGBa values. + .. confval:: saveDocView + :name: useroptions-saveDocView + :type: boolean + :Default: 1 - Example: + If set, a button :guilabel:`Save and view` will appear in TCEFORMs. - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig + Note, it is possible to set this for single tables using + :typoscript:`options.saveDocView.[tableName]`. + Any value set for a single table will override the default value set for + :typoscript:`saveDocView`. - # The syntax is: - # options.pageTree.backgroundColor. = - options.pageTree.backgroundColor.147 = orange - options.pageTree.backgroundColor.148 = #AFAFAF - options.pageTree.backgroundColor.151 = rgba(0, 255, 0, 0.1) + .. _useroptions-showDuplicate: - .. figure:: /Images/ManualScreenshots/List/optionsPageTreeBackgroundColor.png - :alt: Tree branches with configured background colors - :class: with-shadow + .. confval:: showDuplicate + :name: useroptions-showDuplicate + :type: boolean + :Default: 0 - Tree branches with configured background colors + If set, a button :guilabel:`Duplicate` will appear in TCEFORMs. + Note, that it is possible to set this for single tables using + :typoscript:`options.showDuplicate.[tableName]`. + Any value set for a single table will override the default value set for + :typoscript:`showDuplicate`. -.. index:: Page tree; Doktypes for new pages -.. _useroptions-pageTree-doktypesToShowInNewPageDragArea: -pageTree.doktypesToShowInNewPageDragArea -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + .. _useroptions-showHistory: -.. confval:: pageTree.doktypesToShowInNewPageDragArea - :name: useroptions-pageTree-doktypesToShowInNewPageDragArea - :type: string - :Default: 1,6,4,7,3,254,255,199 + .. confval:: showHistory + :name: useroptions-showHistory + :type: boolean - If set, the node top panel feature can be configured by a comma-separated - list. Each number stands for a :ref:`doktype ID ` - that should be added to the node top panel. + Shows link to the history for the record in TCEFORMs. - .. figure:: /Images/ManualScreenshots/List/PanelNormal.png - :alt: Top panel in normal mode - :class: with-shadow - - Top panel in normal mode - - .. figure:: /Images/ManualScreenshots/List/PanelModified.png - :alt: Top panel modified - :class: with-shadow - - Top panel modified - - -.. index:: Page tree; Exclude doktypes -.. _useroptions-pageTree-excludeDoktypes: - -pageTree.excludeDoktypes -~~~~~~~~~~~~~~~~~~~~~~~~ - -.. confval:: pageTree.excludeDoktypes - :name: useroptions-pageTree-excludeDoktypes - :type: list of integers - - Excludes nodes (pages) with one of the defined - :ref:`doktypes ` from the page tree. - Can be used, for example, for hiding - :ref:`custom doktypes `. - - Example: - - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig - - options.pageTree.excludeDoktypes = 254,1 - - -.. index:: Page tree; Node labels -.. _useroptions-pageTree-label: - -pageTree.label -~~~~~~~~~~~~~~ - -.. versionadded:: 13.1 - This setting is the successor of :ref:`useroptions-pageTree-backgroundColor`. - -.. confval:: pageTree.label. - :name: useroptions-pageTree-label - :type: list of page IDs - - Labels offer customizable color markings for tree nodes and require an - associated label for accessibility. - - Example: - - .. code-block:: typoscript - :caption: EXT:my_extension/Configuration/user.tsconfig - - options.pageTree.label.296 { - label = Campaign A - color = #ff8700 - } - - Display: - - .. figure:: /Images/ManualScreenshots/List/optionsPageTreeLabel.png - :alt: Page with configured color and label - :class: with-shadow - - Page with configured color and label - - .. note:: - Only one label per page can be set through this method. Use the - PSR-14 event :ref:`t3coreapi:AfterPageTreeItemsPreparedEvent` to assign - multiple labels to a page. - -.. todo:: does this still work with site configuration? -.. index:: Page tree; Show domain names -.. _useroptions-pageTree-showDomainNameWithTitle: - -pageTree.showDomainNameWithTitle -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. confval:: pageTree.showDomainNameWithTitle - :name: useroptions-pageTree-showDomainNameWithTitle - :type: boolean - - If set, the domain name will be appended to the page title for - pages that have :guilabel:`Is root of web site?` checked in the page properties. - Useful if there are several domains in one page tree. - - -.. index:: Page tree; Show navigation title -.. _useroptions-pageTree-showNavTitle: - -pageTree.showNavTitle -~~~~~~~~~~~~~~~~~~~~~ - -.. confval:: pageTree.showNavTitle - :name: useroptions-pageTree-showNavTitle - :type: boolean - - If set, the navigation title is displayed in the page navigation tree - instead of the normal page title. The page title is shown in a - tooltip if the mouse hovers the navigation title. - - -.. index:: Page tree; Show page id -.. _useroptions-pageTree-showPageIdWithTitle: - -pageTree.showPageIdWithTitle -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. confval:: pageTree.showPageIdWithTitle - :name: useroptions-pageTree-showPageIdWithTitle - :type: boolean - - If set, the titles in the page tree will have their ID numbers printed - before the title. - - -.. index:: Page tree; Show path above mounts -.. _useroptions-pageTree-showPathAboveMounts: - -pageTree.showPathAboveMounts -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. confval:: pageTree.showPathAboveMounts - :name: useroptions-pageTree-showPathAboveMounts - :type: boolean - - If set, the user db mount path above the mount itself is shown. - This is useful if you work a lot with user db mounts. - - .. figure:: /Images/ManualScreenshots/List/PanelUserDB.png - :alt: Active user db mount - :class: with-shadow - - Active user db mount - - -.. index:: Password; Reset -.. _useroptions-passwordReset: - -passwordReset -------------- - -.. confval:: passwordReset - :name: useroptions-passwordReset - :type: boolean - :Default: 1 - - If set to `0` the initiating of the password reset in the backend - will be disabled. This does not affect the password reset by - CLI command. - - To completely disable the password reset in the backend for all users, you - can set the user TSconfig globally in your :file:`Configuration/user.tsconfig`: - - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig - - options.passwordReset = 0 - - If required, this setting can be overridden on a per user basis - in the corresponding :guilabel:`TSconfig` field of the backend - usergroup or user. - - The password reset functionality can also be disabled globally by setting: - - .. code-block:: php - :caption: config/system/settings.php | typo3conf/system/settings.php - - $GLOBALS['TYPO3_CONF_VARS']['BE']['passwordReset'] = false - - -.. index:: Clipboard; Save for next login -.. _useroptions-saveClipboard: - -saveClipboard -------------- - -.. confval:: saveClipboard - :name: useroptions-saveClipboard - :type: boolean - - If set, the clipboard content will be preserved for the next login. - Normally the clipboard content lasts only during the session. - - -.. index:: Buttons; Save and create new -.. _useroptions-saveDocNew: - -saveDocNew ----------- - -.. confval:: saveDocNew - :name: useroptions-saveDocNew - :type: boolean / "top" - :Default: 1 - - If set, a button :guilabel:`Save and create new` will appear in TCEFORMs. - - Note, it is possible to set this for single tables using - :typoscript:`options.saveDocNew.[tableName]`. - Any value set for a single table will override the default value set for - :typoscript:`saveDocNew`. - - Example: - - In this example the button is disabled for all tables, except - :sql:`tt_content` where it will appear, and in addition create the records - in the top of the page (default is after instead of top). - - .. code-block:: typoscript - :caption: EXT:site_package/Configuration/user.tsconfig - - options.saveDocNew = 0 - options.saveDocNew.tt_content = top - - -.. index:: Buttons; Save and view -.. _useroptions-saveDocView: - -saveDocView ------------ - -.. confval:: saveDocView - :name: useroptions-saveDocView - :type: boolean - :Default: 1 - - If set, a button :guilabel:`Save and view` will appear in TCEFORMs. - - Note, it is possible to set this for single tables using - :typoscript:`options.saveDocView.[tableName]`. - Any value set for a single table will override the default value set for - :typoscript:`saveDocView`. - - -.. index:: Buttons; Duplicate record -.. _useroptions-showDuplicate: - -showDuplicate -------------- - -.. confval:: showDuplicate - :name: useroptions-showDuplicate - :type: boolean - :Default: 0 - - If set, a button :guilabel:`Duplicate` will appear in TCEFORMs. - - Note, that it is possible to set this for single tables using - :typoscript:`options.showDuplicate.[tableName]`. - Any value set for a single table will override the default value set for - :typoscript:`showDuplicate`. - - -.. index:: Buttons; History of record -.. _useroptions-showHistory: - -showHistory ------------ - -.. confval:: showHistory - :name: useroptions-showHistory - :type: boolean - - Shows link to the history for the record in TCEFORMs. - - Note, it is possible to set this for single tables using - :typoscript:`options.showHistory.[tableName]`. - Any value set for a single table will override the default value set for - :typoscript:`showHistory`. + Note, it is possible to set this for single tables using + :typoscript:`options.showHistory.[tableName]`. + Any value set for a single table will override the default value set for + :typoscript:`showHistory`.