summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/contrib/album.mdwn10
-rw-r--r--doc/plugins/contrib/transient.mdwn9
2 files changed, 14 insertions, 5 deletions
diff --git a/doc/plugins/contrib/album.mdwn b/doc/plugins/contrib/album.mdwn
index 3cfcb68d4..daf16fd3c 100644
--- a/doc/plugins/contrib/album.mdwn
+++ b/doc/plugins/contrib/album.mdwn
@@ -34,10 +34,10 @@ Each page containing an `album` directive is treated as a photo album.
Every image attached to an album or its subpages is considered to be part of
the album. A "viewer" page, with the wiki's default page extension, will be
-generated to display the image, if there isn't already a page of the same
-name as the image: for instance, if `debconf` is an album and
-`debconf/tuesday/p100.jpg` exists, then `debconf/tuesday/p100.mdwn` might
-be created.
+generated in the [[transient underlay|todo/transient_pages]] to display the
+image, if there isn't already a page of the same name as the image: for
+instance, if `debconf` is an album and `debconf/tuesday/p100.jpg` exists,
+then `debconf/tuesday/p100.mdwn` might be created.
There's currently a hard-coded list of extensions that are treated as images:
`png`, `gif`, `jpg`, `jpeg` or `mov` files. More image and video types could
@@ -138,7 +138,7 @@ image viewer.
as a reference implementation of that hook.
* There should be an option to reduce the size of photos and write them into
- an underlay, for this workflow:
+ an underlay (perhaps just the transient underlay), for this workflow:
* your laptop's local ikiwiki has two underlays, `photos` and `webphotos`
* `photos` contains full resolution photos with EXIF tags
diff --git a/doc/plugins/contrib/transient.mdwn b/doc/plugins/contrib/transient.mdwn
new file mode 100644
index 000000000..ff2fab610
--- /dev/null
+++ b/doc/plugins/contrib/transient.mdwn
@@ -0,0 +1,9 @@
+[[!template id=plugin name=transient author="[[Simon_McVittie|smcv]]"]]
+[[!template id=gitbranch branch=smcv/ready/transient author="[[Simon_McVittie|smcv]]"]]
+[[!tag type/special-purpose]]
+
+The `transient` plugin is an implementation of [[todo/transient pages]]
+in an underlay. It's mostly useful as something other plugins can depend on;
+[[plugins/contrib/album]] puts photo-album "viewer" pages there,
+and the versions of [[plugins/autoindex]] and [[plugins/tag]] on the
+same branch optionally put their auto-generated pages there.