Newsagent/Syndicate
| Newsagent | |
| |
| Author | Chris Page |
|---|---|
| Contact | Support |
| Repository | github |
| Issue tracker | github |
| OS | Neutral (web based) Will not work with IE8 or older |
| URL | Newsagent |
| Navigation | |
| |
As stated in the Feeds and Visibility documentation, all articles created in Newsagent must go into a feed with at one visibility level set for each article. Feeds must then be requested by any client - website, feed reader or aggregator, and so on - that is interested in the articles, and each client may specify which level of article they are interested in seeing in the feed.
Feeds are exposed by the system in two formats:
- a 'HTML fragment' format suitable for directly embedding in pages, with css classes set on most elements to allow for styling to match the page the content is embedded in. This format is not supported for general use.
- RSS 2.0 formatted feeds compatible with most feed readers and aggregators. This is the recommended format for fetching feeds from the system.
Available feeds
 |
As briefly noted in Issue #5, a feed list page is a planned enhancement to Newsagent. That will simplify the process of obtaining feed URLs from the system. |
The following feeds are currently published by the system. The URL given in the table below will include the 10 most recent articles at all visibility levels in the feed, to filter the feed so that only certain visibility levels are included, see the Feed options section below.
Feed options
The RSS generator script supports a number of options that allow you to control the articles included in the feed. The most important option is the feed option:
feed=<comma separated list of feeds>- The
feedoption allows you to specify which Newsagent feed or feeds you are interested in fetching articles from. This can either be a single Newsagent feed name, as shown in the table above, or you can request articles in multiple Newsagent feeds by separating the names with commas, eg:feed=pgt,pgr,ugtwill give you the articles published in the Study - PGT, Study - PGR, or Study - UGT Newsagent feeds. If you do not specify a feed at all, the system will give you articles published in all Newsagent feeds.
If you just ask for a Newsagent feed, you will get all published articles in that feed regardless of the visibility levels the author set on it. If you are only interested in a subset of articles with specific visibility levels, you should include the level option in the query:
level=<comma separated list of visibility levels>- The
leveloption allows you to select only articles that have been set to be published at the specified level(s). This can either be a single level, eg:level=homeor it can be a comma separated listlevels=home,leader. Valid levels are currentlyhome(Important (School Home Page)),leader(Medium (Section Leader Page)), andgroup(General (Group or Internal pages)). Omitting this option is equivalent tolevels=home,leader,group(ie: select all levels).https://newsagent.cs.manchester.ac.uk/rss?feed=pgt,pgr&level=leader,groupwill produce a feed containing articles published in the PGT or PGR feeds at the Medium or General levels.
| |||||||||||||||||