TypoScript is a unique method to configure the TYPO3 CMS, and ranges from simple to complex. For a simple example of how TypoScript is used and what it can do, see the section above titled Simplified TypoScript Example.
Below you will find all of the TypoScript configuration statements that are used within the SMS plugin. For help understanding TypoScript itself, look to the TYPO3 online documentation and the TypoScript Syntax and In-depth Study document.
The general settings of the WEC SMS plugin are specified in the Setup field of a template record, and begin with plugin.tx_wecsermons_pi1.
Property: | Data Type: | Description | Default Value: |
|---|---|---|---|
CMD | string | The name of the view we want displayed. AKA "What to Display" in the "WEC Sermon Management System" Frontend plugin. Valid values are: LIST LATESTSEARCH SINGLE Example: plugin.tx_wecsermons_pi1.CMD = SEARCH | |
detailTable | string | The data table from which records will be displayed by the plugin. Example: plugin.tx_wecsermons_pi1.detailTable = tx_wecsermons_series Note: SMS table names are: Sermons – tx_wecsermons_sermons Series – tx_wecsermons_series Resources – tx_wecsermons_resources Topics – tx_wecsermons_topics Seasons – tx_wecsermons_seasons Speakers - tx_wecsermons_speakers | tx_wecsermons_sermons |
groupTable | string | The data table from which records will be grouped by when generated. Example: # Group records by sermon series plugin.tx_wecsermons_pi1.detailTable = tx_wecsermons_series Note: When using this functionality, you must have a ###GROUP### subpart marker in the template you are using. | |
pidList | string | The page id (pid), or list of pids, of the folder(s) where your SMS records are stored in (also known as “Starting point”). If this value is not set, and the “Starting point” field in the news content-element is also empty, the current page is used. Value can be multiple pids comma separated, without spaces! Note: When using the XML Feed, this value must be set!! Example: # clear the pidList parameter plugin.tx_wecsermons_pi1.pidList > # display records located in page 582 & 584 plugin.tx_wecsermons_pi1.pidList = 582,584 | |
recursive | int | How many levels down the page tree to include in pidList. The page tree is traversed recursively downward, and any pages n levels down will be added to "pidList." Example: # Starting at pidList, search down the tree 3 levels deep for any other records plugin.tx_wecsermons_pi1.recursive = 3 | |
useStoragePid | boolean | Enables the plugin to search the General Storage Folder for SMS records. Example: # Do not search the General Storage Folder for SMS records plugin.tx_wecsermons_pi1.useStoragePid = 0 | 1 |
pidSingleView | int | The page id (pid) where the SMS Frontend plugin is configured for SINGLE view. This is used by the SMS when rendering links (urls) from a list of records, to a single view of a record. Example: # Use Page ID (PID) 42, where SMS plugin is configured for SINGLE plugin.tx_wecsermons_pi1.pidSingleView = 42 Note: If you are assigning a pid in the pidListView property below, you must also specify the pidSingleView property. | |
pidListView | int | The page id (pid) where the SMS Frontend plugin is configured for LIST view. This is used by the SMS when rending the "return" link from the single view of a record, back to that records list view. Example: # Use Page ID (PID) 43, where SMS plugin is configured for LIST plugin.tx_wecsermons_pi1.pidListView = 43 Note: If you are assigning a pid in the pidSingleView property above, you must also specify the pidListView property. | |
pidSearchView | int | The page id (pid) where the sermon plugin is configured with the SEARCH view. This is used by the SMS to direct the results from a search query from another page. Example: # Use Page ID (PID) 44, where SMS plugin is configured for SEARCH,LIST plugin.tx_wecsermons_pi1.pidListView = 44 | |
enableSmartDisplay | boolean | Smart Display is the ability for the plugin to switch to SINGLE display mode when it detects a request for the details of a record to be shown. When this is enabled, you do not explicitly need a separate page set up to display SINGLE views. In some cases you may wish to disable this feature. Example: plugin.tx_wecsermons_pi1.enableSmartDisplay = 0 | 1 |
allowCaching | boolean | Specifies whether the plugin generates links to cached or non-cached pages. Example: plugin.tx_wecsermons_pi1.allowCaching = 0 Note: Be absolutely sure you have a business need to disable caching, as it can adversely affect performance! | 1 |
general_dateWrap | ->stdWrap | The general formatting of any date displayed by the SMS plugin. This will be used if no stdWrap is directly specified for a records date field. Example: plugin.tx_wecsermons_pi1.general_dateWrap = %A, %m. %d %Y | %A, %b. %d %Y |
templateFile | resource | The HTML template file where all marker-based templates are contained. These define each layout of the plugin, and resource layouts. Example: plugin.tx_wecsermons_pi1.templateFile = fileadmin/templates/sermons.html | EXT:wec_sermons/pi1/wecsermons.tmpl |
allowedTables | string | A comma separated list of table names this extension is allowed to show data from. Example: plugin.tx_wecsermons_pi1.allowedTables = tx_wecsermons_sermons, tx_wecsermons_series, tx_wecsermons_resources, tx_wecsermons_topics, tx_wecsermons_seasons, tx_wecsermons_speakers, tx_wecsermons_resources | tx_wecsermons_sermons, tx_wecsermons_series, tx_wecsermons_resources, tx_wecsermons_topics, tx_wecsermons_seasons, tx_wecsermons_speakers, tx_wecsermons_resources |
defaultMarker | string | The name of the marker used in list views to lay out resources of 'default' type. Example: plugin.tx_wecsermons_pi1.defaultMarker = ###MY_SUBPART_NAME### | ###DEFAULT_RESOURCES### |
defaultTemplate | string | the name of the template used to lay out single views of resources of 'default' type. Example: plugin.tx_wecsermons_pi1.defaultMarker = ###MY_TEMPLATE_NAME### | ###TEMPLATE_DEFAULT_RESOURCES### |
resource_types | ->CASE | The resource_types CASE provides rendering for custom SMS Resource Types. See Create a New TypoScript Object for additional details. Example: plugin.tx_wecsermons_pi1.resource_types {pdf = COA pdf {} } |
[plugin.tx_wecsermons_pi1]