Help:RSS format

From semantic-mediawiki.org

Jump to: navigation, search

The result format rss is used to produce links to RSS feeds. It is a special format for data export as explained in Help:Inline queries, and therefore properties must use known labels to specify how the wiki data relates to the vCard format.

Contents

Example

The following corresponds to the RSS feed given on the main page:

{{#ask: [[News date::+]] [[language code::en]] |
 sort=news date|
 order=descending|
 format=rss|
 searchlabel= RSS|
 rsstitle=Semantic MediaWiki|
 rssdescription=Latest news from semantic-mediawiki.org
}}

This produces the following output:

RSS

Parameters

The RSS format introduces the following additional parameters:

  • rsstitle: the text to be used as the title of the feed
  • rssdescription: the text to be used as the description of the feed

Both of these are optional. If the query used to generate the RSS feed is just a single concept, then the concept page title and concept description (if any) are taken as the default for the above, if no other values are given. This way, one can create shorter URLs that do not have to contain a long description text.

Data fields

Properties in printout statements should use one of the following labels, or otherwise are ignored in the resulting vCard. The available fields are:

  • date: the date of an element of the feed, must be a date,
  • creator: the person who created the news item (type arbitrary, but page would be common).

The default for the above, if not specified, is the page modification date and the name of the last editor in the wiki.

Remarks

RSS feeds work very well on most RSS tools, and can even be used as dynamic bookmarks in Firefox. MS Outlook is reported to have some problems with very long URLs, and it is useful to use concepts as described above to make shorter URLs.

RSS feeds may or may not include the full text of the exported articles. This is a global setting that the administrator of a wiki can specify. If the whole text is included, the MediaWiki tag <noinclude> can be used to limit the amount of text that appears in the RSS feed.

This documentation page applies to all SMW versions from 1.1 to the most current version.
     

Help:RSS format en 1.1

Personal tools