(no commit message)

[git.ikiwiki.info.git] / doc / plugins / recentchanges.mdwn

diff --git a/doc/plugins/recentchanges.mdwn b/doc/plugins/recentchanges.mdwn
index 69073adf08d21851811c3d6928da4a647573239e..6fff18e8a40e5594fbb05bf9c7b2eee72cdf413d 100644 (file)
--- a/doc/plugins/recentchanges.mdwn
+++ b/doc/plugins/recentchanges.mdwn
@@ -1,16 +1,32 @@
-[[template id=plugin name=recentchanges core=1 author="[[Joey]]"]]
+[[!template id=plugin name=recentchanges core=1 author="[[Joey]]"]]
+[[!tag type/meta]]

 
 This plugin examines the [[revision_control_system|rcs]] history and
 generates a page describing each recent change made to the wiki. These
 pages can be joined together with [[inline]] to generate the
 [[RecentChanges]] page.
 
 
 This plugin examines the [[revision_control_system|rcs]] history and
 generates a page describing each recent change made to the wiki. These
 pages can be joined together with [[inline]] to generate the
 [[RecentChanges]] page.
 

-Typically only the RecentChanges page will use the plugin, but you can
-use it elsewhere too if you like. It's used like this:
+This plugin also currently handles web-based reversion of changes.

 
 

-       \[[recentchanges pages="*" num=100 template=change]]
-       \[[inline pages="internal(recentchanges/change_*)"
+Typically only the RecentChanges page will use the pages generated by this
+plugin, but you can use it elsewhere too if you like. It's used like this:
+
+       \[[!inline pages="internal(recentchanges/change_*)"
+       template=recentchanges show=0]]
+
+Here's an example of how to show only changes to "bugs/*".
+This matches against the title of the change, which includes a list of
+modified pages.
+
+       \[[!inline pages="internal(recentchanges/change_*) and title(*bugs/*)"
+       template=recentchanges show=0]]
+
+Here's an example of how to show only changes that Joey didn't make.
+(Joey commits sometimes as user `joey`, and sometimes via openid.)
+       
+       \[[!inline pages="internal(recentchanges/change_*) and
+       !author(joey) and !author(http://joey.kitenet.net*)"

        template=recentchanges show=0]]
 
        template=recentchanges show=0]]
 

-The pages describing recent changes will be created as [[subpages|subpage]]
-of the page where the `recentchanges` directive is placed.
+If you want to generate feeds for the RecentChanges page, you have to use
+[[`rss`_or_`atom`_in_the_setup_file|/todo/minor adjustment to setup documentation for recentchanges feeds]].