.. include:: /Includes.rst.txt .. _useroptions: ======= options ======= Various options for the user affecting the core at various points. As an example, this enables the "Flush frontend caches" button in the upper right toolbar cache menu for non admin users: .. code-block:: typoscript options.clearCache.pages = 1 .. _useroptions-additionalPreviewLanguages: additionalPreviewLanguages ========================== :aspect:`Datatype` list of sys_language ids :aspect:`Description` The user will see these additional languages when localizing stuff in TCEforms. The list are uid numbers of sys_language records. .. _useroptions-alertPopups: alertPopups =========== :aspect:`Datatype` bitmask :aspect:`Description` 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) :aspect:`Default` 255 (show all warnings) .. _useroptions-bookmarkGroups: bookmarkGroups ============== :aspect:`Datatype` Array of integers/ strings :aspect:`Description` Set groups of bookmarks that can be accessed by the user. This affects the bookmarks toolbar item in the top right of the backend. By default, 5 default groups will be defined globally (shared, can only be set by admins) and also for each user (personal bookmarks): 1. Pages 2. Records 3. Files 4. Tools 5. Miscellaneous Set 0 to disable one of these group IDs, 1 to enable it (this is the default) or "string" to change the label accordingly. :aspect:`Example` .. code-block:: typoscript bookmarkGroups { 1 = 1 2 = My Group 3 = 0 4 = } 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. .. _useroptions-clearCache-all: clearCache.all ============== :aspect:`Datatype` boolean :aspect:`Description` 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. :aspect:`Default` 0 .. _useroptions-clearCache-pages: clearCache.pages ================ :aspect:`Datatype` boolean :aspect:`Description` If set to 1, this will allow a non-admin user to clear frontend and page-related caches. :aspect:`Default` 0 .. _useroptions-clipboardNumberPads: clipboardNumberPads =================== :aspect:`Datatype` integer (0-20) :aspect:`Description` This allows you to enter how many pads you want on the clipboard. :aspect:`Default` 3 .. _useroptions-contextMenu-key-disableItems: contextMenu disableItems ======================== :aspect:`Datatype` list of items :aspect:`Description` List of context menu ("clickmenu") items to disable. The full path of this property is: `contextMenu.table.[tableName][.context].disableItems` The "[tableName]" refers to the type of the record (database table name) the context menu is shown for e.g. "pages", "sys_file", "tt_content", etc. Optional key "[.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. Items to disable for "page" type are: `view`, `edit`, `new`, `info`, `copy`, `copyRelease`, `cut`, `cutRelease`, `pasteAfter`, `pasteInto`, `newWizard`, `openListModule`, `mountAsTreeRoot`, `enable`, `disable`, `delete`, `history`, `clearCache` Items to disable for "sys_file" type (that is files/folders) are: `edit`, `rename`, `upload`, `new`, `info`, `copy`, `copyRelease`, `cut`, `cutRelease`, `pasteInto`, `delete` When the system extension Import/Export (impexp) is installed then two more options become available: `exportT3d` and `importT3d` .. note:: Context menu rendering was refactored in v8.6, so when migrating from v7 some of the settings need to be tuned. See chapter in the :ref:`TYPO3 API documentation ` regarding new context menu implementation. :aspect:`Example` .. code-block:: typoscript options.contextMenu.table.pages.disableItems = new,newWizard options.contextMenu.table.pages.tree.disableItems = new,newWizard # This will remove the "more" item in the Pagetree context menu and all its subelements: options.contextMenu.table.pages.tree.disableItems = newWizard, openListModule, mountAsTreeRoot, exportT3d, importT3d .. _useroptions-createFoldersInEB: createFoldersInEB ================= :aspect:`Datatype` boolean :aspect:`Description` If set, a createFolders option appears in the element browser (for admin-users this is always enabled). .. _useroptions-defaultUploadFolder: defaultUploadFolder =================== :aspect:`Datatype` string :aspect:`Description` 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`. With this property it is possible to set a specific upload folder. The syntax is "storage_uid:file_path". :aspect:`Example` .. code-block:: typoscript options.defaultUploadFolder = 2:user_folders/my_folder/ .. _useroptions-disableDelete: disableDelete ============= :aspect:`Datatype` boolean :aspect:`Description` Disables the "Delete" button in TCEFORMs. Note it is possible to set this for single tables using `options.disableDelete.[tableName]`. Any value set for a single table will override the default value set for "disableDelete". .. _useroptions-dontMountAdminMounts: dontMountAdminMounts ==================== :aspect:`Datatype` boolean :aspect:`Description` This options prevents the root to be mounted for an admin user. .. note:: Only for admin-users. For other users it has no effect. .. _useroptions-enableBookmarks: enableBookmarks =============== :aspect:`Datatype` boolean :aspect:`Description` Enables the usage of bookmarks in the backend. :aspect:`Default` 1 feedit ====== .. _useroptions-feedit-popupHeight: feedit.popupHeight ------------------ :aspect:`Datatype` integer :aspect:`Description` Sets the height of the popup window of feedit. :aspect:`Example` .. code-block:: typoscript options.feedit.popupHeight = 700 .. _useroptions-feedit-popupWidth: feedit.popupWidth ----------------- :aspect:`Datatype` integer :aspect:`Description` Sets the width of the popup window of feedit. :aspect:`Example` .. code-block:: typoscript options.feedit.popupWidth = 700 file_list ========= .. _useroptions-file_list-enableClipBoard: file\_list.enableClipBoard -------------------------- :aspect:`Datatype` list of keywords :aspect:`Description` Determines whether the checkbox "Show clipboard" in the filelist 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: - activated: The option is activated and the checkbox is hidden. - 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. :aspect:`Default` selectable .. _useroptions-file_list-enableDisplayBigControlPanel: file_list.enableDisplayBigControlPanel -------------------------------------- :aspect:`Datatype` *(list of keywords)* :aspect:`Description` Determines whether the checkbox "Extended view" in the filelist module is shown or hidden. If it is hidden, you can predefine it to be always activated or always deactivated. .. figure:: ../Images/UserTsFileListExtendedView.png :alt: Checkbox "Extended view" in the filelist module The following values are possible: - activated: The option is activated and the checkbox is hidden. - 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. :aspect:`Default` selectable .. _useroptions-file_list-enableDisplayThumbnails: file_list.enableDisplayThumbnails --------------------------------- :aspect:`Datatype` list of keywords :aspect:`Description` Determines whether the checkbox "Display thumbnails" in the filelist 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: - activated: The option is activated and the checkbox is hidden. - 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. :aspect:`Default` selectable .. _useroptions-file_list-filesPerPage: file_list.filesPerPage ---------------------- :aspect:`Datatype` integer :aspect:`Description` The maximum number of files shown per page in File > List :aspect:`Default` 40 .. _useroptions-file_list-thumbnail-height: file_list.thumbnail.height -------------------------- :aspect:`Datatype` integer :aspect:`Description` All preview images in the file list will be rendered with the configured thumbnail height. :aspect:`Default` 64 .. _useroptions-file_list-thumbnail-width: file_list.thumbnail.width ------------------------- :aspect:`Datatype` integer :aspect:`Description` All preview images in the file list will be rendered with the configured thumbnail width. :aspect:`Default` 64 folderTree ========== .. _useroptions-folderTree-altElementBrowserMountPoints: folderTree.altElementBrowserMountPoints --------------------------------------- :aspect:`Datatype` list of "storageUid:folderName" items :aspect:`Description` Sets alternative filemounts for use in the File List and in Element Browser. Each item consists of storage Uid followed by a colon and the folder name inside that storage. You separate multiple items by a comma. For backwards compatibility, defining only a folder name but without a storage Uid and colon prepended is still supported as well. Folders without a storage Uid prepended are assumed to be located in the default storage, which by default is the fileadmin/ folder. If a folder you specify does not exist it will not get mounted. Effective in workspaces too. The alternative filemounts are added to the existing filemounts. :aspect:`Example` .. code-block:: typoscript options.folderTree.altElementBrowserMountPoints = _temp_/, 2:/templates, 1:/files/images .. _useroptions-folderTree-hideCreateFolder: folderTree.hideCreateFolder --------------------------- :aspect:`Datatype` boolean :aspect:`Description` If set, the user can't create new folders. :aspect:`Default` false .. _useroptions-folderTree-uploadFieldsInLinkBrowser: folderTree.uploadFieldsInLinkBrowser ------------------------------------ :aspect:`Datatype` integer :aspect:`Description` 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. :aspect:`Default` 3 .. _useroptions-hideModules: hideModules.[moduleGroup] ========================= :aspect:`Datatype` list of module groups or modules :aspect:`Description` Configure which module groups or modules should be hidden from the main menu. It is not an access restriction but makes defined modules invisible. That means in principle those modules can still be accessed if the rights allow. A list of all available module groups and modules can be found in in the backend module *SYSTEM -> Configuration -> $GLOBALS['TBE_MODULES'] (BE Modules)* :aspect:`Example` .. code-block:: typoscript # Hide module groups "file" and "help" options.hideModules = file, help # Hide module "func" and "info" from the "web" group options.hideModules.web := addToList(func,info) # Hide module BELogLog from "system" group options.hideModules.system = BelogLog .. _useroptions-hideRecords-pages: hideRecords.pages ================= :aspect:`Datatype` list of page ids :aspect:`Description` This 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. This option is currently implemented for the pages table only and has an effect in the following places: - Page tree navigation frame - Web > List module - New record wizard :aspect:`Example` .. code-block:: typoscript options.hideRecords.pages = 12,45 .. _useroptions-impexp-enableImportForNonAdminUser: impexp.enableImportForNonAdminUser ================================== :aspect:`Datatype` boolean :aspect:`Description` The import/export module of `EXT:impext` is disabled by default for non-admin users. Enable this option, if non-admin users need to use the module. This should only be enabled for trustworthy backend users, as it might impose a security risk. :aspect:`Default` 0 .. _useroptions-lockToIP: lockToIP ======== :aspect:`Datatype` string :aspect:`Description` Comma separated list of IP-numbers with wildcards. .. note:: This option is only enabled if the :php:`$GLOBALS['TYPO3_CONF_VARS']['BE']['enabledBeUserIPLock']` configuration is true. :aspect:`Example` .. code-block:: typoscript # Allow all from 192.168-network options.lockToIP = 192.168.*.* # Allow all from 192.168-network plus all from REMOTE_ADDR 212.22.33.44 options.lockToIP = 192.168.\*.\*, 212.22.33.44 # Same as the previous. Leaving out parts of the IP address is the same as wild cards. options.lockToIP = 192.168, 212.22.33.44 .. _useroptions-mayNotCreateEditBookmarks: mayNotCreateEditBookmarks ========================= :aspect:`Datatype` boolean :aspect:`Description` If set, the user can not create or edit bookmarks. .. _useroptions-noThumbsInEB: noThumbsInEB ============ :aspect:`Datatype` boolean :aspect:`Description` If set, then image thumbnails are not shown in the element browser. .. _useroptions-overridePageModule: overridePageModule ================== :aspect:`Datatype` string :aspect:`Description` By this value you can substitute the default "Web > Page" module key ("web\_layout") with another backend module key. .. note:: This property has been introduced for TemplaVoila in the old days. It is of little use nowadays and can be achieved using :ref:`hideModules `, too. :aspect:`Example` .. code-block:: typoscript # Enable TemplaVoila page module as default page module. options.overridePageModule = web_txtemplavoilaM1 pageTree ======== .. _useroptions-pageTree-altElementBrowserMountPoints: pageTree.altElementBrowserMountPoints ------------------------------------- :aspect:`Datatype` list of integers :aspect:`Description` 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 workspaces too. These alternative webmounts **replace** configured DB mount points unless you use the ``altElementBrowserMountPoints.append`` option described below. **Example** .. code-block:: typoscript options.pageTree.altElementBrowserMountPoints = 34,123 .. _useroptions-pageTree-altElementBrowserMountPoints-append: pageTree.altElementBrowserMountPoints.append -------------------------------------------- :aspect:`Datatype` boolean :aspect:`Description` 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 UserTSconfig option. :aspect:`Example` .. code-block:: typoscript options.pageTree.altElementBrowserMountPoints = 34,123 options.pageTree.altElementBrowserMountPoints.append = 1 .. _useroptions-pageTree-backgroundColor: pageTree.backgroundColor ------------------------ :aspect:`Datatype` string :aspect:`Description` Set background colors for tree branches. Color can be any valid CSS color value. The best results can be achieved by using rgba values. The syntax is: options.pageTree.backgroundColor. = :aspect:`Example` .. code-block:: typoscript options.pageTree.backgroundColor.147 = orange options.pageTree.backgroundColor.148 = #AFAFAF options.pageTree.backgroundColor.151 = rgba(0, 255, 0, 0.1) .. figure:: ../Images/optionsPageTreeBackgroundColor.png :alt: Tree branches with configured background colors Tree branches with configured background colors .. _useroptions-pageTree-doktypesToShowInNewPageDragArea: pageTree.doktypesToShowInNewPageDragArea ---------------------------------------- :aspect:`Datatype` string :aspect:`Description` If set, the node top panel feature can be configured by a comma-separated list. Each number stands for a doctype id that should be added to the node top panel. .. figure:: ../Images/PanelNormal.png :alt: Top panel in normal mode .. figure:: ../Images/PanelModified.png :alt: Top panel modified :aspect:`Default` 1,6,4,7,3,254,255,199 .. index:: Page tree; Exclude doktypes .. _useroptions-pageTree-excludeDoktypes: pageTree.excludeDoktypes ------------------------ :aspect:`Datatype` list of integers :aspect:`Description` Excludes nodes (pages) with one of the defined doktypes from the pagetree. Can be used for example for hiding custom doktypes. :aspect:`Example` .. code-block:: typoscript options.pageTree.excludeDoktypes = 254,1 .. _useroptions-pageTree-showDomainNameWithTitle: pageTree.showDomainNameWithTitle -------------------------------- :aspect:`Datatype` boolean :aspect:`Description` If set, the domain name will be appended to the page title for pages that have "Is root of web site?" checked in the page properties. Useful if there are several domains in one page tree. .. _useroptions-pageTree-showNavTitle: pageTree.showNavTitle --------------------- :aspect:`Datatype` boolean :aspect:`Description` If set, the navigation title is displayed in the page navigation tree instead of the normal page title. The page title is showed in a tooltip if the mouse hovers the navigation title. .. _useroptions-pageTree-showPageIdWithTitle: pageTree.showPageIdWithTitle ---------------------------- :aspect:`Datatype` boolean :aspect:`Description` If set, the titles in the page tree will have their ID numbers printed before the title. .. _useroptions-pageTree-showPathAboveMounts: pageTree.showPathAboveMounts ---------------------------- :aspect:`Datatype` boolean :aspect:`Description` 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/PanelUserDB.png :alt: Active user db mount .. _useroptions-popupWindowSize: popupWindowSize =============== :aspect:`Datatype` string :aspect:`Description` Defines the size of the element browser. .. note:: This property is outdated. .. _useroptions-saveClipboard: saveClipboard ============= :aspect:`Datatype` boolean :aspect:`Description` If set, the clipboard content will be preserved for the next login. Normally the clipboard content lasts only during the session. .. _useroptions-saveDocNew: saveDocNew ========== :aspect:`Datatype` boolean / "top" :aspect:`Description` If set, a button "Save and create new" will appear in TCEFORMs. Note it is possible to set this for single tables using `options.saveDocNew.[tableName]`. Any value set for a single table will override the default value set for "saveDocNew". :aspect:`Default` 1 :aspect:`Example` In this example the button is disabled for all tables, except 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 options.saveDocNew = 0 options.saveDocNew.tt_content = top .. _useroptions-saveDocView: saveDocView =========== :aspect:`Datatype` boolean :aspect:`Description` If set, a button "Save and view" will appear in TCEFORMs. Note it is possible to set this for single tables using `options.saveDocView.[tableName]`. Any value set for a single table will override the default value set for "saveDocView". :aspect:`Default` 1 .. _useroptions-showDuplicate: showDuplicate ============= :aspect:`Datatype` boolean :aspect:`Description` If set, a button "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:`saveDocView`. :aspect:`Default` 0 .. _useroptions-showHistory: showHistory =========== :aspect:`Datatype` boolean :aspect:`Description` Shows link to the history for the record in TCEFORMs. Note it is possible to set this for single tables using `options.showHistory.[tableName]`. Any value set for a single table will override the default value set for "showHistory". .. _useroptions-view-languageOrder: view.languageOrder ================== :aspect:`Datatype` list of sys_language ids :aspect:`Description` When a backend user clicks a view-page link in the backend (magnifying glass) the first language uid in this list which the user has access to edit will be added as the language parameter to the view-link. This is a useful setting for translators which primarily wish to see their translation when they click the view-links. :aspect:`Example` .. code-block:: typoscript options.view.languageOrder = 2,1