Setup Stephen Ostermiller's RSS Reader

After you have installed the RSS reader, you will want to configure the feeds that it fetches..

.page.xml XML File

The rss is customized by adding pages or rss feeds. Each page can have many rss feeds arranged in columns. New pages can be added by adding a new .page.xml file in the rssreader directory.

The basic page xml with just one feed in one column looks like this:

<page>
 <column>
  <feed url="/setup.rss"/>
 </column>
</page>

More columns, feeds, or groups of feeds can be added. A group of feeds will mix the items in the feeds together.

<page>
 <column>
  <feed url="/setup.rss"/>
  <feed url="/a.rss"/>
 </column>
 <column>
  <group>
    <feed url="/b.rss"/>
    <feed url="/c.rss"/>
  </group>
 </column>
</page>

Attributes

Many attributes can be added to change how a rss feed displays.

url -- Specify the url from which the RSS feed can be downloaded. This is the only required attribute
values: An rss url, A url starting with a slash for a rss feed that resides in the rssreader directory
```
<feed url="http://example.com/feed.rss" />
```
feedTitle -- Title for a feed that overrides the title from the rss feed itself. If specified, this feed title is also shown in place of the url when downloading the feed.
values: a title
```
<feed url="http://example.com/feed.rss" feedTitle="My Title" />
```
cacheMinutes -- The number of minutes an rss feed will be cached locally before it is downloaded again.
values: Number of minutes (integer)
```
<feed url="http://example.com/feed.rss" cacheMinutes="10" />
```
sort -- sort a feed or a group. Sorting can be done by the items published date or by their rating.
values: date, rating
```
<group sort="date"><feed url="http://example.com/feed.rss" sort="date" /></group>
```
itemCount -- limit the number of items in a feed or a group.
values: Number of items (integer)
```
<group itemCount="10"><feed url="http://example.com/feed.rss" itemCount="5" /></group>
```
groupName -- Specify the heading at the top of a group of feeds. If unspecified, each of the feeds headings will be shown.
values: A name
```
<group groupName="new name" /><feed ...
```
groupDescription -- Specify the text under the title for a mixed group of feeds. Only takes effect if the groupName is also specified.
values: A description
```
<group groupName="new name" groupDescription="new description"/><feed ...
```
groupLink -- Specify the url that the group name is linked to. Only takes effect if the groupName is also specified.
values: url
```
<group groupName="new name" groupLink="http://example.com/"/><feed ...
```
allowFormatting -- Controls whether formatting (paragraphs, bold, italic, etc) from the feed are shown. By default these are not shown. Can be specified on a feed or group.
values: true, false
```
<feed url="http://example.com/feed.rss" allowFormatting="true" />
```
allowLinks -- Controls whether links in the feed item descriptions are shown. By default these are not shown. Can be specified on a feed or group.
values: true, false
```
<feed url="http://example.com/feed.rss" allowLinks="true" />
```
allowImages -- Controls whether images from the feed description are shown. By default these are not shown. Can be specified on a feed or group.
values: true, false
```
<feed url="http://example.com/feed.rss" allowImages="true" />
```
showTitle -- Whether or not to show the feed title. By default the feed title is shown.
values: true, false
```
<feed url="http://example.com/feed.rss" showTitle="false" />
```
addDiscussLink -- Add the item link as discussion link at the bottom of the item description. Most useful if the title is not shown, and the link is still desired.
values: true, false
```
<feed url="http://example.com/feed.rss" showTitle="false" addDiscussLink="true" />
```
urlInDescription -- Use the first url from a link in the descrition rather than the one supplied as thet item link. If desired, the original link can be added as a discuss link.
values: true, false
```
<feed url="http://example.com/feed.rss" urlInDescription="true" addDiscussLink="true"/>
```
showSource -- Whether or not to put the feed link in each item. This is most useful if the feeds are in a mixed group.
values: true, false
```
<feed url="http://example.com/feed.rss" showSource="true" />
```
showDescription -- Whether or not to show the item descriptions, or to truncate them. Truncating the descriptions prevents formatting, links, and images from being shown.
values: true, false, number of characters after which to truncate (integer)
```
<feed url="http://example.com/feed.rss" showDescription="100" />
```

strip -- Remove text from item descriptions
values: Regular expression against the raw text including any html formatting
<feed url="http://example.com/feed.rss" strip="click here" />

filter -- Don't show items that match the given regular expression
values: Regular expression against the raw text including any html formatting
<feed url="http://example.com/feed.rss" filter="old news" />

The RSS reader comes with setup.page.xml and z.page.xml that can be used as examples.

Setup Stephen Ostermiller's RSS Reader

.page.xml XML File

Attributes

License