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 plugin.tx_fsmediagallery.settings.<property>.

View and template settings
Extbase persistence layer
General properties
Properties for list view
Properties for album view
Properties for detail view
Properties for random view
Other Properties

View and template settings ¶

Property	Data type	stdWrap	Default
templateRootPaths.100	path	no	`{$plugin.tx_fsmediagallery.view.templateRootPath}`
partialRootPaths.100	path	no	`{$plugin.tx_fsmediagallery.view.partialRootPath}`
layoutRootPaths.100	path	no	`{$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 templateRootPaths, partialRootPaths and layoutRootPaths.

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¶

templateRootPaths.100¶

plugin.tx_fsmediagallery.view.templateRootPaths.100 = path

Root path for the fluid templates of the plugin.

partialRootPaths.100¶

plugin.tx_fsmediagallery.view.partialRootPaths.100 = path

Root path for the fluid partials of the plugin.

layoutRootPaths.100¶

plugin.tx_fsmediagallery.view.layoutRootPaths.100 = path

Root path for the fluid layouts of the plugin.

Extbase persistence layer ¶

Property	Data type	stdWrap	Default
persistence.storagePid	page_id or list	no	`{$plugin.tx_fsmediagallery.persistence.storagePid}`
persistence.recursive	integer	no	`{$plugin.tx_fsmediagallery.persistence.recursive}`

Property details¶

persistence.storagePid¶

plugin.tx_fsmediagallery.persistence.storagePid = page_id or list

The Storage Folder which holds the Album Records. Multiple foldes can be set using a comma separated list.

persistence.recursive¶

plugin.tx_fsmediagallery.persistence.recursive = integer

Recursion level of the storagePid (startingpoint in flexform).
0 = no recursion (only items from Storage Folder are used)
1 … 255 = subfolders of the Storage Folder will be used

General properties ¶

The following table describes general settings for the plugin. They are set by plugin.tx_fsmediagallery.settings.<property>

Property	Data type	stdWrap	Default
allowedAssetMimeTypes	list	no	`{$plugin.tx_fsmediagallery.settings.allowedAssetMimeTypes}`
mediaAlbumsUids	list	no
overrideFlexformSettingsIfEmpty	list	no	`{$plugin.tx_fsmediagallery.settings.overrideFlexformSettingsIfEmpty}`
useAlbumFilterAsExclude	boolean	no	`0`

Property details¶

overrideFlexformSettingsIfEmpty¶

plugin.tx_fsmediagallery.settings.overrideFlexformSettingsIfEmpty = list

Comma separated list of settings which are allowed to be set by TypoScript if the flexform value is empty.

allowedAssetMimeTypes¶

plugin.tx_fsmediagallery.settings.allowedAssetMimeTypes = list

Comma separated list of mime types (if empty, all files are included)

mediaAlbumsUids¶

plugin.tx_fsmediagallery.settings.mediaAlbumsUids = list

Album selection for nestedList and randomAsset views of the plugin (see Display Mode).

useAlbumFilterAsExclude¶

plugin.tx_fsmediagallery.settings.useAlbumFilterAsExclude = boolean

0 = Show only items defined in settings.mediaAlbums

1 = Exclude items defined in settings.mediaAlbums

Properties for list view ¶

The following table describes the settings for the list view. They are set by plugin.tx_fsmediagallery.settings.list.<property>

Property	Data type	stdWrap	Default
hideEmptyAlbums	boolean	no	`1`
orderBy	string `[datetime\|crdate\|sorting]`	no	`datetime`
orderDirection	string `[asc\|desc]`	no	`desc`
pagination.insertAbove	boolean	no	`0`
pagination.insertBelow	boolean	no	`1`
pagination.itemsPerPage	positive integer	no	`12`
pagination.pagesBefore	positive integer or `0`	no	`4`
pagination.pagesAfter	positive integer or `0`	no	`4`
pagination.maximumNumberOfLinks	positive integer	no	`9`
skipListWhenOnlyOneAlbum	boolean	no	`0`
thumb.width	pixels	no	`180`
thumb.height	pixels	no	`100`
thumb.resizeMode	string `[m\|c\|s]`	no	`m`
thumb.random	boolean	no	`1`

Property details¶

thumb.width¶

plugin.tx_fsmediagallery.settings.list.thumb.width = pixels

Height of thumbnail images.

thumb.height¶

plugin.tx_fsmediagallery.settings.list.thumb.height = pixels

Width of thumbnail images.

thumb.resizeMode¶

plugin.tx_fsmediagallery.settings.list.thumb.resizeMode = string [m|c|s]

Defines how thumbnails in list view are scaled.
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.
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.
s = squeeze (unproportional exact fit); the proportions will not be preserved and the image will be unproportional scaled.

thumb.random¶

plugin.tx_fsmediagallery.settings.list.thumb.random = boolean

If 1 (TRUE) a random album thumbnail will be shown, else the first found.

hideEmptyAlbums¶

plugin.tx_fsmediagallery.settings.list.hideEmptyAlbums = boolean

If 1 (TRUE) albums without media assets are excluded from list views. See settings.allowedAssetMimeTypes to set which files should be included.

skipListWhenOnlyOneAlbum¶

plugin.tx_fsmediagallery.settings.list.skipListWhenOnlyOneAlbum = boolean

If 1 (TRUE) the nested album list view is skipped if only one album is to be displayed.

orderBy¶

plugin.tx_fsmediagallery.settings.list.orderBy = string [datetime|crdate|sorting]

Defines how albums in list views are ordered.
datetime = Given date/time
crdate = Creation date/time
sorting = Given sort order

orderDirection¶

plugin.tx_fsmediagallery.settings.list.orderDirection = string [asc|desc]

Defines the sort order of albums in list views.
asc = Ascending (old to new/low to high)
desc = Descending (new to old/high to low)

pagination.insertAbove¶

plugin.tx_fsmediagallery.settings.list.pagination.insertAbove = boolean

Set it to 1 (TRUE) or 0 (FALSE) to either show or hide the pagination before an album list.

pagination.insertBelow¶

plugin.tx_fsmediagallery.settings.list.pagination.insertBelow = boolean

Set it to 1 (TRUE) or 0 (FALSE) to either show or hide the pagination after an album list.

pagination.itemsPerPage¶

plugin.tx_fsmediagallery.settings.list.pagination.itemsPerPage = positive integer

Define how many items are shown on one page.

pagination.pagesBefore¶

plugin.tx_fsmediagallery.settings.list.pagination.pagesBefore = positive integer or 0

Number of page links before the current page.

pagination.pagesAfter¶

plugin.tx_fsmediagallery.settings.list.pagination.pagesAfter = positive integer or 0

Number of page links after the current page.

pagination.maximumNumberOfLinks¶

plugin.tx_fsmediagallery.settings.list.pagination.maximumNumberOfLinks = positive integer

Force this number of page browser links on the screen. An odd number is recommended because it looks more symmetrical.

Properties for album view ¶

The following table describes the settings for the album view. They are set by plugin.tx_fsmediagallery.settings.album.<property>

Property	Data type	stdWrap	Default
lightbox.enable	boolean	no	`1`
lightbox.jsPlugin	string	no	`colorbox`
lightbox.relPrefix	string	no	`albm_`
lightbox.styleClass	string	no	`lightbox`
lightbox.asset.width	pixels	no	`1920`
lightbox.asset.height	pixels	no	`1080`
lightbox.asset.resizeMode	string `[m\|c\|s]`	no	`m`
pagination.insertAbove	boolean	no	`0`
pagination.insertBelow	boolean	no	`1`
pagination.itemsPerPage	positive integer	no	`32`
pagination.pagesBefore	positive integer or `0`	no	`4`
pagination.pagesAfter	positive integer or `0`	no	`4`
pagination.maximumNumberOfLinks	positive integer	no	`9`
thumb.width	pixels	no	`120`
thumb.height	pixels	no	`70`
thumb.resizeMode	string `[m\|c\|s]`	no	`m`
displayTitle	boolean	no	`1`

Property details¶

thumb.width¶

plugin.tx_fsmediagallery.settings.album.thumb.width = pixels

Height of thumbnail images.

thumb.height¶

plugin.tx_fsmediagallery.settings.album.thumb.height = pixels

Width of thumbnail images.

thumb.resizeMode¶

plugin.tx_fsmediagallery.settings.album.thumb.resizeMode = string [m|c|s]

Defines how thumbnails in album view are scaled.
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.
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.
s = squeeze (unproportional exact fit); the proportions will not be preserved and the image will be unproportional scaled.

displayTitle¶

plugin.tx_fsmediagallery.settings.album.displayTitle = boolean

Set it to 1 (TRUE) or 0 (FALSE) to either show or hide the album title.

pagination.insertAbove¶

plugin.tx_fsmediagallery.settings.album.pagination.insertAbove = boolean

Set it to 1 (TRUE) or 0 (FALSE) to either show or hide the pagination before an asset list.

pagination.insertBelow¶

plugin.tx_fsmediagallery.settings.album.pagination.insertBelow = boolean

Set it to 1 (TRUE) or 0 (FALSE) to either show or hide the pagination after an asset list.

pagination.itemsPerPage¶

plugin.tx_fsmediagallery.settings.album.pagination.itemsPerPage = positive integer

Define how many items are shown on one page.

pagination.pagesBefore¶

plugin.tx_fsmediagallery.settings.album.pagination.pagesBefore = positive integer or 0

Number of page links before the current page.

pagination.pagesAfter¶

plugin.tx_fsmediagallery.settings.album.pagination.pagesAfter = positive integer or 0

Number of page links after the current page.

pagination.maximumNumberOfLinks¶

plugin.tx_fsmediagallery.settings.album.pagination.maximumNumberOfLinks = positive integer

Force this number of page browser links on the screen. An odd number is recommended because it looks more symmetrical.

Properties for detail view ¶

The following table describes the settings for the detail view. They are set by plugin.tx_fsmediagallery.settings.detail.<property>

Property	Data type	stdWrap	Default
asset.width	pixels	no	`1920`
asset.height	pixels	no	`1080`
asset.resizeMode	string `[m\|c\|s]`	no	`m`

Property details¶

asset.width¶

plugin.tx_fsmediagallery.settings.detail.asset.width = pixels

Height of media asset in detail view.

asset.height¶

plugin.tx_fsmediagallery.settings.detail.asset.height = pixels

Width of media asset in detail view.

asset.resizeMode¶

plugin.tx_fsmediagallery.settings.detail.asset.resizeMode = string [m|c|s]

Defines how media assets in detail view are scaled.
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.
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.
s = squeeze (unproportional exact fit); the proportions will not be preserved and the image will be unproportional scaled.

Properties for random view ¶

The following table describes the settings for the random view. They are set by plugin.tx_fsmediagallery.settings.random.<property>

Property	Data type	stdWrap	Default
targetPid	page_id	no
thumb.width	pixels	no	`250`
thumb.height	pixels	no	`140`
thumb.resizeMode	string `[m\|c\|s]`	no	`m`

Property details¶

targetPid¶

plugin.tx_fsmediagallery.settings.random.targetPid = page_id

Target page a random assets should link to. Select a page on which a plugin is configured to display the full album.

thumb.width¶

plugin.tx_fsmediagallery.settings.random.thumb.width = pixels

Height of thumbnail images of random media assets.

thumb.height¶

plugin.tx_fsmediagallery.settings.random.thumb.height = pixels

Width of thumbnail images of random media assets.

thumb.resizeMode¶

plugin.tx_fsmediagallery.settings.random.thumb.resizeMode = string [m|c|s]

Defines how thumbnails of random media assets are scaled.
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.
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.
s = squeeze (unproportional exact fit); the proportions will not be preserved and the image will be unproportional scaled.

Other Properties ¶

They properties in the following table are set by plugin.tx_fsmediagallery.settings.<property>

Property	Data type	stdWrap	Default
features.skipDefaultArguments	boolean	no	`1`

Property details¶

skipDefaultArguments¶

plugin.tx_fsmediagallery.settings.features.skipDefaultArguments = boolean

Configure Extbase to skip the URI arguments for controller and action (see Skip default arguments in URIs on TYPO3 Forge).

TypoScript Reference¶

Property details¶

templateRootPaths.100¶

partialRootPaths.100¶

layoutRootPaths.100¶

Property details¶

persistence.storagePid¶

persistence.recursive¶

Property details¶

overrideFlexformSettingsIfEmpty¶

allowedAssetMimeTypes¶

mediaAlbumsUids¶

useAlbumFilterAsExclude¶

Property details¶

thumb.width¶

thumb.height¶

thumb.resizeMode¶

thumb.random¶

hideEmptyAlbums¶

skipListWhenOnlyOneAlbum¶

orderBy¶

orderDirection¶

pagination.insertAbove¶

pagination.insertBelow¶

pagination.itemsPerPage¶

pagination.pagesBefore¶

pagination.pagesAfter¶

pagination.maximumNumberOfLinks¶

Property details¶

thumb.width¶

thumb.height¶

thumb.resizeMode¶

lightbox.enable¶

lightbox.styleClass¶

lightbox.relPrefix¶

lightbox.jsPlugin¶

lightbox.asset.width¶

lightbox.asset.height¶

lightbox.asset.resizeMode¶

displayTitle¶

pagination.insertAbove¶

pagination.insertBelow¶

pagination.itemsPerPage¶

pagination.pagesBefore¶

pagination.pagesAfter¶

pagination.maximumNumberOfLinks¶

Property details¶

asset.width¶

asset.height¶

asset.resizeMode¶

Property details¶

targetPid¶

thumb.width¶

thumb.height¶

thumb.resizeMode¶

Property details¶

skipDefaultArguments¶