ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / transient.mdwn
1 [[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]" core=yes]]
2 [[!tag type/special-purpose]]
3
4 The `transient` plugin adds an underlay in `.ikiwiki/transient`, which is
5 intended for pages that are automatically created and should not be committed
6 to the [[RCS]]. It works in the same way as the [[basewiki]] and the underlays
7 set up by the [[plugins/underlay]] plugin, so if a page in the transient
8 underlay is edited via the web, the edited version is committed to the RCS
9 as usual. Unlike other underlays, if a page in the transient underlay is
10 superseded by an edited version in the RCS, the old transient version
11 is deleted automatically.
12
13 This plugin is mostly useful as something that other plugins can depend on:
14
15 * [[plugins/aggregate]] writes aggregated posts into the transient underlay
16 * [[plugins/autoindex]] can be configured to auto-create missing
17     pages that have a [[ikiwiki/subpage]] or an [[plugins/attachment]], but not
18     commit them, in which case they go in the transient underlay
19 * [[plugins/comments]] can be configured to not commit comments: if so, it
20     puts them in the transient underlay
21 * [[plugins/recentchanges]] writes new changes into the transient underlay
22 * [[plugins/tag]] can be configured to auto-create missing
23     tag pages but not commit them, in which case they go in the transient
24     underlay