Configuration¶
pw_teaser provides plugin settings, which can get preset by TypoScript. Settings set in plugin directly (FlexForm) will overwrite the TypoScript defaults.
Reference¶
General preferences¶
Property |
Type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
source¶
Property
source
Data type
string
Description
Defines which pages should be listed. Allowed values: thisChildren, thisChildrenRecursively, custom,
customChildren or customChildrenRecursively.
customPages¶
Property
customPages
Data type
string
Description
Comma separated list of page uids, which should get listed. In plugin this field is just visible if source got
one of the values custom, customChildren or customChildrenRecursively.
recursionDepthFrom¶
Property
recursionDepthFrom
Data type
integer
Default
0
Description
Start of recursion depth. Default is zero (0).
Just takes effect if source is thisChildrenRecursively or customChildrenRecursively.
recursionDepth¶
Property
recursionDepth
Data type
integer
Default
0
Description
Depth of recursion. Just takes effect if source is thisChildrenRecursively or customChildrenRecursively.
orderByPlugin¶
Property
orderByPlugin
Data type
boolean
Default
0
Description
Just visible if source got the value custom.
If enabled the pages will be ordered like defined in field customPages.
loadContents¶
Property
loadContents
Data type
boolean
Default
0
Description
If checked the contents (tt_content) of current page will be loaded too. This may need more performance, and should only be enabled if used.
pageMode¶
Property
pageMode
Data type
string
Default
flat
Description
Defines how found pages should be passed to fluid template. Possible values are: flat and nested.
Default is flat. If nested is chosen, subpages get filled in the attribute "childPages" recursively
instead of passing a flat array.
In this case the options recursionDepthFrom, orderBy and limit will be ignored.
The option nested is not available for source custom.
Visibility options¶
Property |
Type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
orderBy¶
Property
orderBy
Data type
string
Description
Results may get ordered by: title, sorting, crdate, tstamp, starttime, endtime,
newUntil, random or customField.
orderByCustomField¶
Property
orderByCustomField
Data type
string
Description
If orderBy got value customField, this field defines the name of the custom field to order by.
This is useful if you have extended the pages table with new columns.
orderDirection¶
Property
orderDirection
Data type
string
Default
asc
Description
Controls the direction of ordering. May be: asc or desc. Has no effect when orderBy is random.
limit¶
Property
limit
Data type
integer
Default
0
Description
Amount of pages which should be displayed. First the ordering takes effect, then it will be limited. When zero (0), limitation is disabled.
hideCurrentPage¶
Property
hideCurrentPage
Data type
boolean
Default
1
Description
If enabled the current page will be removed from result. This has no effect, if the current page is no part of results anyway.
showDoktypes¶
Property
showDoktypes
Data type
string
Default
1,2
Description
Comma separated list of doktype to display.
ignoreUids¶
Property
ignoreUids
Data type
string
Description
Comma separated list of page uids which should be ignored, always.
categoriesList¶
Property
categoriesList
Data type
string
Description
Comma separated list of sys_category uids, which are selected.
categoryMode¶
Property
categoryMode
Data type
integer
Description
Mode to influence showed pages by selected categories (categoriesList). Available modes are:
1- Show pages with selected categories (OR)2- Show pages with selected categories (AND)3- Do NOT show pages witch selected categories (OR)4- Do NOT show pages witch selected categories (AND)
Template view¶
See Templates for further details.
Property |
Type |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
templateType¶
Property
templateType
Data type
string
Default
preset
Description
Defines the type of templating. The following types are supported:
preset(default)filedirectory
templatePreset¶
Property
templatePreset
Data type
string
Description
Only available when templateType is set to preset.
Name of preset to use. The given preset name must be configured in TypoScript setup.
templateRootFile¶
Property
templateRootFile
Data type
string
Description
Only available when templateType is set to file.
Full path (relative to TYPO3 root) to Fluid template file (incl. filename).
templateRootPath¶
Property
templateRootPath
Data type
string
Description
Only available when templateType is set to directory.
Path to Fluid template directory, which contains the folder "Teaser", which contains the "Index.html" file.
In this template mode, the directory contents must match Controller/Actions of pw_teaser.
partialRootPath¶
Property
partialRootPath
Data type
string
Description
Set an additional root path for partials, added after pw_teaser partial root path.
In TypoScript you can also use partialRootPaths and define several partial paths. This setting is only used,
when partialRootPaths (from TypoScript) is empty.
layoutRootPath¶
Property
layoutRootPath
Data type
string
Description
See partialRootPath for details. Same rules apply for this option.