From 36e258203c45e1fbb4c10cdbc9b91ca368eca811 Mon Sep 17 00:00:00 2001 From: "http://smcv.pseudorandom.co.uk/" Date: Thu, 24 Mar 2011 16:05:13 +0000 Subject: rename plugins/contrib/transient.mdwn to plugins/transient.mdwn --- doc/plugins/contrib/transient.mdwn | 35 ----------------------------------- doc/plugins/transient.mdwn | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+), 35 deletions(-) delete mode 100644 doc/plugins/contrib/transient.mdwn create mode 100644 doc/plugins/transient.mdwn (limited to 'doc/plugins') diff --git a/doc/plugins/contrib/transient.mdwn b/doc/plugins/contrib/transient.mdwn deleted file mode 100644 index 6003196b0..000000000 --- a/doc/plugins/contrib/transient.mdwn +++ /dev/null @@ -1,35 +0,0 @@ -*For discussion and the branch please see [[todo/transient pages]]. If this -plugin is merged, this page can be renamed to act as its documentation. --[[smcv]]* - -[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]"]] -[[!tag type/special-purpose]] - -The `transient` plugin adds an underlay in `.ikiwiki/transient`, which is -intended for pages that are automatically created and should not be committed -to the [[RCS]]. It works in the same way as the [[basewiki]] and the underlays -set up by the [[plugins/underlay]] plugin, so if a page in the transient -underlay is edited via the web, the edited version is committed to the RCS -as usual. Unlike other underlays, if a page in the transient underlay is -superseded by an edited version in the RCS, the old transient version -is deleted automatically. - -This plugin is mostly useful as something that other plugins can depend on: - -* [[plugins/contrib/album]] always writes photo-album "viewer" pages to the - transient underlay - -Likely future users of this plugin (the appropriate branches need to be -merged first): - -* with a patch (which exists but hasn't yet been tested), [[plugins/aggregate]] - always writes aggregated posts into the transient underlay -* with a patch, [[plugins/autoindex]] can be configured to auto-create missing - pages that have a [[ikiwiki/subpage]] or an [[plugins/attachment]], but not - commit them, in which case they go in the transient underlay -* [[plugins/comments]] can be configured to not commit comments: if so, it - should probably put them in the transient underlay -* with a patch, [[plugins/recentchanges]] always writes new changes into the - transient underlay -* with a patch, [[plugins/tag]] can be configured to auto-create missing - tag pages but not commit them, in which case they go in the transient - underlay diff --git a/doc/plugins/transient.mdwn b/doc/plugins/transient.mdwn new file mode 100644 index 000000000..6003196b0 --- /dev/null +++ b/doc/plugins/transient.mdwn @@ -0,0 +1,35 @@ +*For discussion and the branch please see [[todo/transient pages]]. If this +plugin is merged, this page can be renamed to act as its documentation. --[[smcv]]* + +[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]"]] +[[!tag type/special-purpose]] + +The `transient` plugin adds an underlay in `.ikiwiki/transient`, which is +intended for pages that are automatically created and should not be committed +to the [[RCS]]. It works in the same way as the [[basewiki]] and the underlays +set up by the [[plugins/underlay]] plugin, so if a page in the transient +underlay is edited via the web, the edited version is committed to the RCS +as usual. Unlike other underlays, if a page in the transient underlay is +superseded by an edited version in the RCS, the old transient version +is deleted automatically. + +This plugin is mostly useful as something that other plugins can depend on: + +* [[plugins/contrib/album]] always writes photo-album "viewer" pages to the + transient underlay + +Likely future users of this plugin (the appropriate branches need to be +merged first): + +* with a patch (which exists but hasn't yet been tested), [[plugins/aggregate]] + always writes aggregated posts into the transient underlay +* with a patch, [[plugins/autoindex]] can be configured to auto-create missing + pages that have a [[ikiwiki/subpage]] or an [[plugins/attachment]], but not + commit them, in which case they go in the transient underlay +* [[plugins/comments]] can be configured to not commit comments: if so, it + should probably put them in the transient underlay +* with a patch, [[plugins/recentchanges]] always writes new changes into the + transient underlay +* with a patch, [[plugins/tag]] can be configured to auto-create missing + tag pages but not commit them, in which case they go in the transient + underlay -- cgit v1.2.3