.. ================================================== .. FOR YOUR INFORMATION .. -------------------------------------------------- .. -*- coding: utf-8 -*- with BOM. .. include:: ../../Includes.txt .. _configuration-plugin: Plugin Configuration ==================== Target group: **Editors**, **Developers** Most configuration settings can be set through the flexform settings. As not every configuration is needed for every view, the not needed are hidden. Every setting can also be set by using :ref:`TypoScript `. .. important:: The settings of the plugin always override the ones from TypoScript. .. todo: add docu for plugin configuration and screenshots .. contents:: :local: :depth: 1 .. _flexforms.mediagallery.tabs.general: Tab "General" ------------- .. figure:: ../../Images/Configuration/Plugin/flexforms_mediagallery_tabs_general_nested.png :width: 716px :alt: Tab "General" of plugin in display mode "Selected albums (nested)" **Image 1:** Tab "General" of plugin in display mode "Selected albums (nested)" =================== ================= ================================================================================================== =================== Field Display Modes Description TSref =================== ================= ================================================================================================== =================== Display mode all .. _flexforms.mediagallery.tabs.general.displayMode: none Sets the display mode of the Plugin. * Selected albums (nested) = ``nestedList`` * Albums list (flattened) = ``flatList`` * Single album (URL handover enabled) = ``showAlbumByParam`` * Single album (URL handover disabled) = ``showAlbumByConfig`` * Random media asset = ``randomAsset`` You enable/disable these items via the plugin configuration in the :ref:`Extension Manager ` Media Albums nestedList, .. _flexforms.mediagallery.tabs.general.mediaAlbums: :ref:`settings.mediaAlbumsUids ` randomAsset Album selection for ``nestedList`` and ``randomAsset`` views. .. important:: If you want to display a nested album you have to select all of its parent albums. Album selection nestedList, .. _flexforms.mediagallery.tabs.general.useAlbumFilterAsExclude: :ref:`settings.useAlbumFilterAsExclude ` filter randomAsset Include or exclude selected album items Sort albums list by nestedList, .. _flexforms.mediagallery.tabs.general.list.orderBy: :ref:`settings.list.orderBy ` flatList Defines how albums in list views are ordered. Sort direction nestedList, .. _flexforms.mediagallery.tabs.general.list.orderDirection: :ref:`settings.list.orderDirection ` for albums list flatList Defines the sort direction (ascending/descending) for albums list in list views. Startingpoint all .. _flexforms.mediagallery.tabs.general.startingpoint: :ref:`presistence.storagePid ` The "Storage Folder" which holds the album records. Recursive all .. _flexforms.mediagallery.tabs.general.recursive: :ref:`presistence.recursive ` Recursion level of the :ref:`Startingpoint `. =================== ================= ================================================================================================== =================== .. _flexforms.mediagallery.tabs.list: Tab "Albums list" ----------------- .. figure:: ../../Images/Configuration/Plugin/flexforms_mediagallery_tabs_list.png :width: 716px :alt: Tab "Album list" of plugin" **Image 2:** Tab "Album list" of plugin" ================================== ====================== ================================================================================================== =================== Field Display Modes Description TSref ================================== ====================== ================================================================================================== =================== Max. thumbs to display per page nestedList, flatList .. _flexforms.mediagallery.tabs.list.itemsPerPage: :ref:`settings.list.pagination.itemsPerPage ` Define how many items are shown on one page. Thumb width nestedList, flatList .. _flexforms.mediagallery.tabs.list.thumb.width: :ref:`settings.list.thumb.width ` Height of thumbnail images. Thumb height nestedList, flatList .. _flexforms.mediagallery.tabs.list.thumb.height: :ref:`settings.list.thumb.height ` Width of thumbnail images. Random thumbnail nestedList, flatList .. _flexforms.mediagallery.tabs.list.thumb.random: :ref:`settings.list.thumb.resizeMode ` Defines if a random thumbnail or the first found should be used. Resize mode nestedList, flatList .. _flexforms.mediagallery.tabs.list.thumb.resizeMode: :ref:`settings.list.thumb.resizeMode ` Defines how thumbnails in list view are scaled. Hide empty albums nestedList, flatList .. _flexforms.mediagallery.tabs.list.hideEmptyAlbums: :ref:`settings.list.hideEmptyAlbums ` Option to exclude albums without media assets from list views. ================================== ====================== ================================================================================================== =================== .. _flexforms.mediagallery.tabs.album: Tab "Album view" ---------------- .. figure:: ../../Images/Configuration/Plugin/flexforms_mediagallery_tabs_album.png :width: 716px :alt: Tab "Album view" of plugin" **Image 3:** Tab "Album view" of plugin" ================================== ====================== ================================================================================================== =================== Field Display Modes Description TSref ================================== ====================== ================================================================================================== =================== Sort media/files by nestedList, flatList, .. _flexforms.mediagallery.tabs.album.assets.orderBy: :ref:`settings.album.assets.orderBy ` showAlbumByParam, showAlbumByConfig Defines the sorting of the media/fiels shown in a album. Sort direction for media/files nestedList, flatList, .. _flexforms.mediagallery.tabs.album.assets.orderDirection: :ref:`settings.album.assets.orderDirection ` showAlbumByParam, showAlbumByConfig Defines the sort direction (ascending/descending) of the media/files. Max. thumbs to display per page nestedList, flatList, .. _flexforms.mediagallery.tabs.album.itemsPerPage: :ref:`settings.album.pagination.itemsPerPage ` showAlbumByParam, showAlbumByConfig Defines how many items are shown on one album page. Thumb width nestedList, flatList, .. _flexforms.mediagallery.tabs.album.thumb.width: :ref:`settings.album.thumb.width ` showAlbumByParam, showAlbumByConfig Height of thumbnail images in album view. Thumb height nestedList, flatList, .. _flexforms.mediagallery.tabs.album.thumb.height: :ref:`settings.album.thumb.height ` showAlbumByParam, showAlbumByConfig Width of thumbnail images in album view. Resize mode nestedList, flatList, .. _flexforms.mediagallery.tabs.album.thumb.resizeMode: :ref:`settings.album.thumb.resizeMode ` showAlbumByParam, showAlbumByConfig Defines how thumbnails in album view are scaled. Use LightBox/Colorbox instead nestedList, flatList, .. _flexforms.mediagallery.tabs.album.lightbox.enable: :ref:`settings.album.lightbox.enable ` of detail view showAlbumByParam, showAlbumByConfig Option to do not link to detail view from album list but display media assets using a lightbox/colorbox. Display title nestedList, flatList, .. _flexforms.mediagallery.tabs.album.displayTitle: :ref:`settings.album.displayTitle ` showAlbumByParam, showAlbumByConfig Option to hide albums title. ================================== ====================== ================================================================================================== =================== .. _flexforms.mediagallery.tabs.detail: Tab "Detail view" ----------------- .. figure:: ../../Images/Configuration/Plugin/flexforms_mediagallery_tabs_detail.png :width: 716px :alt: Tab "Detail view" of plugin" **Image 4:** Tab "Detail view" of plugin" ================================== ====================== ================================================================================================== =================== Field Display Modes Description TSref ================================== ====================== ================================================================================================== =================== Media width nestedList, flatList, .. _flexforms.mediagallery.tabs.detail.asset.width: :ref:`settings.detail.asset.width ` showAlbumByParam, showAlbumByConfig Height of media asset in detail view. Media height nestedList, flatList, .. _flexforms.mediagallery.tabs.detail.asset.height: :ref:`settings.detail.asset.height ` showAlbumByParam, showAlbumByConfig Width of media asset in detail view. Resize mode nestedList, flatList, .. _flexforms.mediagallery.tabs.detail.asset.resizeMode: :ref:`settings.detail.asset.resizeMode ` showAlbumByParam, showAlbumByConfig Defines how media assets in detail view are scaled. ================================== ====================== ================================================================================================== =================== .. _flexforms.mediagallery.tabs.random: Tab "Random asset" ------------------ .. figure:: ../../Images/Configuration/Plugin/flexforms_mediagallery_tabs_random.png :width: 716px :alt: Tab "Random view" of plugin" **Image 5:** Tab "Random view" of plugin" ================================== ====================== ================================================================================================== =================== Field Display Modes Description TSref ================================== ====================== ================================================================================================== =================== Album page randomAsset .. _flexforms.mediagallery.tabs.random.targetPid: :ref:`settings.random.targetPid ` Target page a random assets should link to. Select a page on which a plugin is configured to display the full album (:ref:`Display Mode ` = ``showAlbumByParam``, ``nestedList`` or ``flatList``). Thumbnail width randomAsset .. _flexforms.mediagallery.tabs.random.thumb.width: :ref:`settings.random.thumb.width ` Height of thumbnail images of random media assets. Thumbnail height randomAsset .. _flexforms.mediagallery.tabs.random.thumb.height: :ref:`settings.random.thumb.height ` Width of thumbnail images of random media assets. Resize mode randomAsset .. _flexforms.mediagallery.tabs.random.thumb.resizeMode: :ref:`settings.random.thumb.resizeMode ` Defines how thumbnails of random media assets are scaled. ================================== ====================== ================================================================================================== =================== .. _flexforms.mediagallery.hide.field: Hide flexform fields for editors -------------------------------- Through some UserTs and/or PageTs settings you are able to hide flexform fields for editors. :: TCEFORM.tt_content.pi_flexform.fsmediagallery_mediagallery.general.settings\.useAlbumFilterAsExclude.disabled = 1 TCEFORM.tt_content.pi_flexform.fsmediagallery_mediagallery.general.settings\.list\.orderBy.disabled = 1 TCEFORM.tt_content.pi_flexform.fsmediagallery_mediagallery.general.settings\.list\.orderDirection.disabled = 1