1 *For discussion and the branch please see [[todo/transient pages]]. If this
2 plugin is merged, this page can be renamed to act as its documentation. --[[smcv]]*
4 [[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]"]]
5 [[!tag type/special-purpose]]
7 The `transient` plugin adds an underlay in `.ikiwiki/transient`, which is
8 intended for pages that are automatically created and should not be committed
9 to the [[RCS]]. It works in the same way as the [[basewiki]] and the underlays
10 set up by the [[plugins/underlay]] plugin, so if a page in the transient
11 underlay is edited via the web, the edited version is committed to the RCS
12 as usual. Unlike other underlays, if a page in the transient underlay is
13 superseded by an edited version in the RCS, the old transient version
14 is deleted automatically.
16 This plugin is mostly useful as something that other plugins can depend on:
18 * [[plugins/contrib/album]] always writes photo-album "viewer" pages to the
21 Likely future users of this plugin (the appropriate branches need to be
24 * with a patch (which exists but hasn't yet been tested), [[plugins/aggregate]]
25 always writes aggregated posts into the transient underlay
26 * with a patch, [[plugins/autoindex]] can be configured to auto-create missing
27 pages that have a [[ikiwiki/subpage]] or an [[plugins/attachment]], but not
28 commit them, in which case they go in the transient underlay
29 * [[plugins/comments]] can be configured to not commit comments: if so, it
30 should probably put them in the transient underlay
31 * with a patch, [[plugins/recentchanges]] always writes new changes into the
33 * with a patch, [[plugins/tag]] can be configured to auto-create missing
34 tag pages but not commit them, in which case they go in the transient
projects / ikiwiki / blob