Differences

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

--- syndication [2013-04-21 15:52] – [Examples] do not use existing domains as examples! Also fixed dead link. schamane
+++ syndication [2020-05-08 13:34] – [Show New Items only] 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 79: / 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 97: / 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 113: / Line 134: @@
   * **Config Option:** none
   * **URL Parameter:** minor
+  * **Default:** 0
+  * **Possible Values:** 0 or 1
+==== Show New Items only ====
+[[devel:develonly]]
+Allows to output newly created items only.
+  * **Config Option:** none
+  * **URL Parameter:** only_new
   * **Default:** 0
   * **Possible Values:** 0 or 1