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.
For administrators¶
Installation¶
- Import from TER.
- Include the static template.
Configuration¶
Use the Constant Editor to set some default values or TypoScript, if the plugin is inserted directly in the TypoScript Setup.
Properties¶
| Property | Title | Type |
|---|---|---|
| outputType | View | string |
| webmaster | Name of webmaster contact | string |
| pidList | Storage PIDs | list |
| recursive | Use recursion with pidList | boolean |
| hideSingle | Hide single list field | boolean |
| formLayout | Form layout | string |
| layoutRootPath | Path to layouts | string |
| partialRootPath | Path to partials | string |
| templateRootPath | Path to templates | string |
outputType¶
Property
outputType
Data type
string
Description
Selects the view. Allowed values:
- form Shows the subscription form.
- list Shows a list of all available mailing lists including descriptions.
Default
form
webmaster¶
Property
webmaster
Data type
string
Description
Name of webmaster contact. Used in error message if the request mail to the list server can not be send. Linked automatically if this is an email address.
plugin.tx_ghlistsubscribe_pi1.webmaster = webmaster@example.com
Default
webmaster
pidList¶
Property
pidList
Data type
string
Description
Comma separated list of page ids containing the mailin list records. Defaults to current page if empty. Can be overriden in the plugin's flexform.
Default
empty
recursive¶
Property
recursive
Data type
boolean
Description
Use recursion with pidList. Can be overriden in the plugin's flexform.
Default
0
hideSingle¶
Property
hideSingle
Data type
boolean
Description
Hide list selection field if there is only one list. Can be overriden in the plugin's flexform.
Default
1
formLayout¶
Property
formLayout
Data type
string
Description
Layout for the form view. Allowed values:
- default Standard form with labels and all fields available
- small Minimized form without labels and name field
Can be overriden in the plugin's flexform.
Default
default
layoutRootPath¶
Property
layoutRootPath
Data type
file path
Description
Sets a specific layout path. Files in this directory override files of the same name in the extension's layout directory.
Default
EXT:gh_listsubscribe/Resources/Private/Layouts
partialRootPath¶
Property
partialRootPath
Data type
file path
Description
Sets a specific partial path. Files in this directory override files of the same name in the extension's partial directory.
Default
EXT:gh_listsubscribe/Resources/Private/Partials
templateRootPath¶
Property
templateRootPath
Data type
file path
Description
Sets a specific template path. Files in this directory override files of the same name in the extension's template directory.
Warning
With TYPO3 CMS 6.2, the FLUIDTEMPLATE object has no templateRootPaths property.Therefore this property is mapped to the template.file property.
For templateRootPath to work correctly with TYPO3 CMS 6.2, you have to copy all files from the extension's template directory to the new location even if you do not intend to edit all of them.
Default
EXT:gh_listsubscribe/Resources/Private/Templates