doc/sourcehandler/feed.page in webgen-0.5.8 vs doc/sourcehandler/feed.page in webgen-0.5.9

- old
+ new

@@ -5,16 +5,10 @@ This source handler automatically generates an atom or RSS feed for a set of files from a file in [Webgen Page Format]({relocatable: ../webgen_page_format.html}) (the format which is also used for page files). -> This extension is only available if you have installed the [feedtools][1] library. The preferred -> way to do this is via Rubygems: -> -> gem install feedtools -{.warning} - The following meta information keys are supported: * `entries` (MANDATORY) A LCN pattern (or an array of LCN patterns) which specify the page files that should be @@ -29,15 +23,17 @@ The number of entries that should be included in the feed. Defaults to 10. * `atom` (OPTIONAL) - An atom feed is generated if this key is set to `true`. Defaults to `true`. + An atom feed is generated if this key is set to `true`. Defaults to `true`. The generated file + name derives from the feed file name but the extension is changed to `atom`. * `rss` (OPTIONAL) - A RSS feed is generated if this key is set to `true`. Defaults to `true`. + A RSS feed is generated if this key is set to `true`. Defaults to `true`. The generated file + name derives from the feed file name but the extension is changed to `rss`. * `rss_version` (OPTIONAL) The RSS version that should be used for generating the RSS feed. Defaults to `2.0`. @@ -96,10 +92,12 @@ * `author_url` The URL of the homepage of the author. Only used if the `author` meta information is also set. -The default implementation supports the generation of atom and RSS feeds. You can override the -default generation mechanism by adding an `atom_template` and/or `rss_template` block in the feed -file which are then used to generate the atom or the RSS feed respectively. - -[1]: http://sporkmonger.com/projects/feedtools +The default implementation supports the generation of atom and RSS feeds by using templates shipped +with webgen (the extension `feed` is changed to `atom` for atom feeds and to `rss` for rss feeds). +The default templates are located under the ALCNs `/templates/atom_feed.template` and +`/templates/rss_feed.template` and are automatically created and used if no such paths exist in the +webgen website. You can also override the default generation mechanism on a file per file basis by +adding an `atom_template` and/or `rss_template` block in the feed file which are then used to +generate the atom or the RSS feed respectively.