Login / Status
developer.Resource
Home . Documentation . Document Library . Extension Manuals
Sponsors
hosted by punkt.deTYPO3 and Open Source Magazine

6.7. Modifications Using TypoScript

Virtually every aspect of the SMS extension can be modified using TypoScript. The tx_wecsermons_<data_name> configurations represent the data that is stored within the Sermon Management System. Modifying these configurations allows precise control over the Frontend display of literally every piece of data.

Internet Link: See the TypoScript Reference Manual (TSRef) for the specifics of TypoScript commands. http://typo3.org/documentation/document-library/references/.

Each of the configurations is available for each of the LIST, SINGLE, and LATEST views, and are accessed through the following configuration scopes:

Configuration Scope:

Associated View:

plugin.tx_wecsermons_pi1.singleView

SINGLE, PREVIOUS, or CURRENT

plugin.tx_wecsermons_pi1.listView

LIST

plugin.tx_wecsermons_pi1.latestView

LATEST

plugin.tx_wecsermons_pi1.searchView

SEARCH

This convention allows you to configure any data field independent of any individual view.

Resource_types TypoScript Reference

The CASE object resource_types is used to render custom SMS Resource Types.

Property:

Data Type:

Description:

Default Value:

key

string /stdWrap

'key'  is used much like the 'switch' statement in a programming 'case' control structure. The value of key determines which array item will be rendered in the CASE cObject.

type

default

->COA

The 'default' resource type, that can be chosen from the drop down of a resource Backend record.

COA ...

MP3

->COA

The MP3 resource type

COA ...

PDF

->COA

The PDF resource type

COA ...

News

->COA

The News Resource, of 'plugin' resource type

COA ...

[plugin.tx_wecsermons_pi1.resource_types]

Example tx_wecsermons_* Properties

Let's say that in the Single View the sermon graphic is too small for your needs. Because you upload a high quality graphic for each sermon, you want it to be displayed at a larger scale.

The default size for sermon graphics in the Single View is a maximum of 128px height by 128px width. You want the sermon graphics to render at 320px by 240px.

In TypoScript, this is configured at

plugin.tx_wecsermons_pi1.singleView.tx_wecsermons_sermons.graphic.file.width

For the example here, we will step you through modifying this value using the TypoScript Object Browser.

To configure the width of the SMS Single View graphics:

  1. Illustration 77: Opening the TypoScript Object Browser

    Refer to Illustration 77. Using the Template Module (1), click on the page where the SMS Static Template is installed on your site—typically either the Root Page (Home) or the Sermons page (2).

  2. In the upper right drop-down box, select the TypoScript Object Browser (3).

  3. Illustration 78: Expanding the TypoScript Object Tree

    Set the OBJECT TREE: selections to Browse: Setup (4), and OL: ALL (5), click the [+] icon next to the tree labeled [plugin] to expand that tree (6).

  4. Refer to Illustration 78. Scroll down the page, and click the [+] icon for the tree labeled [tx_wecsermons_pi1] (7)to expand that page.

  5. Expand the tree labeled [singleView] (8).

  6. Expand the tree labeled [tx_wecsermons_sermons] (9).

  7. Expand the tree labeled [graphic] (10).

  8. Expand the tree labeled [file] (11).

  9. Finally, click on the word [width] (12). This will reload the frame that will allow you to edit the configuration value for the width (Illustration 78).

  10. Illustration 79: Editing the Object/Property Value

    Refer to Illustration 79. Set the value to the desired width (13). In our example, change the 128 to 240m.

    Tip: Appending the letter m to either the width or height value allows TYPO3 to compress an image to the maximum value, but will not expand an undersized graphic to the maximum size. This minimizes unnecessary pixilization.

  11. Click the Update button (14) to save the new value.

  12. Repeat steps 9–11 for changing the height value to 320 by clicking on [height] in the TypoScript Object Tree.

Reference to  tx_wecsermons_*

