Initial commit - Typo3 11.5.41
This commit is contained in:
Matteo Gallo
@@ -0,0 +1,90 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _configuration-extConf:
|
||||
|
||||
Extension Manager
|
||||
=================
|
||||
|
||||
Target group: **Developers**
|
||||
|
||||
EXT:fs_media_gallery offers some basic configuration inside the Extension Manager.
|
||||
To set this configuration, switch to the Extension Manager, search for the extension
|
||||
*fs_media_gallery* and click on it to open the configuration view.
|
||||
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
================================================================================================= ================================ ===================================================================
|
||||
Property Data type Default
|
||||
================================================================================================= ================================ ===================================================================
|
||||
:ref:`allowedActionsInFlexforms <extConf.tx_fsmedia_gallery.allowedActionsInFlexforms>` :ref:`t3tsref:data-type-list` nestedList,flatList,showAlbumByParam,showAlbumByConfig,randomAsset
|
||||
:ref:`list.orderOptions <extConf.tx_fsmedia_gallery.list.orderOptions>` :ref:`t3tsref:data-type-list` datetime,crdate,sorting
|
||||
:ref:`enableAutoCreateFileCollection <extConf.tx_fsmedia_gallery.enableAutoCreateFileCollection>` :ref:`t3tsref:data-type-boolean` true
|
||||
:ref:`clearCacheAfterFileChange <extConf.tx_fsmedia_gallery.clearCacheAfterFileChange>` :ref:`t3tsref:data-type-boolean` false
|
||||
================================================================================================= ================================ ===================================================================
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _extConf.tx_fsmedia_gallery.allowedActionsInFlexforms:
|
||||
|
||||
allowedActionsInFlexforms
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
Defines plugin actions shown in flexforms so you can disable unwanted plugin modes.
|
||||
Comma separated list of controller actions which could be selected as
|
||||
":ref:`Display mode <flexforms.mediagallery.tabs.general.displayMode>`" in flexforms.
|
||||
Available actions are:
|
||||
|
||||
* nestedList
|
||||
* flatList
|
||||
* showAlbumByParam
|
||||
* showAlbumByConfig
|
||||
* randomAsset
|
||||
|
||||
If no action is defined, *all* available actions are selectable.
|
||||
|
||||
|
||||
.. _extConf.tx_fsmedia_gallery.list.orderOptions:
|
||||
|
||||
list.orderOptions
|
||||
"""""""""""""""""
|
||||
|
||||
Comma separated list of sort options for field ":ref:`Sort albums list by <flexforms.mediagallery.tabs.general.list.orderBy>`" in flexforms.
|
||||
Available actions are:
|
||||
|
||||
* datetime
|
||||
* crdate
|
||||
* sorting
|
||||
|
||||
|
||||
.. _extConf.tx_fsmedia_gallery.enableAutoCreateFileCollection:
|
||||
|
||||
enableAutoCreateFileCollection
|
||||
""""""""""""""""""""""""""""""
|
||||
|
||||
Enables auto creation of fileCollection(s)/album(s) of a folder when a new folder is created beneath an existing fileCollection/album.
|
||||
|
||||
.. _extConf.tx_fsmedia_gallery.clearCacheAfterFileChange:
|
||||
|
||||
clearCacheAfterFileChange
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
Clears the cache of the album after a file change. Set on false by default due that the cache will be cleared multiple times
|
||||
if more files will be added. Make sure "`TCEMAIN.clearCacheCmd`" is set as this value is used to define what cache should be cleared.
|
||||
|
||||
For more info about possible values see `Docs » Page TSconfig » ->TCEMAIN <https://docs.typo3.org/typo3cms/TSconfigReference/PageTsconfig/TCEmain/Index.html#clearcachecmd>`_.
|
||||
|
||||
|
||||
.. figure:: ../../Images/Configuration/ExtensionManager/extension_manager.png
|
||||
:width: 716px
|
||||
:alt: General extensionmanager settings
|
||||
|
||||
**Image 1:** General extensionmanager settings
|
||||
@@ -0,0 +1,32 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../Includes.txt
|
||||
|
||||
|
||||
.. _configuration:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Target group: **Developers**
|
||||
|
||||
Most configuration settings can be set through the flexform settings of a :ref:`plugin <configuration-plugin>`.
|
||||
As not every configuration is needed for every view, the not needed are hidden.
|
||||
Every setting can also be set using :ref:`TypoScript <configuration-typoscript>`.
|
||||
|
||||
.. important::
|
||||
|
||||
The settings of the plugin always override the ones from TypoScript.
|
||||
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 5
|
||||
:titlesonly:
|
||||
:glob:
|
||||
|
||||
Plugin/Index
|
||||
Reference/Index
|
||||
ExtensionManager/Index
|
||||
@@ -0,0 +1,232 @@
|
||||
.. ==================================================
|
||||
.. 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 <configuration-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 <configuration-extConf>`
|
||||
Media Albums nestedList, .. _flexforms.mediagallery.tabs.general.mediaAlbums: :ref:`settings.mediaAlbumsUids <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.persistence.storagePid>`
|
||||
|
||||
The "Storage Folder" which holds the album records.
|
||||
Recursive all .. _flexforms.mediagallery.tabs.general.recursive: :ref:`presistence.recursive <plugin.tx_fsmediagallery.persistence.recursive>`
|
||||
|
||||
Recursion level of the :ref:`Startingpoint <flexforms.mediagallery.tabs.general.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.settings.list.thumb.width>`
|
||||
|
||||
Height of thumbnail images.
|
||||
Thumb height nestedList, flatList .. _flexforms.mediagallery.tabs.list.thumb.height: :ref:`settings.list.thumb.height <plugin.tx_fsmediagallery.settings.list.thumb.height>`
|
||||
|
||||
Width of thumbnail images.
|
||||
Random thumbnail nestedList, flatList .. _flexforms.mediagallery.tabs.list.thumb.random: :ref:`settings.list.thumb.resizeMode <plugin.tx_fsmediagallery.settings.list.thumb.random>`
|
||||
|
||||
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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <flexforms.mediagallery.tabs.general.displayMode>` =
|
||||
``showAlbumByParam``, ``nestedList`` or ``flatList``).
|
||||
|
||||
Thumbnail width randomAsset .. _flexforms.mediagallery.tabs.random.thumb.width: :ref:`settings.random.thumb.width <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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 <plugin.tx_fsmediagallery.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
|
||||
@@ -0,0 +1,795 @@
|
||||
.. ==================================================
|
||||
.. FOR YOUR INFORMATION
|
||||
.. --------------------------------------------------
|
||||
.. -*- coding: utf-8 -*- with BOM.
|
||||
|
||||
.. include:: ../../Includes.txt
|
||||
|
||||
|
||||
.. _configuration-typoscript:
|
||||
|
||||
TypoScript Reference
|
||||
====================
|
||||
|
||||
Target group: **Developers**
|
||||
|
||||
All configuration options are available in the FlexForm or TypoScript,
|
||||
with the FlexForm settings taking precedence.
|
||||
|
||||
This chapter describes the settings which are available for EXT:fs_media_gallery.
|
||||
Except of setting the template paths and overriding labels of the locallang-file,
|
||||
the settings are defined by using :typoscript:`plugin.tx_fsmediagallery.settings.<property>`.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
:depth: 1
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.view:
|
||||
|
||||
View and template settings
|
||||
--------------------------
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
=========================== ============================== ======================= =================================================================
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
=========================== ============================== ======================= =================================================================
|
||||
`templateRootPaths.100`_ :ref:`t3tsref:data-type-path` no :typoscript:`{$plugin.tx_fsmediagallery.view.templateRootPath}`
|
||||
`partialRootPaths.100`_ :ref:`t3tsref:data-type-path` no :typoscript:`{$plugin.tx_fsmediagallery.view.partialRootPath}`
|
||||
`layoutRootPaths.100`_ :ref:`t3tsref:data-type-path` no :typoscript:`{$plugin.tx_fsmediagallery.view.layoutRootPath}`
|
||||
=========================== ============================== ======================= =================================================================
|
||||
|
||||
|
||||
.. tip::
|
||||
|
||||
Since TYPO3 6.2 it is possible to just override a single template file. Multiple fallbacks can be defined which makes it far easier to customize the templates.
|
||||
|
||||
EXT:fs_media_gallery uses key 100 pointing to the default paths of its fluid files.
|
||||
You can simply add overwrite paths so you only have to copy over files you want to change.
|
||||
All others can remain in the default location.
|
||||
|
||||
.. important::
|
||||
|
||||
Please notice the ending **s** in templateRootPath\ **s**\ , partialRootPath\ **s** and
|
||||
layoutRootPath\ **s**\ .
|
||||
|
||||
.. code-block:: ts
|
||||
|
||||
plugin.tx_fsmediagallery {
|
||||
view {
|
||||
templateRootPaths {
|
||||
100 = {$plugin.tx_fsmediagallery.view.templateRootPath}
|
||||
200 = fileadmin/templates/ext/tx_fsmediagallery/Templates/
|
||||
}
|
||||
partialRootPaths {
|
||||
100 = {$plugin.tx_fsmediagallery.view.partialRootPath}
|
||||
200 = fileadmin/templates/ext/tx_fsmediagallery/Partials/
|
||||
}
|
||||
layoutRootPaths {
|
||||
100 = {$plugin.tx_fsmediagallery.view.layoutRootPath}
|
||||
200 = fileadmin/templates/ext/tx_fsmediagallery/Layouts/
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.view.templateRootPaths.100:
|
||||
|
||||
templateRootPaths.100
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.view.templateRootPaths.100 =` :ref:`t3tsref:data-type-path`
|
||||
|
||||
Root path for the fluid **templates** of the plugin.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.view.partialRootPaths.100:
|
||||
|
||||
partialRootPaths.100
|
||||
""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.view.partialRootPaths.100 =` :ref:`t3tsref:data-type-path`
|
||||
|
||||
Root path for the fluid **partials** of the plugin.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.view.layoutRootPaths.100:
|
||||
|
||||
layoutRootPaths.100
|
||||
"""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.view.layoutRootPaths.100 =` :ref:`t3tsref:data-type-path`
|
||||
|
||||
Root path for the fluid **layouts** of the plugin.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.persistence:
|
||||
|
||||
Extbase persistence layer
|
||||
-------------------------
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
=========================== ================================================================== ======================= =================================================================
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
=========================== ================================================================== ======================= =================================================================
|
||||
`persistence.storagePid`_ :ref:`t3tsref:data-type-page-id` or :ref:`t3tsref:data-type-list` no :typoscript:`{$plugin.tx_fsmediagallery.persistence.storagePid}`
|
||||
`persistence.recursive`_ :ref:`t3tsref:data-type-integer` no :typoscript:`{$plugin.tx_fsmediagallery.persistence.recursive}`
|
||||
=========================== ================================================================== ======================= =================================================================
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.persistence.storagePid:
|
||||
|
||||
persistence.storagePid
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.persistence.storagePid =` :ref:`t3tsref:data-type-page-id` or :ref:`t3tsref:data-type-list`
|
||||
|
||||
The Storage Folder which holds the Album Records.
|
||||
Multiple foldes can be set using a comma separated list.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.persistence.recursive:
|
||||
|
||||
persistence.recursive
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.persistence.recursive =` :ref:`t3tsref:data-type-integer`
|
||||
|
||||
| Recursion level of the :ref:`storagePid <plugin.tx_fsmediagallery.persistence.storagePid>` (startingpoint in flexform).
|
||||
| ``0`` = no recursion (only items from Storage Folder are used)
|
||||
| ``1`` ... ``255`` = subfolders of the Storage Folder will be used
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings:
|
||||
|
||||
General properties
|
||||
------------------
|
||||
|
||||
The following table describes general settings for the plugin.
|
||||
They are set by :typoscript:`plugin.tx_fsmediagallery.settings.<property>`
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
==================================== ================================= ======================= ===================================================================================
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
==================================== ================================= ======================= ===================================================================================
|
||||
`allowedAssetMimeTypes`_ :ref:`t3tsref:data-type-list` no :typoscript:`{$plugin.tx_fsmediagallery.settings.allowedAssetMimeTypes}`
|
||||
`mediaAlbumsUids`_ :ref:`t3tsref:data-type-list` no
|
||||
`overrideFlexformSettingsIfEmpty`_ :ref:`t3tsref:data-type-list` no :typoscript:`{$plugin.tx_fsmediagallery.settings.overrideFlexformSettingsIfEmpty}`
|
||||
`useAlbumFilterAsExclude`_ :ref:`t3tsref:data-type-boolean` no :code:`0`
|
||||
==================================== ================================= ======================= ===================================================================================
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.overrideFlexformSettingsIfEmpty:
|
||||
|
||||
overrideFlexformSettingsIfEmpty
|
||||
"""""""""""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.overrideFlexformSettingsIfEmpty =` :ref:`t3tsref:data-type-list`
|
||||
|
||||
Comma separated list of settings which are allowed to be set by TypoScript if the flexform value is empty.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.allowedAssetMimeTypes:
|
||||
|
||||
allowedAssetMimeTypes
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.allowedAssetMimeTypes =` :ref:`t3tsref:data-type-list`
|
||||
|
||||
Comma separated list of mime types (if empty, all files are included)
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.mediaAlbumsUids:
|
||||
|
||||
mediaAlbumsUids
|
||||
"""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.mediaAlbumsUids =` :ref:`t3tsref:data-type-list`
|
||||
|
||||
Album selection for ``nestedList`` and ``randomAsset`` views of the plugin (see :ref:`Display Mode <flexforms.mediagallery.tabs.general.mediaAlbums>`).
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.useAlbumFilterAsExclude:
|
||||
|
||||
useAlbumFilterAsExclude
|
||||
"""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.useAlbumFilterAsExclude =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
| :code:`0` = Show only items defined in :ref:`settings.mediaAlbums <plugin.tx_fsmediagallery.settings.mediaAlbumsUids>`
|
||||
| :code:`1` = Exclude items defined in :ref:`settings.mediaAlbums <plugin.tx_fsmediagallery.settings.mediaAlbumsUids>`
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list:
|
||||
|
||||
Properties for list view
|
||||
------------------------
|
||||
|
||||
The following table describes the settings for the *list* view.
|
||||
They are set by :typoscript:`plugin.tx_fsmediagallery.settings.list.<property>`
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
================================================================================================================ ============================================================== ======================= =================
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
================================================================================================================ ============================================================== ======================= =================
|
||||
:ref:`hideEmptyAlbums <plugin.tx_fsmediagallery.settings.list.hideEmptyAlbums>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
:ref:`orderBy <plugin.tx_fsmediagallery.settings.list.orderBy>` :ref:`t3tsref:data-type-string` ``[datetime|crdate|sorting]`` no :code:`datetime`
|
||||
:ref:`orderDirection <plugin.tx_fsmediagallery.settings.list.orderDirection>` :ref:`t3tsref:data-type-string` ``[asc|desc]`` no :code:`desc`
|
||||
:ref:`pagination.insertAbove <plugin.tx_fsmediagallery.settings.list.pagination.insertAbove>` :ref:`t3tsref:data-type-boolean` no :code:`0`
|
||||
:ref:`pagination.insertBelow <plugin.tx_fsmediagallery.settings.list.pagination.insertBelow>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
:ref:`pagination.itemsPerPage <plugin.tx_fsmediagallery.settings.list.pagination.itemsPerPage>` :ref:`t3tsref:data-type-positive-integer` no :code:`12`
|
||||
:ref:`pagination.pagesBefore <plugin.tx_fsmediagallery.settings.list.pagination.pagesBefore>` :ref:`t3tsref:data-type-positive-integer` or ``0`` no :code:`4`
|
||||
:ref:`pagination.pagesAfter <plugin.tx_fsmediagallery.settings.list.pagination.pagesAfter>` :ref:`t3tsref:data-type-positive-integer` or ``0`` no :code:`4`
|
||||
:ref:`pagination.maximumNumberOfLinks <plugin.tx_fsmediagallery.settings.list.pagination.maximumNumberOfLinks>` :ref:`t3tsref:data-type-positive-integer` no :code:`9`
|
||||
:ref:`skipListWhenOnlyOneAlbum <plugin.tx_fsmediagallery.settings.list.skipListWhenOnlyOneAlbum>` :ref:`t3tsref:data-type-boolean` no :code:`0`
|
||||
:ref:`thumb.width <plugin.tx_fsmediagallery.settings.list.thumb.width>` :ref:`t3tsref:data-type-pixels` no :code:`180`
|
||||
:ref:`thumb.height <plugin.tx_fsmediagallery.settings.list.thumb.height>` :ref:`t3tsref:data-type-pixels` no :code:`100`
|
||||
:ref:`thumb.resizeMode <plugin.tx_fsmediagallery.settings.list.thumb.resizeMode>` :ref:`t3tsref:data-type-string` ``[m|c|s]`` no :code:`m`
|
||||
:ref:`thumb.random <plugin.tx_fsmediagallery.settings.list.thumb.random>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
================================================================================================================ ============================================================== ======================= =================
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.thumb.width:
|
||||
|
||||
thumb.width
|
||||
"""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.thumb.width =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Height of thumbnail images.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.thumb.height:
|
||||
|
||||
thumb.height
|
||||
""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.thumb.height =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Width of thumbnail images.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.thumb.resizeMode:
|
||||
|
||||
thumb.resizeMode
|
||||
""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.thumb.resizeMode =` :ref:`t3tsref:data-type-string` ``[m|c|s]``
|
||||
|
||||
| Defines how thumbnails in list view are scaled.
|
||||
| :code:`m` = resize proportional; the proportions will be preserved and thus width/height are treated as maximum dimensions for the image. The image will be scaled to fit into width/height rectangle.
|
||||
| :code:`c` = crop; the proportions will be preserved and the image will be scaled to fit around a rectangle with width/height dimensions. Then, a centered portion from inside of the image (size defined by width/height) will be cut out.
|
||||
| :code:`s` = squeeze (unproportional exact fit); the proportions will *not* be preserved and the image will be unproportional scaled.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.thumb.random:
|
||||
|
||||
thumb.random
|
||||
""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.thumb.random =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
If :code:`1` (:code:`TRUE`) a random album thumbnail will be shown, else the first found.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.hideEmptyAlbums:
|
||||
|
||||
hideEmptyAlbums
|
||||
"""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.hideEmptyAlbums =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
If :code:`1` (:code:`TRUE`) albums without media assets are excluded from list views.
|
||||
See :ref:`settings.allowedAssetMimeTypes <plugin.tx_fsmediagallery.settings.allowedAssetMimeTypes>` to set which files should be included.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.skipListWhenOnlyOneAlbum:
|
||||
|
||||
skipListWhenOnlyOneAlbum
|
||||
""""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.skipListWhenOnlyOneAlbum =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
If :code:`1` (:code:`TRUE`) the nested album list view is skipped if only one album is to be displayed.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.orderBy:
|
||||
|
||||
orderBy
|
||||
"""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.orderBy =` :ref:`t3tsref:data-type-string` ``[datetime|crdate|sorting]``
|
||||
|
||||
| Defines how albums in list views are ordered.
|
||||
| :code:`datetime` = Given date/time
|
||||
| :code:`crdate` = Creation date/time
|
||||
| :code:`sorting` = Given sort order
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.orderDirection:
|
||||
|
||||
orderDirection
|
||||
""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.orderDirection =` :ref:`t3tsref:data-type-string` ``[asc|desc]``
|
||||
|
||||
| Defines the sort order of albums in list views.
|
||||
| :code:`asc` = Ascending (old to new/low to high)
|
||||
| :code:`desc` = Descending (new to old/high to low)
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.pagination.insertAbove:
|
||||
|
||||
pagination.insertAbove
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.pagination.insertAbove =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
Set it to ``1`` (``TRUE``) or ``0`` (``FALSE``) to either show or hide the pagination before an album list.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.pagination.insertBelow:
|
||||
|
||||
pagination.insertBelow
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.pagination.insertBelow =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
Set it to ``1`` (``TRUE``) or ``0`` (``FALSE``) to either show or hide the pagination after an album list.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.pagination.itemsPerPage:
|
||||
|
||||
pagination.itemsPerPage
|
||||
"""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.pagination.itemsPerPage =` :ref:`t3tsref:data-type-positive-integer`
|
||||
|
||||
Define how many items are shown on one page.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.pagination.pagesBefore:
|
||||
|
||||
pagination.pagesBefore
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.pagination.pagesBefore =` :ref:`t3tsref:data-type-positive-integer` or ``0``
|
||||
|
||||
Number of page links before the current page.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.pagination.pagesAfter:
|
||||
|
||||
pagination.pagesAfter
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.pagination.pagesAfter =` :ref:`t3tsref:data-type-positive-integer` or ``0``
|
||||
|
||||
Number of page links after the current page.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.list.pagination.maximumNumberOfLinks:
|
||||
|
||||
pagination.maximumNumberOfLinks
|
||||
"""""""""""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.pagination.maximumNumberOfLinks =` :ref:`t3tsref:data-type-positive-integer`
|
||||
|
||||
Force this number of page browser links on the screen.
|
||||
An odd number is recommended because it looks more symmetrical.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album:
|
||||
|
||||
Properties for album view
|
||||
-------------------------
|
||||
|
||||
The following table describes the settings for the *album* view.
|
||||
They are set by :typoscript:`plugin.tx_fsmediagallery.settings.album.<property>`
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
================================================================================================================= ========================================================= ======================= =================
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
================================================================================================================= ========================================================= ======================= =================
|
||||
:ref:`assets.orderBy <plugin.tx_fsmediagallery.settings.album.assets.orderBy>` :ref:`t3tsref:data-type-string` ``[|name|crdate|title]`` no :code:``
|
||||
:ref:`assets.orderDirection <plugin.tx_fsmediagallery.settings.album.assets.orderDirection>` :ref:`t3tsref:data-type-string` ``[asc|desc]`` no :code:`asc`
|
||||
:ref:`lightbox.enable <plugin.tx_fsmediagallery.settings.album.lightbox.enable>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
:ref:`lightbox.jsPlugin <plugin.tx_fsmediagallery.settings.album.lightbox.jsPlugin>` :ref:`t3tsref:data-type-string` no :code:`colorbox`
|
||||
:ref:`lightbox.relPrefix <plugin.tx_fsmediagallery.settings.album.lightbox.relPrefix>` :ref:`t3tsref:data-type-string` no :code:`albm_`
|
||||
:ref:`lightbox.styleClass <plugin.tx_fsmediagallery.settings.album.lightbox.styleClass>` :ref:`t3tsref:data-type-string` no :code:`lightbox`
|
||||
:ref:`lightbox.asset.width <plugin.tx_fsmediagallery.settings.album.lightbox.asset.width>` :ref:`t3tsref:data-type-pixels` no :code:`1920`
|
||||
:ref:`lightbox.asset.height <plugin.tx_fsmediagallery.settings.album.lightbox.asset.height>` :ref:`t3tsref:data-type-pixels` no :code:`1080`
|
||||
:ref:`lightbox.asset.resizeMode <plugin.tx_fsmediagallery.settings.album.lightbox.asset.resizeMode>` :ref:`t3tsref:data-type-string` ``[m|c|s]`` no :code:`m`
|
||||
:ref:`pagination.insertAbove <plugin.tx_fsmediagallery.settings.album.pagination.insertAbove>` :ref:`t3tsref:data-type-boolean` no :code:`0`
|
||||
:ref:`pagination.insertBelow <plugin.tx_fsmediagallery.settings.album.pagination.insertBelow>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
:ref:`pagination.itemsPerPage <plugin.tx_fsmediagallery.settings.album.pagination.itemsPerPage>` :ref:`t3tsref:data-type-positive-integer` no :code:`32`
|
||||
:ref:`pagination.pagesBefore <plugin.tx_fsmediagallery.settings.album.pagination.pagesBefore>` :ref:`t3tsref:data-type-positive-integer` or ``0`` no :code:`4`
|
||||
:ref:`pagination.pagesAfter <plugin.tx_fsmediagallery.settings.album.pagination.pagesAfter>` :ref:`t3tsref:data-type-positive-integer` or ``0`` no :code:`4`
|
||||
:ref:`pagination.maximumNumberOfLinks <plugin.tx_fsmediagallery.settings.album.pagination.maximumNumberOfLinks>` :ref:`t3tsref:data-type-positive-integer` no :code:`9`
|
||||
:ref:`thumb.width <plugin.tx_fsmediagallery.settings.album.thumb.width>` :ref:`t3tsref:data-type-pixels` no :code:`120`
|
||||
:ref:`thumb.height <plugin.tx_fsmediagallery.settings.album.thumb.height>` :ref:`t3tsref:data-type-pixels` no :code:`70`
|
||||
:ref:`thumb.resizeMode <plugin.tx_fsmediagallery.settings.album.thumb.resizeMode>` :ref:`t3tsref:data-type-string` ``[m|c|s]`` no :code:`m`
|
||||
:ref:`displayTitle <plugin.tx_fsmediagallery.settings.album.displayTitle>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
================================================================================================================= ========================================================= ======================= =================
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.assets.orderBy:
|
||||
|
||||
assets.orderBy
|
||||
""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.assets.orderBy =` :ref:`t3tsref:data-type-string` ``[|name|crdate|title]``
|
||||
|
||||
| Defines the sorting of the media/fiels shown in a album.
|
||||
| :code:`` = When not set (empty) the file system ordering is used
|
||||
| :code:`name` = Name of the file
|
||||
| :code:`crdate` = Creation date/time
|
||||
| :code:`title` = Title of the file (metadata)
|
||||
| :code:`content_creation_date` = Content Creation Date (ext:filemetadata)
|
||||
| :code:`content_modification_date` = Content Modification Date (ext:filemetadata)
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.assets.orderDirection:
|
||||
|
||||
assets.orderDirection
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.list.orderDirection =` :ref:`t3tsref:data-type-string` ``[asc|desc]``
|
||||
|
||||
| Defines the sort direction of the media/files.
|
||||
| :code:`asc` = Ascending (old to new/low to high)
|
||||
| :code:`desc` = Descending (new to old/high to low)
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.thumb.width:
|
||||
|
||||
thumb.width
|
||||
"""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.thumb.width =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Height of thumbnail images.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.thumb.height:
|
||||
|
||||
thumb.height
|
||||
""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.thumb.height =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Width of thumbnail images.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.thumb.resizeMode:
|
||||
|
||||
thumb.resizeMode
|
||||
""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.thumb.resizeMode =` :ref:`t3tsref:data-type-string` ``[m|c|s]``
|
||||
|
||||
| Defines how thumbnails in album view are scaled.
|
||||
| :code:`m` = resize proportional; the proportions will be preserved and thus width/height are treated as maximum dimensions for the image. The image will be scaled to fit into width/height rectangle.
|
||||
| :code:`c` = crop; the proportions will be preserved and the image will be scaled to fit around a rectangle with width/height dimensions. Then, a centered portion from inside of the image (size defined by width/height) will be cut out.
|
||||
| :code:`s` = squeeze (unproportional exact fit); the proportions will *not* be preserved and the image will be unproportional scaled.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.enable:
|
||||
|
||||
lightbox.enable
|
||||
"""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.enable =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
If :code:`1`, the album view does not link to detail view but displays media assets using a lightbox/colorbox.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.styleClass:
|
||||
|
||||
lightbox.styleClass
|
||||
"""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.styleClass =` :ref:`t3tsref:data-type-string`
|
||||
|
||||
CSS class used for lightbox/colorbox elements.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.relPrefix:
|
||||
|
||||
lightbox.relPrefix
|
||||
""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.relPrefix =` :ref:`t3tsref:data-type-string`
|
||||
|
||||
| Prefix used in ``rel`` attributes of lightbox/colorbox links.
|
||||
| The default templates build ``rel`` attributes of lightbox/colorbox links like
|
||||
``<a href="..." rel="{settings.album.lightbox.relPrefix}{mediaAlbum.uid}" ...>...</a>``.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.jsPlugin:
|
||||
|
||||
lightbox.jsPlugin
|
||||
"""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.jsPlugin =` :ref:`t3tsref:data-type-string`
|
||||
|
||||
Use this setting to e.g. render different lightbox/colorbox javascript code.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.asset.width:
|
||||
|
||||
lightbox.asset.width
|
||||
""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.asset.width =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Height of media assets used by lightbox/colorbox.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.asset.height:
|
||||
|
||||
lightbox.asset.height
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.asset.height =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Width of media assets used by lightbox/colorbox.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.lightbox.asset.resizeMode:
|
||||
|
||||
lightbox.asset.resizeMode
|
||||
"""""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.lightbox.asset.resizeMode =` :ref:`t3tsref:data-type-string` ``[m|c|s]``
|
||||
|
||||
| Defines how media assets used by lightbox/colorbox are scaled.
|
||||
| :code:`m` = resize proportional; the proportions will be preserved and thus width/height are treated as maximum dimensions for the image. The image will be scaled to fit into width/height rectangle.
|
||||
| :code:`c` = crop; the proportions will be preserved and the image will be scaled to fit around a rectangle with width/height dimensions. Then, a centered portion from inside of the image (size defined by width/height) will be cut out.
|
||||
| :code:`s` = squeeze (unproportional exact fit); the proportions will *not* be preserved and the image will be unproportional scaled.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.displayTitle:
|
||||
|
||||
displayTitle
|
||||
""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.displayTitle =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
Set it to ``1`` (``TRUE``) or ``0`` (``FALSE``) to either show or hide the album title.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.pagination.insertAbove:
|
||||
|
||||
pagination.insertAbove
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.pagination.insertAbove =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
Set it to ``1`` (``TRUE``) or ``0`` (``FALSE``) to either show or hide the pagination before an asset list.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.pagination.insertBelow:
|
||||
|
||||
pagination.insertBelow
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.pagination.insertBelow =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
Set it to ``1`` (``TRUE``) or ``0`` (``FALSE``) to either show or hide the pagination after an asset list.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.pagination.itemsPerPage:
|
||||
|
||||
pagination.itemsPerPage
|
||||
"""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.pagination.itemsPerPage =` :ref:`t3tsref:data-type-positive-integer`
|
||||
|
||||
Define how many items are shown on one page.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.pagination.pagesBefore:
|
||||
|
||||
pagination.pagesBefore
|
||||
""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.pagination.pagesBefore =` :ref:`t3tsref:data-type-positive-integer` or ``0``
|
||||
|
||||
Number of page links before the current page.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.pagination.pagesAfter:
|
||||
|
||||
pagination.pagesAfter
|
||||
"""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.pagination.pagesAfter =` :ref:`t3tsref:data-type-positive-integer` or ``0``
|
||||
|
||||
Number of page links after the current page.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.album.pagination.maximumNumberOfLinks:
|
||||
|
||||
pagination.maximumNumberOfLinks
|
||||
"""""""""""""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.album.pagination.maximumNumberOfLinks =` :ref:`t3tsref:data-type-positive-integer`
|
||||
|
||||
Force this number of page browser links on the screen.
|
||||
An odd number is recommended because it looks more symmetrical.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.detail:
|
||||
|
||||
Properties for detail view
|
||||
--------------------------
|
||||
|
||||
The following table describes the settings for the *detail* view.
|
||||
They are set by :typoscript:`plugin.tx_fsmediagallery.settings.detail.<property>`
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
==================================================================================== ============================================ ======================= =============
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
==================================================================================== ============================================ ======================= =============
|
||||
:ref:`asset.width <plugin.tx_fsmediagallery.settings.detail.asset.width>` :ref:`t3tsref:data-type-pixels` no :code:`1920`
|
||||
:ref:`asset.height <plugin.tx_fsmediagallery.settings.detail.asset.height>` :ref:`t3tsref:data-type-pixels` no :code:`1080`
|
||||
:ref:`asset.resizeMode <plugin.tx_fsmediagallery.settings.detail.asset.resizeMode>` :ref:`t3tsref:data-type-string` ``[m|c|s]`` no :code:`m`
|
||||
==================================================================================== ============================================ ======================= =============
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.detail.asset.width:
|
||||
|
||||
asset.width
|
||||
"""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.detail.asset.width =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Height of media asset in detail view.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.detail.asset.height:
|
||||
|
||||
asset.height
|
||||
""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.detail.asset.height =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Width of media asset in detail view.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.detail.asset.resizeMode:
|
||||
|
||||
asset.resizeMode
|
||||
""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.detail.asset.resizeMode =` :ref:`t3tsref:data-type-string` ``[m|c|s]``
|
||||
|
||||
| Defines how media assets in detail view are scaled.
|
||||
| :code:`m` = resize proportional; the proportions will be preserved and thus width/height are treated as maximum dimensions for the image. The image will be scaled to fit into width/height rectangle.
|
||||
| :code:`c` = crop; the proportions will be preserved and the image will be scaled to fit around a rectangle with width/height dimensions. Then, a centered portion from inside of the image (size defined by width/height) will be cut out.
|
||||
| :code:`s` = squeeze (unproportional exact fit); the proportions will *not* be preserved and the image will be unproportional scaled.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.random:
|
||||
|
||||
Properties for random view
|
||||
--------------------------
|
||||
|
||||
The following table describes the settings for the *random* view.
|
||||
They are set by :typoscript:`plugin.tx_fsmediagallery.settings.random.<property>`
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
==================================================================================== ============================================ ======================= =============
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
==================================================================================== ============================================ ======================= =============
|
||||
:ref:`targetPid <plugin.tx_fsmediagallery.settings.random.targetPid>` :ref:`t3tsref:data-type-page-id` no
|
||||
:ref:`thumb.width <plugin.tx_fsmediagallery.settings.random.thumb.width>` :ref:`t3tsref:data-type-pixels` no :code:`250`
|
||||
:ref:`thumb.height <plugin.tx_fsmediagallery.settings.random.thumb.height>` :ref:`t3tsref:data-type-pixels` no :code:`140`
|
||||
:ref:`thumb.resizeMode <plugin.tx_fsmediagallery.settings.random.thumb.resizeMode>` :ref:`t3tsref:data-type-string` ``[m|c|s]`` no :code:`m`
|
||||
==================================================================================== ============================================ ======================= =============
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.random.targetPid:
|
||||
|
||||
targetPid
|
||||
"""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.random.targetPid =` :ref:`t3tsref:data-type-page-id`
|
||||
|
||||
.. todo: add a link to controller actions of plugins
|
||||
|
||||
Target page a random assets should link to.
|
||||
Select a page on which a plugin is configured to display the full album.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.random.thumb.width:
|
||||
|
||||
thumb.width
|
||||
"""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.random.thumb.width =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Height of thumbnail images of random media assets.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.random.thumb.height:
|
||||
|
||||
thumb.height
|
||||
""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.random.thumb.height =` :ref:`t3tsref:data-type-pixels`
|
||||
|
||||
Width of thumbnail images of random media assets.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.random.thumb.resizeMode:
|
||||
|
||||
thumb.resizeMode
|
||||
""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.random.thumb.resizeMode =` :ref:`t3tsref:data-type-string` ``[m|c|s]``
|
||||
|
||||
| Defines how thumbnails of random media assets are scaled.
|
||||
| :code:`m` = resize proportional; the proportions will be preserved and thus width/height are treated as maximum dimensions for the image. The image will be scaled to fit into width/height rectangle.
|
||||
| :code:`c` = crop; the proportions will be preserved and the image will be scaled to fit around a rectangle with width/height dimensions. Then, a centered portion from inside of the image (size defined by width/height) will be cut out.
|
||||
| :code:`s` = squeeze (unproportional exact fit); the proportions will *not* be preserved and the image will be unproportional scaled.
|
||||
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.features:
|
||||
|
||||
Other Properties
|
||||
----------------
|
||||
|
||||
They properties in the following table are set by :typoscript:`plugin.tx_fsmediagallery.settings.<property>`
|
||||
|
||||
.. container:: ts-properties
|
||||
|
||||
======================================================================================================= ================================= ======================= ===========
|
||||
Property Data type :ref:`t3tsref:stdwrap` Default
|
||||
======================================================================================================= ================================= ======================= ===========
|
||||
:ref:`features.skipDefaultArguments <plugin.tx_fsmediagallery.settings.features.skipDefaultArguments>` :ref:`t3tsref:data-type-boolean` no :code:`1`
|
||||
======================================================================================================= ================================= ======================= ===========
|
||||
|
||||
|
||||
Property details
|
||||
^^^^^^^^^^^^^^^^
|
||||
|
||||
.. _plugin.tx_fsmediagallery.settings.features.skipDefaultArguments:
|
||||
|
||||
skipDefaultArguments
|
||||
""""""""""""""""""""
|
||||
|
||||
:typoscript:`plugin.tx_fsmediagallery.settings.features.skipDefaultArguments =` :ref:`t3tsref:data-type-boolean`
|
||||
|
||||
Configure Extbase to skip the URI arguments for controller and action
|
||||
(see `Skip default arguments in URIs <https://forge.typo3.org/projects/typo3v4-mvc/wiki/Skip_default_arguments_in_URIs>`_
|
||||
on TYPO3 Forge).
|
||||
Reference in New Issue
Block a user