References to Atom on the JSPWiki site refer to the Atom Syndication Format, an alternative to RSS.

As described on the Wikipedia's Atom page:

The name Atom applies to a pair of related standards. The Atom Syndication Format is an XML language used for web feeds, while the Atom Publishing Protocol (APP is the acronym, but it is referred to as 'AtomPub' for short) is a simple HTTP-based protocol for creating and updating Web resources.

While Atom isn't at this time as popular as RSS (indeed, the name alone is relatively unknown), it does have a number of major advantages, namely a stronger design and no bad history of competing designs, names, versions, etc.

Support within JSPWiki#

JSPWiki has supported RSS feeds since relatively early versions. In the 2.5.x branch there is now support for RSS 1.0, RSS 2.0 and Atom feeds, in three modes: 'wiki', 'blog', or 'full'.


The com.ecyrd.jspwiki.rss.RSSGenerator now permits specification of the specific feed format. There are a number of generate methods permitting wiki-wide, page-wide, or as a list of com.ecyrd.jspwiki.rss.Entry objects. .e.g.,

    import com.ecyrd.jspwiki.rss.*
    // ...

    List entries = new ArrayList();
    // add Entry objects from some source (in this example, some kind of array)
    for ( int i = 0; i < sources.size(); i++ ) {
        SomeSource source = sources[i];
        Entry entry = new Entry();
        entry.setAuthor( source.getAuthor() );   // author (String)
        entry.setContent( source.getContent() ); // content (String)
        entry.setPage( source.getWikiPage() );   // (WikiPage)
        entry.setTitle( source.getTitle() );     // title (String)
        entry.setURL( source.getURL() );         // url (String)
    // now generate Atom output (String)
    RSSGenerator rssgen = wikiEngine.getRSSGenerator();
    String mode = "wiki"; // the mode ( 'wiki' | 'blog' | 'full' )
    String type = "atom"; // the type ( 'rss10' | 'RSS20' | 'atom' ). Default is RSS 1.0
    // Generates a feed based on a context and list of changes. 
    String out = rssgen.generateFeed( wikiContext, entries, mode, type );

   // write String to appropriate output...

There are many more links on the Wikipedia Atom page.

What is the difference between these three RSS modes? - Tyton

Add new attachment

Only authorized users are allowed to upload new attachments.
« This page (revision-16) was last changed on 06-Jun-2008 19:03 by