From: Joey Hess Date: Thu, 24 Mar 2011 17:37:40 +0000 (-0400) Subject: Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info X-Git-Tag: 3.20110328~8 X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/commitdiff_plain/9f7f12809041ab70fdde1f9695d450c64b1ca675?hp=78c750f2d28f23e7cfc56890999bcd313cf711c7 Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info --- 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..b7dd11906 --- /dev/null +++ b/doc/plugins/transient.mdwn @@ -0,0 +1,24 @@ +[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]" core=yes]] +[[!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/aggregate]] writes aggregated posts into the transient underlay +* [[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 + puts them in the transient underlay +* [[plugins/recentchanges]] writes new changes into the transient underlay +* [[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/sandbox.mdwn b/doc/sandbox.mdwn index bd0cc3c91..f40b288cb 100644 --- a/doc/sandbox.mdwn +++ b/doc/sandbox.mdwn @@ -87,3 +87,5 @@ lkj;kj; how do + +This is super cool Joey! diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 2325b6502..b9516d740 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -60,7 +60,7 @@ These options control the mode that ikiwiki operates in. * --clean - This makes ikiwiki clean up by removing any files it denerated in the + This makes ikiwiki clean up by removing any files it generated in the `destination` directory, as well as any configured wrappers, and the `.ikiwiki` state directory. This is mostly useful if you're running ikiwiki in a Makefile to build documentation and want a corresponding