tx_wecsermons_sermons

Property:

Data Type:

Description

Default Value:

title

->TEXT

Title of the sermon

subtitle

->TEXT

Subtitle of the sermon

occurrence_date

->TEXT

Date the sermon occurred on

description

->TEXT

Description of the sermon

scripture

->TEXT

Scripture reference associated with the sermon

graphic

->IMAGE

Graphic of the sermon

alttitle

->TEXT

Alternate text and title attribute for sermon graphic

topics

->stdWrap

Wrap for the topics subpart

speakers

->stdWrap

Wrap for the speakers subpart

series

->stdWrap

Wrap for the series subpart.

[plugin.tx_wecsermons_pi1.<viewname>.tx_wecsermons_sermons]

tx_wecsermons_series

Property:

Data Type:

Description

Default Value:

title

->TEXT

Title of the series

subtitle

->TEXT

Subtitle of the series

graphic

->IMAGE

Graphic of the series

alttitle

->TEXT

Alternate text and title attribute for series graphic

description

->TEXT

Description of the series

scripture

->TEXT

Scripture reference associated with the series

startdate

->TEXT

Date the series began

enddate

->TEXT

Date the series ended

season

->stdWrap

Wrap for the season subpart

topics

->stdWrap

Wrap for the topics subpart

[plugin.tx_wecsermons_pi1.<viewname>.tx_wecsermons_series]

tx_wecsermons_resources

Property:

Data Type:

Description

Default Value:

title

->TEXT

Title of the resource

file

->TEXT

File attachment associated with this resource

graphic

->IMAGE

Graphic associated with this resource

alttitle

->TEXT

Alternate text and title attribute for resource graphic

description

->TEXT

Description of the resource

webaddress1

->TEXT

A web address (URL) used with this resource.

webaddress2

->TEXT

A web address (URL) used with this resource.

webaddress3

->TEXT

A web address (URL) used with this resource.

resource_types

(config)

This is a property that further configures how links will be rendered for resource types. For example, a resource of type 'PDF' will render a link to the single view of that resource, rather than to the actual file attachment embedded within the resource.

Example:

# resource_types properties define whether to render the ###RESOURCE_LINK### tag as a link to the resources' single view, or by a typolink configuration defined here.

resource_types {

        # If typolink = 0, then link to the single view of a resource.

        # If typolink = 1, then use this typolink configuration to link to the first file stored in resource file field.

        

        # Type PDF

        PDF.typolink = 1
        PDF.typolink {
                parameter = uploads/tx_wecsermons/{current:1}
                parameter.setCurrent.field = file
                parameter.setCurrent.listNum = 0
                parameter.insertData = 1
                extTarget = _blank
        }

}

[plugin.tx_wecsermons_pi1.<viewname>.tx_wecsermons_resources]

tx_wecsermons_speakers

Property:

Data Type:

Description

Default Value:

fullname

->TEXT

Full name of the speaker

firstname

->TEXT

First name of the speaker

lastname

->TEXT

Last name of the speaker

photo

->IMAGE

Photograph of the speaker

alttitle

->TEXT

Alternate text and title attribute for speaker photo

url

->TEXT

Home Page or web address (URL) with a description of the speaker

email

->TEXT

E-mail address of the speaker. (Will automatically be transformed to a spam protected link on the Frontend.)

[plugin.tx_wecsermons_pi1.<viewname>.tx_wecsermons_speakers]

tx_wecsermons_topics

Property:

Data Type:

Description

Default Value:

title

->TEXT

Title of the topic

description

->TEXT

Description of the topic

[plugin.tx_wecsermons_pi1.<viewname>.tx_wecsermons_topics]

tx_wecsermons_seasons

Property:

Data Type:

Description

Default Value:

title

->TEXT

Title of season

description

->TEXT

Description of season

[plugin.tx_wecsermons_pi1.<viewname>.tx_wecsermons_seasons]