Syntax Rules

source of RSS feed; this can be an url (starting with http) or a web.topic location for internal feeds

None; is required

href="..."

(Alternative to above)

N/A

refresh="60"

Refresh rate in minutes for caching feed; "0" for no caching

Global REFRESH setting

limit="12"

Maximum number of items shown

Global LIMIT setting

touch="..."

Touch (edit/save) topics if the feed has updates. Specify a comma-space delimited list of TopicNames or Web.TopicNames, such as "%TOPIC%, NewsLetter". Useful to send out newsletter using MailerContrib, showing new feeds since last newsletter. To update feeds, visit topics with feeds in regular intervals (using cron with wget or the like).

The header and format parameters might also use variables rendering the dc, image and content namespace information. Note, that only bits of interest have been implemented so far and those namespaces might not be implemented fully yet.

Rendering the dc namespace

The following variables are extracting the dc namespace info, that could be used in header and format. Nnote, that some of the variables are already used above. This is done by purpose to use different feeds with the same formating parameters. If there's a conflict the non-dc tags have higher precedence, i.e. a <title> content </title> is prefered over <dc:title> content </dc:title> .

$title: channel/article title (dc:title)

$creator: channel creator (dc:creator)

$subject: subject text; this will also add an image according to the subject hash list, see above (dc:subject)

$description: ... (dc:description)

$publisher: the channel/article publisher (dc:publisher)

$contributor: ... (dc:contributor)

$date: ... (dc:date)

$type: ... (dc:type)

$format: ... (dc:format)

$identifier: ... (dc:identifier)

$source: ... (dc:source)

$language: ... (dc:language)

$relation: ... (dc:relation)

$coverage: ... (dc: coverage)

$rights: ... (dc: rights)

Rendering the image namespace

An image:item is converted into an <img> tag using the following mappings:

src: image url (rdf:about attribute of the image.item tag)

alt: image title (title)

width: image width (image:width)

height: image height image:height)

Rendering the content namespace

The variable $content is refering to the <content:encoding> content </content:encoding>.

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, for example, %HEADLINESPLUGIN_SHORTDESCRIPTION%. Note: Don't modify the settings here; copy and customize the settings in Main.TWikiPreferences. For example, to customize the USERAGENTNAME setting, create a HEADLINESPLUGIN_USERAGENTNAME setting in Main.TWikiPreferences.