1Dokuwiki Plugin for creating external newsfeeds.
3This plugin will generate a news feed that can be read in a standard news reader (See below for how to generate
4the feed from the plugin markup.)
9There are two types of markup. At the top of a page that holds new items, you must place one of the following:
14First form: ~~NEWSFEED~~
15If you use the first form, then you bracket your news items with the following markup:
24The news reader will use your title for the item. You can omit the title:
30In this case the title will default to 'News Item'
32Second form: ~~NEWSFEED:<n>~~
33In this form, the news items are generated from material which is preceded by Dokuwiki header markup, and the headers
34become the titles of the news items. The <n> designates the number of equal signs that mark up your headers. The plugin will
35create news items from all headers greater than or equal to n. For instance:
37will create items from all headers with with three or more equal signs:
39 === header 1 ===
40 ==== header 2 ====
42This page is particularly useful if you have a page which is dedicated to news items.
45Generating the feed
46Each of the following methods generates an xml news feed in your top level dokuwiki directory. The news feed file is
49The main file for generating news feeds is newsfeed.php, which is found in news/scripts.
511. place newsfeed.php in your top level dokiuwiki directory and use as your feed url:
53 This method adheres to the ttl (time-to-live) configuration setting (see Options below) and creates a new xml file
54 only after the ttl has expired. Until the expiry time, it reads and outputs the previously created news_feed.xml.
56 However, you can force a new feed to be created by method 2 or 3.
582. place newsfeed.php in lib/exe and generate the feed from the command line:
59 php newsfeed.php
613. open the news admin panel and click on the generate button.
634. Create a Refresh button:
67If you use method 2 or 3 and do not implement method 1, then your url must be:
741. ttl: Number of minutes before a new feed will be automatically generated
752. title: Feed Title
763. desc: Feed Description.
782 and 3 configure the header section, where the Title is what is feed is known as the the description is a form of subtitle describing the feed further.
82If you have a version of the news plugin which supports multiple feeds, then you must include a unique feed name in your ~~NEWSFEED~~ syntax:
87The Refresh button will also require the feed name:
89The header values for these feeds are configured in the file scripts/newsfeed.ini.
91You can still use the original syntax, without the feed name; its header title and description will be taken from the default entry in newsfeed.ini or, lacking that, from the options set in the Dokuwiki configuration manager.