Differences

This shows you the differences between two versions of the page.

--- syndication [2011-08-06 10:42] – old revision restored ach
+++ syndication [2022-07-31 23:10] (current) – Klap-in
@@ Line 3: / Line 3: @@
 [[DokuWiki]] makes some of its data available as XML feed through the [[this>feed.php]] file. The feed can be subscribed in a [[wp>Aggregator|newsreader]].
-The XML Syndication feature was implemented by using the excellent [[http://www.bitfolge.de/rsscreator-en.html|Feed Creator Class]] by Kai Blankenhorn.
+The XML Syndication feature was implemented by using the excellent [[http://www.bitfolge.de/rsscreator-en.html|Feed Creator Class]] FIXME by Kai Blankenhorn.
 ===== Config/URL Options =====
 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.
+==== Disabling ====
+Default the XML feed of DokuWiki is available, but you can disable it via the disable actions configuration.
+  * **Config Option:** [[config:disableactions]]
+  * **Default:** XML Syndication (RSS) unchecked
 ==== Links ====
@@ Line 38: / Line 45: @@
 | htmldiff | a HTML formatted diff table of the page changes  |
 | html     | the full HTML rendered page content |
+==== Content Type ====
+Control whether media is included in the list of feed items.
+  * **Config Option:** [[config:rss_media]]
+  * **URL Parameter:** view
+  * **Default:** both
+  * **Possible Values:** both, pages, media
+^ Value    ^ Item Content ^
+| both     | list pages and media |
+| pages    | list only pages, do not list media  |
+| media    | list only media, do not list pages  |
 ==== Feed Format ====
@@ Line 65: / Line 86: @@
 ^ Value   ^ List Mode ^
-| recent  | list most recent pages with the newest on top |
+| 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 ''q'' |
@@ Line 83: / Line 104: @@
 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.
+==== Item Sorting ====
+The sorting of pages listed in the feed can be changed ([[#list mode]] ''list'' only)
+  * **Config Option:** none
+  * **URL Parameter:** sort
+  * **Default:** natural
+  * **Possible Values:** date, natural
+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.
 ==== Item Limits ====
-The number of pages listed in the feed can be controlled as well.
+The maximum number of pages listed in the feed can be controlled as well.
   * **Config Option:** [[config:recent]]
   * **URL Parameter:** num
-  * **Default:** 20
+  * **Default:** [[config:recent]]
   * **Possible Values:** any integer
+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.
 ==== Including Minor Edits ====
@@ Line 99: / Line 134: @@
   * **Config Option:** none
   * **URL Parameter:** minor
+  * **Default:** 0
+  * **Possible Values:** 0 or 1
+==== Show New Items only ====
+Allows to output newly created items only.
+  * **Config Option:** none
+  * **URL Parameter:** only_new
   * **Default:** 0
   * **Possible Values:** 0 or 1
@@ Line 122: / Line 166: @@
 ===== Examples =====
-  * [[this>feed.php?type=rss2&num=5]] returns a [[http://backend.userland.com/rss|RSS 2.0]] feed of the 5 most recent changes
+  * ''%%http://example.com/dokuwiki/feed.php?type=rss2&num=5%%'' returns a [[wikipedia>RSS|RSS 2.0]] feed of the 5 most recent changes
-  * [[this>feed.php?mode=list&type=atom&linkto=page&ns=wiki]] list all pages in the wiki namespace as an [[http://intertwingly.net/wiki/pie/FrontPage|ATOM 0.3]] feed with all items linking to the page directly
+  * ''%%http://example.com/dokuwiki/feed.php?mode=list&type=atom&linkto=page&ns=wiki%%'' lists all pages in the namespace "wiki" as an [[wikipedia>Atom (standard)|ATOM 0.3]] feed with all items linking to the page directly
 ===== Feeds and ACLs =====
@@ Line 164: / Line 208: @@
   * The [[plugin:feed|feed plugin]] for more ways to export your [[plugin:blog]] posts via RSS
   * Tips on [[tips:blogging#feed_setup|feed setup]] when blogging with DokuWiki
+  * The [[plugin:Feedauth]] plugin sends an "authorization required" header in the feed, for some clients needed.