DAM
1.5.8. TSconfig
Configuration of the DAM and it's module are provided through TSconfig. For User and Page TSconfig the same properties are available for configuration. Please keep in mind Page TSconfig will be read from the DAM SysFolder only.
Configuration is placed in
mod.
txdamM1_*
... module configurationtx_dam. ... general DAM configuration
Disable submodules
Submodules can be disabled for a user (or globally) with following TSconfig:
mod.txdamM1_list.menu.function.tx_dam_list_list = 0
mod.txdamM1_list.menu.function.tx_dam_list_thumbs = 0
mod.txdamM1_list.menu.function.tx_dam_list_editsel = 0
mod.txdamM1_list.menu.function.tx_dam_list_batch = 0
mod.txdamM1_file.menu.function.tx_dam_file_list = 0
mod.txdamM1_file.menu.function.tx_dam_file_upload = 0
mod.txdamM1_file.menu.function.tx_damindex_index = 0
mod.txdamM1_index.menu.function.tx_damindex_index = 0
mod.txdamM1_info.menu.function.tx_daminfo_reference = 0
mod.txdamM1_tools.menu.function.tx_dam_tools_indexupdate = 0
mod.txdamM1_tools.menu.function.tx_dam_tools_filerelcheck = 0
mod.txdamM1_tools.menu.function.tx_damcron_modfunc1 = 0
Set Media SysFolder invisible
Media records in the Media SysFolder are not meant to be edited with another module than the DAM. While the SysFolder is visible to users, one can edit records with the Web>List module. With the following User TSconfig option the Media SysFolder (example page id: 23) can be made invisible. Which means
options.hideRecords.pages = 23
Module configuration (mod.txdamM1_*.)
Property: | Data type: | Description: | Default: |
|---|---|---|---|
txdamM1_list.menu.function |
| Blinding Function Menu options in Backend Modules: The DAM modules are technically implemented as "function menu" which makes it possible to deactivate single submodules for a specific user/group.
Example: Removing the Media>List>List module looks like this mod.txdamM1_list.menu.function.tx_dam_list_list = 0
Known submodule keys: tx_dam_list_list tx_dam_list_thumbs tx_dam_list_batch |
|
txdamM1_file.menu.function |
| Known submodule keys: tx_dam_file_list tx_dam_file_upload tx_damindex_index |
|
txdamM1_index.menu.function |
| Known submodule keys: tx_damindex_index |
|
txdamM1_info.menu.function |
| Known submodule keys: tx_daminfo_reference |
|
txdamM1_tools.menu.function |
| Known submodule keys: tx_dam_tools_indexupdate tx_dam_tools_filerelcheck tx_damcron_modfunc1 |
|
[page:mod; beuser:mod]
Module configuration (mod.txdamM1_SHARED.)
TSconfig properties from submodules could be defined in shared setup mod.txdamM1_SHARED. Properties listed here can be configured in the submodules setup too, which will not affect the other modules setup. Not all properties are supported/used by every submodule.
Property: | Data type: | Description: | Default: |
|---|---|---|---|
alternateBgColors | boolean | If set, the background colors of list rows will alternate.
Examples: mod.txdamM1_list.modfunc.tx_dam_list_list.alternateBgColors = 0 mod.txdamM1_list.alternateBgColors = 0 mod.txdamM1_SHARED.alternateBgColors = 0 | true |
browserMaxPages | integer | Defines how many pages the result browser should display at maximum. | 20 |
filesDisplayDotFiles | boolean | If set files beginning with a dot '.' will be displayed in file listings (file module for example). | false (true for admins) |
filesDisplayExcludeByRegex | comma list | This comma list define which files should not be displayed in file lists. The items are regular expression (preg)
Example: Will hide any xml files and file beginning with _ mod.txdamM1_SHARED.displayExcludeByRegex = \.xml$,^_ |
|
contextMenuOnListItems | boolean | Context menus available on item icons in listings can be disabled with this property.
Example: Will disable context menus in file module mod.txdamM1_file.contextMenuOnListItems = 0 | true |
guiElements | array of element keys | GUI elements can be removed from the the modules with this properties
Example: Will disable the search box in the list module mod.txdamM1_list.guiElements.getSearchBox = 0
The gui element item keys are available at the bottom of the modules itself inside the box 'Module Info'. The box will be displayed when the 'devel' option is enabled for the dam extension in the extension manager. |
|
options | boolean | Options often displayed as checkbox in the footer of submodules can be deactivated with this property.
Example: Will hide the option 'Display batch edit option' mod.txdamM1_SHARED.options.tx_dam_list_list_showMultiActions = 0
The options item keys are available at the bottom of the modules itself inside the box 'Module Info'. The box will be displayed when the 'devel' option is enabled for the dam extension in the extension manager. |
|
options.[key].value | mixed | With the options property above an option can be hidden but this does not affect the options value. That have to be set separately with the value property.
Example: Will hide the option 'Display thumbnails' in list module but enable the option itself mod.txdamM1_SHARED.options.tx_dam_list_list_showThumb = 0 mod.txdamM1_SHARED.options.tx_dam_list_list_showThumb.value = 1 |
|
actions.shared | array of element keys | Actions are displayed as icons or buttons in list modules
Example: Will hide the options to edit the record and preview the file in list module mod.txdamM1_SHARED.actions.shared {
tx_dam_action_viewFileRec = 0 tx_dam_action_editRec = 0 } The action item keys are available at the bottom of the modules itself inside the box 'Module Info'. The box will be displayed when the 'devel' option is enabled for the dam extension in the extension manager.
Hint: Actions can be removed from the context menu by the standard option. options.contextMenu.pageList.disableItems = tx_dam_action_editRecPopup |
|
actions.[action type] | array of element keys | See above for details
action type can be icon – icon which be displayed somewhere button – button which be displayed somewhere control – icon in list module globalcontrol – icon on top of list context – context menu multi – multi action like 'move files'
Example: Will hide the options to edit the record and preview the file in context menu only mod.txdamM1_SHARED.actions.context {
tx_dam_action_viewFileRec = 0 tx_dam_action_editRec = 0 } |
|
actions.allowDeny |
| Experimental configuration in Apache like allow/deny style. Will be used instead of the 'actions' setup if defined. It will be walked through the rules until a rule matches for deny.
Order types: allow,deny – first test allow rules, then deny. allow must match to enable the item. deny,allow – first test deny rules, then allow. allow must match to enable the item when deny matches. explicit – allow must match and deny must not.
allow and deny can be arrays too. The setup in such an array allow matching of user, usergroups, IP's, hosts, admin.
from – IP or hostname/domain. 'all' matches all. user – comma list of user ID's. '*' matches all. user – comma list of usergroup ID's. '*' matches all. admin – 0/1. Test if user is admin or not. item – comma list of items the rule shoul apply for. '*' matches all.
Example: mod.txdamM1_SHARED.actions.shared.allowDeny {
order = deny,allow allow = tx_dam_action_viewFileRec deny = tx_dam_action_editRec deny.anyNameCanBeUsedHere {
from = 192.168.*.*,127.0.0.1,10.0.*.* item = * } } This will disable all actions when the user is from the IP range configured in 'from'. The action 'tx_dam_action_editRec' is always disabled and the action 'tx_dam_action_viewFileRec' is always enabled. |
|
[page:mod.txdamM1_SHARED; beuser:mod.txdamM1_SHARED]
DAM configuration (tx_dam.)
Property: | Data type: | Description: | Default: |
|---|---|---|---|
selections.default.modeSelIcons |
| Selections The selection trees can be configured as follows: // not disable +=- icons by default tx_dam.selections.default.modeSelIcons = 1 |
|
selections.[key].hidden | boolean | Hides a selection tree from the browse trees in backend. |
|
selections.[key].modeSelIcons |
|
// disable txdamIndexRun selection tree (hidden) tx_dam.selections.txdamIndexRun = 0 // disable +=- icons for txdamStatus selection tree tx_dam.selections.txdamStatus.modeSelIcons = 0 |
|
selections.txdamCat.sublevelDepth | integer | limit category selection depth to 0 (non-recursive) tx_dam.selections.txdamCat.sublevelDepth = 0 |
|
indexing.auto | boolean | Enable/Disable auto indexing
Example: // disable auto indexing tx_dam.indexing.auto = 0 | true |
indexing.autoMaxInteractive | integer | Defines how many files should be auto indexed at once when a user is in an interactive session like using the file module. This is to prevent a timeout when too many files needs to be indexed. | 5 |
indexing.skipFileTypes | comma list | Comma list of file extensions that should be skipped while indexing. |
|
indexing.useInternalMediaTypeList | boolean | If set the internal conversion table from mime types to media types will be used. This will make from the mime type application/pdf a media type text, for example. See section 'Mime Types and Media Types' for details. | true |
indexing.useInternalMimeList | boolean | If set the internal conversion table from file extensions to mime types will be used. In principle a server should provide such a functionality, but this is not always available. By default this method is used to detect a mime type. See section 'Mime Types and Media Types' for details. | true |
indexing.useMimeContentType | boolean | If set the PHP function MimeContentType() is used to detect mime types. The function is not always available. See section 'Mime Types and Media Types' for details. | true |
indexing.useFileCommand | boolean | If set the external 'file' command is used to detect mime types. The command is not always available. See section 'Mime Types and Media Types' for details. | true |
indexing.replaceFile.reindexingMode | integer | Make default reindexing mode when replacing the file configurable.
Available modes: 1 - Only get meta data which is still missing. 2 - Overwrite current meta data with data from file. Will overwrite the meta data but preserve those where's no data available from the file itself. 99 - Overwrite all current meta data with data from file. | 2 |
indexing.editFile.reindexingMode | integer | Same as above for edit file. | 1 |
indexing.defaultSetup | string | This indexing setup will be used when no other setup will be found stored in the file path. Such a setup can be created with the module Media>Tools>Indexing Setup.
Excerpt: <phparray> <pid>0</pid> <pathlist type="array"> <numIndex index="0">fileadmin/</numIndex> </pathlist> <recursive>0</recursive> <ruleConf type="array"> <tx_damdemo_indexRule type="array"> <enabled>0</enabled> <option1>0</option1> </tx_damdemo_indexRule> |
|
devel |
| Enables development and debug output in modules |
|
[page:tx_dam; beuser:tx_dam]