summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-08 23:57:37 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-10-08 23:57:37 +0000
commitbe55f6fd7cf1a251c3977f857a44ee2769e39d8b (patch)
tree36c09168ec20798e5fd5d1e0725cb8577d816928 /doc/plugins
parentbf4e6716cc57eb6d0dfca43ce92b64934950513e (diff)
* Atom feed support based on a patch by Clint Adams.
* Add feeds=no option to inline preprocessor directive to turn off all types of feeds. feeds=rss will still work, and feeds=atom was also added, for fine control. * $IkiWiki::version now holds the program version, and is accessible to plugins.
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/inline.mdwn10
-rw-r--r--doc/plugins/tag.mdwn3
-rw-r--r--doc/plugins/write.mdwn3
3 files changed, 12 insertions, 4 deletions
diff --git a/doc/plugins/inline.mdwn b/doc/plugins/inline.mdwn
index ef08d2cb2..807b7f79a 100644
--- a/doc/plugins/inline.mdwn
+++ b/doc/plugins/inline.mdwn
@@ -6,7 +6,7 @@ inside another. For example:
\[[inline pages="blog/*"]]
-The most common use of inlining is generating blogs and RSS feeds.
+The most common use of inlining is generating blogs and RSS or Atom feeds.
See [[blog]] for details.
## usage
@@ -18,8 +18,12 @@ directive:
* `show` - Specify the maximum number of matching pages to inline.
Default is 10, unless archiving, when the default is to show all.
Set to 0 to show all matching pages.
-* `rss` - Controls generation of an RSS feed. On by default, set to "no" to
- disable.
+* `rss` - controls generation of an rss feed. On by default if the wiki is
+ configured to use rss feeds, set to "no" to disable.
+* `atom` - controls generation of an atom feed. On by default if the wiki is
+ configured to use atom feeds, set to "no" to disable.
+* `feeds` - controls generation of all types of feeds. Set to "no" to
+ disable generating any feeds.
* `rootpage` - Enables a form to post new pages to a [[blog]].
* `archive` - If set to "yes", only list page titles and some metadata, not
full controls.
diff --git a/doc/plugins/tag.mdwn b/doc/plugins/tag.mdwn
index 499d6f273..1bc38e6fb 100644
--- a/doc/plugins/tag.mdwn
+++ b/doc/plugins/tag.mdwn
@@ -8,7 +8,8 @@ This plugin allows tagging pages. List tags as follows:
The tags work the same as if you had put a (hidden) [[WikiLink]] on the page
for each tag, so you can use a [[PageSpec]] match all pages that are
tagged with a given tag, for example. The tags will also show up on blog
-entries and at the bottom of the tagged pages, as well as in rss feeds.
+entries and at the bottom of the tagged pages, as well as in RSS and Atom
+feeds.
This plugin has a configuration option. Set --tagbase=tag and links to tags
will be located under the specified base page. If ikiwiki is configured
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 8145a3562..18aa34dca 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -201,6 +201,9 @@ use the following hashes, using a page name as the key:
reference.
* `%pagesources` contains the name of the source file for a page.
+Also, the %IkiWiki::version variable contains the version number for the
+ikiwiki program.
+
### Library functions
#### `hook(@)`