Help:RSS format

RSS format
What:
Print links to RSS feeds for query results.
Provided by:
Semantic MediaWiki
Added in version:
1.1.0
Removed in version:
still supported
Further Requirements:
none
Format name:
rss
Authors:
Denny Vrandecic, Markus Krötzsch
Categories:
export, xml

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 1 Parameters 2 Example 3 Data fields 4 Remarks

Parameters

Parameter	Type	Default	Description
limit	Whole number	20	The maximum number of results to return
offset	Whole number	0	The offset of the first result
headers	Text	show	Display the headers/property names
mainlabel	Text	no	The label to give to the main page name
link	Text	all	Show values as links
searchlabel	Text	no	The text for the link to results
title	Text	required	The text to be used as the title of the feed
title	Text	required	The text to be used as the description of the feed

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.

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

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.