Differences

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

--- syndication [2013-10-30 17:34] – [List Mode] improve 'recent' mode description ChrisS
+++ syndication [2023-12-03 18:59] (current) – Updated link to feed creator class 2601:680:c980:e7a0:5d6a:b206:e621:1b44
@@ 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 [[https://www.hd-digitalmarketing.de/rsscreator-webdesign/|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 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]]
@@ Line 107: / Line 126: @@
   * **Possible Values:** any integer
-Note that [[config:recent]] is not well-defined, it's a config setting that is used for various purposes. It is also the maximum number of lines for [[devel:changelog]]. Hence, the returned number of items can be lower than the item limit provided with ''num'' (cf. [[dokubug>2765]]).
+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 114: / 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 165: / Line 194: @@
 <code apache>
-  AuthType Basic
+AuthType Basic
-  AuthName "feed"
+AuthName "feed"
-  AuthUserFile path-to-your-htusers-file
+AuthUserFile path-to-your-htusers-file
-  <Files feed.php>
+<Files feed.php>
-    Order deny,allow
+  Order deny,allow
-    require valid-user
+  require valid-user
-  </Files>
+</Files>
 </code>