Help:RSS format

From semantic-mediawiki.org
Jump to: navigation, search


This documentation page applies to all SMW versions from 1.1.0 to 1.7.1.
      Other languages: dezh-hans

Help:RSS format en 1.1.0 1.7.1



RSS format
Print links to RSS feeds for query results.
Further Information
Provided by: Semantic MediaWiki
Added: 1.1.0
Removed: 1.7.1
Requirements: none
Format name: rss
Enabled by default: Indicates whether the result format is enabled by default upon installation of the respective extension. yes
Authors: Denny Vrandecic, Markus Krötzsch
Categories: export · xml
Group:
Table of Contents

↓ INFO ↓

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 RSS format.

Note: This format was superseded by the result format feed available starting with SMW 1.8.0 which supports the export of RSS and Atom feeds equally. Legacy support for queries using the old format name "rss" is provided. However, it is recommended to switch to the new syntax.

Parameters

General

Fatal error: Value not in whitelist


Format specific

Fatal error: Value not in whitelist


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
| title=Semantic MediaWiki
| description=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 RSS feed. 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.