Adding a New Plugin Resource Type

TypoScript Reference

Adding XML Feeds

Note:  Configuration of the XML feeds requires knowledge of TypoScript. For help with inserting TypoScript into your template record, see the Step 3: Create a New TypoScript Object section of this document.

The Sermon Management System supports two XML feeds, podcast and vodcast feeds, with little configuration out of the box.  Podcast feeds are used to distribute audio, typically MP3 files, to subscribers of the feed. Vodcast feeds are used to distribute videos, typically in the MP4 format, to subscribers.

Tip: If the words XML, feeds, podcast, or vodcast are sounding foreign and mystical, you may first research these through the Google search engine and Wikipedia.org before working with this ability of the SMS.

The XML feeds are enabled upon installing the SMS extension. To take a look at the podcast feed, perform the following: 

Illustration : Preview the Sermon Plugin Page

1. Refer to Illustration 67. Log into the Backend of your site, and preview the page where the SMS plugin is configured (1).

1. 
   Illustration : Change the Web Address of the Pop-up Preview Page

   Refer to Illustration 68. In the web address (URL) box of the new browser window that opens, append to the end of the URL &type=222, and press enter (2). You should see an XML feed as shown in Illustration 68.

Tip: If you do not see the XML feed results, review Step 3: Add the SMS Static Template section to make sure the SMS static template is enabled properly.

You may notice that the feed is enabled but not fully configured yet. To configure the feed, we need to add a static template from the WEC API extension and include a few lines of TypoScript in the SETUP field of thee template. 

Technical Stuff: The podcast feed uses &type=222, while the vodcast feed uses &type=223. Appending these to the end of your page URL enables the display of these feeds.

Configuration of the XML Feeds

1. 
   Illustration : Edit the Template Record

   Refer to Illustration 69. Click on the Template module (1).

2. Click on the Page where the template record for the SMS plugin is stored (2).

3. Change the drop down to Info/Modify (3).

4. Click the link Click here to edit the whole template record (4).

1. 
   Illustration : Add the WEC iTunes Compatible Feed to Include Static:

   Refer to Illustration 70. Scroll down to the Include static (from extensions) field. Scroll the Items: listbox to WEC iTunes Compatible Feed. (5)

2. Highlight the WEC iTunes Compatible Feed entry in the Selected: listbox, and click the Move Up button to move the entry to the top of the list. (6)

3. Scroll back up to click the Save & Close button (7)

1.  

    

2. 
   Illustration : Edit the Setup Field

   Refer to Illustration 71. Click the Edit pencil icon to the left of the Setup: text to edit the setup field. (8)

1. 
   Illustration : Insert the TypoScript to Enable the XML Feeds

   Refer to Illustration 72. Insert the code into the SETUP: field to enable the XML Feeds. (See Text 4 below for detailed code.) (9)

2. Click the Update button (10)

Caution: The TypoScript code shown in Text 3 always needs to be the very last code in your template's setup field! This is due to TypoScript being executed in order from top to bottom. Any TypoScript configuration you place after the above code, will not be in the podcast or vodcast feeds and could affect the output!

podcast.10 < plugin.tx_wecsermons_pi1

podcast.10 {

  CMD = XML

  xmlView.enclosureType = embedded_mp3

}

vodcast.10 < podcast.10

vodcast.10.xmlView.enclosureType = embedded_mp4

Text : TypoScript to Enable XML Feeds

Line 1: Assign the podcast.10 cObject to be a copy of the SMS plugin, configured at plugin.tx_wecsermons_pi1.

Line 3: Assign the CMD property, aka What to Display in the WEC Sermon Management System plugin, the value XML. This configures this instance of the SMS plugin to output an XML feed.

Line 4: Assign the xmlView.enclosureType property the TypoScript Object Name of the Embedded Media (MP3) SMS Resource Type – embedded_mp3. This configures the SMS plugin to include any mp3 SMS Resoures in the XML feed enclosure tag.

Internet Link: For information on enclosure tags, see the RSS 2.0 specification.

Line 7: Copy the podcast.10 cObject over the vodcast.10 cObject. 

Line 8: Assign the xmlView.enclosureType property the value of embedded_mp4. This configures the SMS plugin to include any mp4 SMS Resources in the XML feed enclosure tag.

Tip: For the curious, the originating code for the podcast and vodcast objects can be viewed in the WEC SMS static template using the Template Analyzer available in the Template module.

Tip: If you wish to include other resource types than mp3 or mp4 resources, you simply need to assign the xmlView.enclosureType property the TypoScript Object Name of the SMS Resource Type you wish to use.

Additional Customization of the XML Feeds

You can use the Constant Editor to customize the XML feeds under the PLUGIN.TX_WECAPI_LIST category as shown in Illustration 73.

Illustration : Configuring the XML Feed Using the Constant Editor

The SMS Extension takes advantage of another extension called WEC API (installed earlier). The WEC API extension includes a wecapi_list module which renders the SMS XML Feeds.

Tip: For help with using the Constant Editor see the Modifications Using the Constant Editor section of this document.

Adding a New Plugin Resource Type

TypoScript Reference

18 / 30