JAggregator
===========

Thanks for downloading JAggregator. JAggregator is a News Aggregator
that pulls news stories, weblog content, stock informations
and other XML-based content from the web and presents it to the user.

It understands RSS 0.9 to RSS 2.0. Atom is currently not supported.

JAggregator is delivered as source code and needs to be compiled.

How to build JAggregator from source
------------------------------------

You need Ant 1.5 or later. JAggregator's lib directory contains the
files junit.jar and xmlunit1.0.jar. Please copy these files into
Ant's lib directory. Alternatively, include them in Ant's classpath.

Execute Ant. This builds JAggregator.

Howto run JAggregator
---------------------

Execute the following commands:

ant prepare-sandbox (only the first time)
cd sandbox
java -jar jaggregator.jar

Then, wait until the text "DEBUG SiteGenerator - site generated"
is displayed and open the file output/index.html in your 
favorite webbrowser.

Enjoy.

Howto subscribe to RSS feeds
----------------------------

Subscriptions are stored in the file sandbox/jaggregator.xml. In
JAggregator, feeds are grouped using subscription lists. Locate
a suitable subscription list, say "Technology" insert the following
snippet:

<subscription uri="http://www.javablogs.com/ViewDaysBlogs.action?view=rss">
  <alt-name>Javablogs</alt-name>
</subscription>

You can leave out the line "<alt-name>Javablogs</alt-name>". In that case,
the name of the subscription is read from the feed. <alt-name> is useful
if the name provided in the feed is too long or otherwise unsuitable.

You can introduce new subscription lists. Start by making a copy of one
of the subscription lists included and make your changes. Make sure that
you changed the "id" attribute of your new subscription list. 

At the end of jaggregator.xml are several template definitions. You have to
include your new subscription list in every definition.

Howto unsubscribe from RSS feeds
--------------------------------

Subscriptions are stored in the file sandbox/jaggregator.xml. Open this
file locate the RSS feed and delete the subscription.


Have fun,
Janek.
-- 
http://weblog.janek.org