Learn about DokuWiki
Learn about DokuWiki
This is an old revision of the document!
The XML Syndication feature was implemented by using the excellent Feed Creator Class by Kai Blankenhorn.
How the feed is produced can be configured through certain config options. When feed.php is called without any arguments it will use these options to create the feed. All options can also be overridden by parameters passed in the URL.
Default the XML feed of DokuWiki is available, but you can disable it via the disable actions configuration.
Each item in the created feed will have a link; this option specifies where this link points to.
|page||the revision of the page when the feed was created|
|current||the most current revision of the page|
|rev||the revision view of the page|
|diff||a diff view of the page changes|
What is shown in the item bodies of the feed is controlled by this option.
|abstract||The first paragraph of a page|
|diff||a plain text diff of the page changes|
|htmldiff||a HTML formatted diff table of the page changes|
|html||the full HTML rendered page content|
Control whether media is included in the list of feed items.
|both||list pages and media|
|pages||list only pages, do not list media|
|media||list only media, do not list pages|
DokuWiki can create XML feeds in multiple formats.
feed.php can be used to export a list of recent changes (default) but can be used for other lists as well.
|recent||list most recent changelog entries with the newest on top (this corresponds to the wiki's recent_changes page)|
|list||simply list all pages of a namespace (see below for selecting which one)|
|search|| list pages matching a certain search query given through an additional parameter
The feed can be limited to include pages of a certain namespace only.
In list mode
list, the feed will contain pages from the given namespace only, no sub namespaces.
In list mode
recent, sub namespaces are included.
Namespace limitation is not directly supported for the list mode
search. Instead you can give a namespace limitation in the query (using the
@ syntax) – this however will include sub namespaces.
The sorting of pages listed in the feed can be changed (list mode
Affects only the list mode
list. Natural sorting is just the order of the stored pages.
In list mode
recent, the pages are always ordered by date, as its name already suggests.
The maximum number of pages listed in the feed can be controlled as well.
Note: The actual number of items returned in the feed will also be limited by the number of items that meet the criteria of the feed.
By default no minor edits will be shown in the feed. This can be changed by an URL argument.
XML feeds are cached to reduce the load on the wiki. This option controls how long feed caches are valid.
The summary of a page change will usually be included in the feed item title. This might be unwanted sometimes and can be disabled.
http://example.com/dokuwiki/feed.php?type=rss2&num=5returns a RSS 2.0 feed of the 5 most recent changes
http://example.com/dokuwiki/feed.php?mode=list&type=atom&linkto=page&ns=wikilists all pages in the namespace “wiki” as an ATOM 0.3 feed with all items linking to the page directly
When ACLs are enabled, read restricted pages will not be included in public feeds.
If you want to access feeds for restricted pages you have to pass your username and password along in the URL like this: ''http://example.com/dokuwiki/feed.php?u=username&p=password''.
This is not very secure and might lead to the leakage of your user credentials. When DokuWiki is running atop of
mod_php passing login credentials via HTTP Basic Auth as supported by some newsreaders might work as well.
For my configuration (dokuwiki 2008-05-05 and Liferea) the HTTP Basic Auth approach did not work out of the box. It seems that the authentication was not happening because the web server did not ask for it. So I forced this by creating a .htusers file (out of the dokuwiki user information) and restrict the access to feed.php:
I used the following simple script to generate a htusers file (used by apache) out of dokuwikis user data:
user@host# cat <<EOF > update_htusers #!/bin/sh grep -v '^#' users.auth.php | cut -sd\: -f1,2 > .htusers EOF user@host# chmod +x update_htusers user@host# ./update_htusers
Add to your existing .htaccess in dokuwiki main folder:
AuthType Basic AuthName "feed" AuthUserFile path-to-your-htusers-file <Files feed.php> Order deny,allow require valid-user </Files>