DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
v1.0.0 - 2014/12/07¶
This is a major upgrade introducing lots of new features. Read and follow the section Upgrade procedure carefully!
Important changes¶
A lot of code changed in this version. Therefore it is very likely that the update is not done in only one minute. The most important changes are:
gallery
was renamed toalbum
in most placesimage
was renamed tomedia asset
in most places- TypoScript paths and values have been reordered and renamed and some new features were added (see TypoScript changes)
- Empty flexform field can be overwritten by TypoScript (see settings.overrideFlexformSettingsIfEmpty)
- Plugin flexform has changed a lot (todo: upgrade script);
new Display Modes (
switchableControllerActions
)nestedList
(former default action),flatList
,showAlbum
andshowAlbumByConfig
- Display Modes (
switchableControllerActions
) can be removed in plugin via Extension Manager (seeClasses/Hooks/ItemProcFuncHook.php
) - New option
resizeMode
for media assets and thumbnail images for all display modes - Sort order of albums lists can be set in plugin and via TS (settings.list.orderBy, settings.list.orderDirection)
- Default media asset dimensions orient on 1080i (widescreen aspect ratio of 16:9)
- Translation key have been reordered and renamed
- Field “Date” was added to FAL file collections (adds field
datetime
to database tablesys_file_collection
) - Field “Parent” was set as exclude field so you need to enable this (BeUser/BeGroup settings) for you editors if used (table
sys_file_collection
) - EXT:fs_media_gallery now integrates into EXT:news (alters database table
tx_news_domain_model_news
, adds tabletx_news_domain_model_news_fsmediaalbums_mm
)
Upgrade procedure¶
todo: further describe upgrade procedure
Database Update¶
This version adds and alters database tables. If you’re updating EXT:fs_media_gallery by git you have to de-install and re-install the extension to apply these changes. This can be either done in Extension Manager or from command line:
cd /your/path/to/typo3root/
./typo3/cli_dispatch.phpsh extbase extension:uninstall fs_media_gallery
./typo3/cli_dispatch.phpsh extbase extension:install fs_media_gallery
Migrate existing plugins¶
Because of the renaming of multiple values the existing plugins need to be updated. The extensions comes with a upgrade script than helps you with this.
Go to the extension manager and search for ext:fs_media_gallery. Click on the “Execute update script” button in the Actions column.
Migrate your Fluid templates¶
Your Fluid templates will most likely require updates.
Important
New template files were added and some files have been renamed and moved to different locations. If you experience any problems with your templates, please have a look on the default templates shipped with the extension.
Following template files have been renamed, moved or were added:
Template file in 0.0.6 | Alteration | Template file in 1.0.0 |
---|---|---|
Partials/MediaAlbum/ListAlbums.html | moved, renamed | Partials/MediaAlbum/NestedList/AlbumsList.html |
Partials/MediaItem/Image.html | renamed | Partials/MediaItem/Detail.html |
Templates/MediaAlbum/RandomImage.html | renamed | Templates/MediaAlbum/RandomAsset.html |
Templates/MediaAlbum/Show.html | renamed | Templates/MediaAlbum/NestedList.html |
Templates/MediaAlbum/ShowImage.html | renamed | Templates/MediaAlbum/ShowAsset.html |
. | new | Partials/MediaAlbum/Lightbox.html |
. | new | Partials/MediaAlbum/FlatList/AlbumsList.html |
. | new | Partials/MediaAlbum/FlatList/AssetsList.html |
. | new | Templates/MediaAlbum/FlatList.html |
. | new | Templates/MediaAlbum/ShowAlbum.html |
. | new | Templates/MediaAlbum/ShowAsset.html |
To migrate your templates, change every occurrence of the following TypoScript values:
Search | Replace | Template files |
---|---|---|
settings.album.itemsPerPage | settings.list.pagination.itemsPerPage | Partials/MediaAlbum/ListAlbums.html |
settings.pagination.insertAbove | settings.list.pagination.insertAbove | Partials/MediaAlbum/ListAlbums.html |
settings.pagination.insertBelow | settings.list.pagination.insertBelow | Partials/MediaAlbum/ListAlbums.html |
settings.pagination.maximumNumberOfLinks | settings.list.pagination.maximumNumberOfLinks | Partials/MediaAlbum/ListAlbums.html |
settings.pagination.pagesBefore | settings.list.pagination.pagesBefore | Partials/MediaAlbum/ListAlbums.html |
settings.pagination.pagesAfter | settings.list.pagination.pagesAfter | Partials/MediaAlbum/ListAlbums.html |
settings.album.thumb.maxWidth | settings.list.thumb.width | Partials/MediaAlbum/Thumb.html |
settings.album.thumb.maxHeight | settings.list.thumb.height | Partials/MediaAlbum/Thumb.html |
settings.enableLightbox | settings.album.lightbox.enable | Partials/MediaItem/Thumb.html |
settings.image.lightbox.maxWidth | settings.album.lightbox.asset.width | Partials/MediaItem/Thumb.html, Templates/MediaAlbum/Show.html |
settings.image.lightbox.maxHeight | settings.album.lightbox.asset.height | Partials/MediaItem/Thumb.html, Templates/MediaAlbum/Show.html |
settings.image.thumb.maxWidth | settings.album.thumb.width | Partials/MediaItem/Thumb.html |
settings.image.thumb.maxHeight | settings.album.thumb.height | Partials/MediaItem/Thumb.html |
settings.galleryPid | settings.random.targetPid | Templates/MediaAlbum/RandomImage.html |
settings.random.thumb.maxHeight | settings.random.thumb.height | Templates/MediaAlbum/RandomImage.html |
settings.random.thumb.maxWidth | settings.random.thumb.width | Templates/MediaAlbum/RandomImage.html |
settings.image.itemsPerPage | settings.album.pagination.itemsPerPage | Templates/MediaAlbum/Show.html |
settings.pagination.insertAbove | settings.album.pagination.insertAbove | Templates/MediaAlbum/Show.html |
settings.pagination.insertBelow | settings.album.pagination.insertBelow | Templates/MediaAlbum/Show.html |
settings.pagination.maximumNumberOfLinks | settings.album.pagination.maximumNumberOfLinks | Templates/MediaAlbum/Show.html |
settings.pagination.pagesBefore | settings.album.pagination.pagesBefore | Templates/MediaAlbum/Show.html |
settings.pagination.pagesAfter | settings.album.pagination.pagesAfter | Templates/MediaAlbum/Show.html |
settings.image.maxWidth | settings.detail.asset.width | Templates/MediaAlbum/ShowImage.html |
settings.image.maxHeight | settings.detail.asset.height | Templates/MediaAlbum/ShowImage.html |
TypoScript changes¶
The following table lists all alterations to TypoScript.
All settings are defined by using plugin.tx_fsmediagallery.<property>
.
Property in 0.0.6 | Alteration | Property in 1.0.0 |
---|---|---|
view.templateRootPaths.100 | not changed | view.templateRootPaths.100 |
view.partialRootPaths.100 | not changed | view.partialRootPaths.100 |
view.layoutRootPaths.100 | not changed | view.layoutRootPaths.100 |
persistence.storagePid | not changed | persistence.storagePid |
. | new | persistence.recursive |
. | new | settings.overrideFlexformSettingsIfEmpty |
. | new | settings.allowedAssetMimeTypes |
settings.mediagalleries | renamed | settings.mediaAlbumsUids |
settings.useAlbumFilterAsExclude | value altered | settings.useAlbumFilterAsExclude |
settings.album.itemsPerPage | moved | settings.list.pagination.itemsPerPage |
settings.album.thumb.maxWidth | moved, renamed, value altered | settings.list.thumb.width |
settings.album.thumb.maxHeight | moved, renamed, value altered | settings.list.thumb.height |
. | new | settings.list.thumb.resizeMode |
. | new | settings.list.hideEmptyAlbums |
. | new | settings.list.orderBy |
. | new | settings.list.orderDirection |
settings.skipGalleryWhenOneAlbum | renamed, moved | settings.list.skipListWhenOnlyOneAlbum |
settings.image.itemsPerPage | moved | settings.album.pagination.itemsPerPage |
settings.image.thumb.maxWidth | moved, renamed, value altered | settings.album.thumb.width |
settings.image.thumb.maxHeight | moved, renamed, value altered | settings.album.thumb.height |
. | new | settings.album.thumb.resizeMode |
settings.enableLightbox | renamed, moved | settings.album.lightbox.enable |
. | new | settings.album.lightbox.styleClass |
. | new | settings.album.lightbox.relPrefix |
. | new | settings.album.lightbox.jsPlugin |
settings.image.lightbox.maxWidth | moved, renamed, value altered | settings.album.lightbox.asset.width |
settings.image.lightbox.maxHeight | moved, renamed, value altered | settings.album.lightbox.asset.height |
. | new | settings.album.lightbox.asset.resizeMode |
settings.image.maxWidth | moved, renamed, value altered | settings.detail.asset.width |
settings.image.maxHeight | moved, renamed, value altered | settings.detail.asset.height |
. | new | settings.detail.asset.resizeMode |
settings.galleryPid | moved, renamed | settings.random.targetPid |
settings.random.thumb.maxWidth | renamed, value altered | settings.random.thumb.width |
settings.random.thumb.maxHeight | renamed, value altered | settings.random.thumb.height |
. | new | settings.random.thumb.resizeMode |
settings.pagination.insertAbove | splitted (moved, renamed) | settings.list.pagination.insertAbove, settings.album.pagination.insertAbove |
settings.pagination.insertBelow | splitted (moved, renamed) | settings.list.pagination.insertBelow, settings.album.pagination.insertBelow |
settings.pagination.pagesBefore | splitted (moved, renamed) | settings.list.pagination.pagesBefore, settings.album.pagination.pagesBefore |
settings.pagination.pagesAfter | splitted (moved, renamed) | settings.list.pagination.pagesAfter, settings.album.pagination.pagesAfter |
settings.pagination.maximumNumberOfLinks | splitted (moved, renamed), value altered | settings.list.pagination.maximumNumberOfLinks, settings.album.pagination.maximumNumberOfLinks |
settings.features.skipDefaultArguments | no change | settings.features.skipDefaultArguments |