VWcms RSS Feed  
 

[PREV][NEXT]

[PRINT]

"Really Simple Syndication" or "RDF Site Summary" is a means of providing timely and concise summaries of site content specifically for subscribers to that information.

http://en.wikipedia.org/wiki/RSS

The $$RSS$$ directive allows the equivalent of a $$SYNOPSIS$$ or $$BLOG$$ summary to be provided as an RSS feed. "What's New?" uses blog entries and an $$RSS$$ directive to provide a feed of the latest enhancements to VWcms.  "What's Changed?" provides a list of the more to less recent changes to all sections of the VWcms documentation.

VWcms RSS feeds are identified by a string and so each site can support multiple feeds with differing information contents.

Subscription

Using the $$RSS$$ directive with the feed and subscribe parameter provides a subscription link.

$$RSS$feed=whatsnew$subscribe$$

provides the  [SUBSCRIBE]  subscription link seen in the What's New? section.

The subscribe parameter takes an optional string providing an alternate subscription description or image.

$$RSS$feed=another$subscribe=Subscribe to "Another" Feed!$$

Feed Parameters

The feed is under the control of the site.  The only parameter provided by the client is the feed name.  If a feed by this name is not found the client receives an appropriate error.  Feed parameters are provided by site content.  An $$RSS$$ directive on the first line of any section (page) in the site (but obviously better placed in association with the feed content itself) provides those parameters.  It must consist of a leading, identifying feed name, then a feed type (synopsis or blog) and then any relevant parameters available with the $$SYNOPSIS$$ or $$BLOG$$ directives.

The What's New? section has an RSS feed specified as

$$RSS$feed=whatsnew$type=blog$description=What's new with VWcms!$level=-1$$

which provides immediately subordinate blog (dated) entries.

The What's Changed? section has a feed specified as

$$RSS$feed=whatschanged$type=synopsis$description=What's changed in the VWcms documentation!$level=1$order=-$since=*$$

which provides all sections in the VWcms documentation listed most to least recently modified.

Optional Parameters

The following parameters provide additional information to an RSS feed.

Parameter Description
description= More detail than the title can provide.
editor= Email address of the contact responsible for feed content.
language= Language for the feed (default is "en-us").
title= Short description of the feed.
ttl= Integer representing the number of minutes the feed should be cached before being refreshed.
webmaster= Email address of the techncial contact for the site.

Validate Feed

An additional and optional feature that may be provided is a validate feed link.

$$RSS$feed=whatsnew$validate$$

generates an  [VALIDATE]  link.

The validate parameter takes an optional string providing an alternate description or image.

$$RSS$feed=another$validate=Validate "Another" Feed!$$

By default the W3C validator is used however an additional parameter

$$RSS$feed=whatsnew$validator=http://another.validator.org/this=%s$$

can be supplied to specify another service (note the "%s" that includes the feed URL at the appropriate point in the validator URL).

[PRINT]  [PRINT]