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.
TypoScript Reference¶
plugin.tx_yag.settings¶
This is the main section of our extension. All non-framework-specific configuration goes here.
Property: | Data type: | Description: | Default: |
---|---|---|---|
crawler | array | Settings for the YAG file crawler used for directory import. | |
accessDenied | array | Holds a controller / action pair, that defines which controller and action is called whenever access is denied for an action. Example: accessDenied {
controller = Gallery
action = list
}
This will show list action of Gallery controller, whenever access is denied.
|
|
sysImages | array | Holds an array of paths for different images used throughout the extension. | |
themes | array | Holds an array of themes. | |
extlist | array | Holds settings for pt_extlist extension. Take a look at the pt_extlist documentation for further information. | |
importer | array | Holds settings for import. | |
overwriteFlexForm | array | Use this to overwrite settings made in flexform For example to force the same theme in all instances of the plugin. overwriteFlexForm {
contextIdentifier =
contextReset =
theme =
context {
selectedPid =
selectedGalleryUid =
selectedAlbumUid =
selectedItemUid =
galleryList {
itemsPerPage =
sorting {
field =
direction =
}
}
albumList {
itemsPerPage =
sorting {
field =
direction =
}
}
itemList {
itemsPerPage =
sorting {
field =
direction =
}
linkMode =
linkTargetPageUid =
linkTargetPluginMode =
filter {
random =
}
}
}
}
|
config.tx_yag.settings.upload.multifile¶
Configuration for the multifile uploader
Property: | Data type: | Description: | Default: |
---|---|---|---|
file_size_limit | string | Size limit in Mb | 1000 |
file_upload_limit | int | 1000 | |
file_types | string | *.jpg;*.jpeg;*.JPG;*.JPEG | |
button_image_url | string | EXT:yag/Resources/Public/Icons/XPButtonUploadText_61x22.png | |
available | Int | 1 |
config.tx_yag.settings.upload.dragNDrop¶
Property: | Data type: | Description: | Default: |
---|---|---|---|
maxFiles | Int | Size Limit in Mb | 1000 |
maxFileSize | int | 1000 | |
available | Int | 1 |
config.tx_yag.settings.importer¶
Configuration for importers
Property: | Data type: | Description: | Default: |
---|---|---|---|
parseMetaData | bool | If set to 1, meta data of imported images is parsed and written to itemMeta table. | 1 |
supportedFileTypes | String | Define the supported file types. | jpg,jpeg,gif,png |
generateTagsFromMetaData | bool | If set to 1, keywords from meta data are imported as tags in corresponding table. | 1 |
generateResolutions | csv | Comma-separated list of themes for which resoluotions are created, when image is imported. | backend |
importFileMask | string | File mask (UNIX file mask like 666) which is used on UNIX systems for imported files. | 660 |
titleFormat | array | Set the title of the uploaded image autmatically from the images filename or its meta data. Example: titleFormat = TEXT titleFormat.dataWrap = {field:fileName} by {field:author} / {field:artistWebsite} Available fields are: - origFileName - the original filename of the import file - fileName - Formated filename (suffix removed) And the fields of the imported meta data: - author - copyright - artistMail - artistWebsite - description -cameraModel - lens - focalLength - shutterSpeed - aperture - flash - keywords - description - tags |
titleFormat = TEXT titleFormat.dataWrap = {field:fileName} |
:Description:Fromat | array | Example: :Description:Format = TEXT :Description:Format.dataWrap = {field:description} Fields are the same as in titleFormat |
:Description:Format = TEXT :Description:Format.dataWrap = {field:description} |
plugin.tx_yag.settings.imageProcessor¶
Property: | Data type: | Description: | Default: |
---|---|---|---|
meaningfulTempFilePrefix | integer | MeaningfulTempFilePrefix specifies the length of the chunk of the original filename which is prefixed to the temp filename | config.meaningfulTempFilePrefix |
config.tx_yag.settings.customMetaData¶
Custom meta data fields can be defined individually per TYPO3 instance. They can be edit via the backend form and displayed within your frontend theme.
Property: | Data type: | Description: | Default: |
---|---|---|---|
customMetaData | array | Define multiple meta data fields for your own purpose. customMetaData {
people {
title = People
type = string
}
}
|
plugin.tx_yag.settings.sysImages¶
Configuration for all kinds os images used for skinning.
Property: | Data type: | Description: | Default: |
---|---|---|---|
imageNotFound | Item file description | Configures a path, title and description for an item. Example: sysImages {
imageNotFound {
sourceUri = typo3conf/ext/yag/Resources/Public/Icons/imageNotFound.jpg
title = No image found.
:Description: = No image found.
}
}
Mind that the sourceUri of the image must be relative to TYPO3 root. |
plugin.tx_yag.settings.themes¶
Most of the configuration for YAG can be found in themes. We have a default theme, where you can find all the settings available in YAG. See section ‘Themes and Templates’ in the Developers’ chapter for further information on how to extend themes and write your own themes.
Property: | Data type: | Description: | Default: |
---|---|---|---|
[your_theme_name] | array | You can define your own themes here. YAG ships with a default theme and a backend theme. |
plugin.tx_yag.settings.themes.default¶
In this section, you can find the settings for the default theme which acts as basis for all other themes. Best practice for developin your own themes is to extend this theme with your own theme like that:
plugin.tx_yag.themes.[your_theme_name] < plugin.tx_yag.themes.default
plugin.tx_yag.themes.[your_theme_name] {
# … your theme specific settings
}
Property: | Data type: | Description: | Default: |
---|---|---|---|
showBreadcrumbs | bool | If set to 1, breadcrumbs are shown as navigation. | 1 |
resolutionConfigs | array | Configuration for image resolutions. You can define the resolutions of thumbnails, single images etc. here. resolutionConfigs {
thumb {
width = 150c
height = 150c
}
medium {
maxW = 800
maxH = 600
}
}
In the default theme, thumb for thumbnails and medium for medium sized images in single view are defined and used. For your own template, you can define any kind of resolutions with the name of your choice. A resolution configuration can consist of any parameter that the TYPO3 IMAGE type provides, including image manipulation via GIFBUILDER. |
|
gallery | array | Gallery specific settings of your theme. See section below | |
album | array | Album specific settings of your gallery. See section below | |
extlist | array | This section configures pt_extlist specific settings for YAG. See pt_extlist documentaiton for further information. | |
itemList | array | This section configures the list of images shown, when you click on an album. See section below for further information. | |
item | array | This section configures single view of an item. See section below for further information. | |
includeLibJS | CSV | Comma-separated list of defined librarys from wich you want to include javascript files. Defined libraries are jQuery, jQueryUi, jQueryShadowBox |
|
includeLibCSS | CSV | Comma-separated list of defined librarys from wich you want to include CSS files. Defined libraries are jQuery, jQueryUi, jQueryShadowBox |
|
includeJS | arary | Define JS files which should be included in the page header. Same schema as in page. | |
includeJS | array | Define CSS files which should be included in the page header. Same schema as in page. |
plugin.tx_yag.settings.themes.default.feed¶
plugin.tx_yag.settings.themes.default.galleryList¶
Gallery specific settings of your theme.
Property: | Data type: | Description: | Default: | ||
---|---|---|---|---|---|
columnCount | int | Number of columns used for rendering gallery overview. | 2 | ||
GalleryThumbPartial | String | Pathand filename of the gallery thumb partial. | Gallery/GalleryThumb.html | ||
pagerIdentifier | String | Pager Identifier
|
:Default:
|
||
pagerPartial | String | Path to Pagerpartial
|
Pager/Default
|
plugin.tx_yag.settings.themes.default.albumList¶
Album specific settings of your theme.
Property: | Data type: | Description: | Default: | ||
---|---|---|---|---|---|
itemsPerPage | int | Number of albums shown on album list | 12 | ||
showBreadcrumbs | bool | If set to 1, breadcrumbs are shown on album page. | 1 | ||
columnCount | int | Number of columns used for rendering album list. | 2 | ||
AlbumThumbPartial | String | Pathand filename of the album thumb partial. | Album/AlbumThumb.html | ||
pagerIdentifier | String | Pager Identifier
|
|||
pagerPartial | String | Path to Pagerpartial
|
Pager/Default |
plugin.tx_yag.settings.themes.default.extlist¶
pt_extlist specific settings of your theme. See pt_extlist documentation for further information.
plugin.tx_yag.settings.themes.default.itemList¶
Configuration of image list of your theme.
Property: | Data type: | Description: | Default: | ||
---|---|---|---|---|---|
itemsPerPage | int | Number of images shown on a single page. | 12 | ||
columnCount | int | Number of columns used to render images on image list. | 4 | ||
showTitle | bool | If set to 1, album title is shown on overview page. | 1 | ||
imageThumbPartial | path | Path to partial used to render an image in image list. This can be Extbase path (relative to EXT:yag/Resources/Private/Partials): Image/ImageThumb
or common TS resource path to set offer paths: EXT:yag/Resources/Private/Partials/Image/ImageThumb.html
|
Image/ImageThumb | ||
imageAdminThumbPartial | path | Not used at the moment. | |||
pagerPartial | path | Path to partial used to render a pager in image list. This can be Extbase path (relative to EXT:yag/Resources/Private/Partials): Pager
or common TS resource path to set offer paths: EXT:yag/Resources/Private/Partials/Pager.html
This is especially useful, if you want to add additional parameters to the links generated by the pager, as in the following example: <extlist:link.action addQueryString="true" controller="{controller}" action="{action}" arguments="{extlist:namespace.GPArray(object:'{pagerCollection}' arguments:'page:{i}')}">{pageNumber}</extlist:link.action>
|
Pager | ||
pagerIdentifier | String | Pager Identifier
|
|||
pagerPartial | String | Path to Pagerpartial
|
Pager/Default | ||
linkMode | string | Link mode [show|link] | show | ||
linkTargetPageUid | integer | The page uid of the target page | |||
linkTargetPluginMode | string | The plugin mode on the target page | Album | ||
Filter.random | Boolean | Activates the random uid filter | 0 |
plugin.tx_yag.settings.themes.default.itemList.zipDownload¶
Property: | Data type: | Description: | Default: |
---|---|---|---|
active | int | Activate / Deactivate the zip download | 0 |
fileNameFormat | array | Defines the zip file name. Currently available fields are gallery and album: fileNameFormat = TEXT fileNameFormat.dataWrap = {field:album}.zip |
{field:album}.zip |
resolution | String | Name of the resolution in which the images are packed. | original |
plugin.tx_yag.settings.themes.default.item¶
Configuration of image single view of your theme.
Property: | Data type: | Description: | Default: |
---|---|---|---|
showItemMeta | bool | If set to 1, metadata of image will be shown in single view. | 1 |
itemMetaPartial | path | Path to partial used to render image meta data (EXIF etc.). This can be Extbase path (relative to EXT:yag/Resources/Private/Partials): Image/ImageMeta
or common TS resource path to set offer paths: EXT:yag/Resources/Private/Partials/Image/ImageMeta.html
|
Image/ImageMeta |
showTitle | bool | Show the item title beneath the image | 1 |
showDescription | bool | Show the item description beneath the image | 1 |
showPager | Bool | Show the back / forward pager | 1 |
showItemMeta | bool | Show Meta information for an item (including title and description) | 1 |
showOriginalDownloadLink | bool | Show download link to original item | 1 |
pagerPartial | string | Path to pager partial | Pager/SingleItem |
itemMetaPartial | string | Path to item meta partial | Image/ImageMeta |
plugin.tx_yag.settings.themes.default.item.interaction¶
Configures optional visitor interaction services
Property: | Data type: | Description: | Default: |
---|---|---|---|
socialSharePrivacy | array | Configuration for the social share privacy widget: | |
disqus.path | string | Path to the partial | Interaction/SocialSharePrivacy |
socialSharePrivacy.show | bool | Activate the widget | 0 |
socialSharePrivacy.settings | array | info_link = http://panzi.github.com/SocialSharePrivacy/ language = en services { buffer.status = false delicious.status = false disqus.status = false mail.status = false flattr.status = false linkedin.status = false pinterest.status = false reddit.status = false stumbleupon.status = false tumblr.status = false xing.status = false facebook.status = true twitter.status = true gplus.status = true } |
|
socialSharePrivacy.path | string | Path to the partial | Interaction/SocialSharePrivacy |
disqus.show | bool | Activate the widget | 0 |
disqus.settings | array | disqus_shortname = YourDisQusName |
module.tx_yag.settings¶
Holds settings for the backend of YAG. The content of this setting is the same as plugin.tx_yag.settings.