ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / recentchanges.mdwn
1 [[!template id=plugin name=recentchanges core=1 author="[[Joey]]"]]
2 [[!tag type/meta]]
3
4 This plugin examines the [[revision_control_system|rcs]] history and
5 generates a page describing each recent change made to the wiki. These
6 pages can be joined together with [[inline]] to generate the
7 [[RecentChanges]] page.
8
9 This plugin also currently handles web-based reversion of changes.
10
11 Typically only the RecentChanges page will use the pages generated by this
12 plugin, but you can use it elsewhere too if you like. It's used like this:
13
14         \[[!inline pages="internal(recentchanges/change_*)"
15         template=recentchanges show=0]]
16
17 Here's an example of how to show only changes to "bugs/*".
18 This matches against the title of the change, which includes a list of
19 modified pages.
20
21         \[[!inline pages="internal(recentchanges/change_*) and title(*bugs/*)"
22         template=recentchanges show=0]]
23
24 Here's an example of how to show only changes that Joey didn't make.
25 (Joey commits sometimes as user `joey`, and sometimes via openid.)
26         
27         \[[!inline pages="internal(recentchanges/change_*) and
28         !author(joey) and !author(http://joey.kitenet.net*)"
29         template=recentchanges show=0]]
30
31 If you want to generate feeds for the RecentChanges page, you have to use
32 [[`rss`_or_`atom`_in_the_setup_file|/todo/minor adjustment to setup documentation for recentchanges feeds]].