(no commit message)

[git.ikiwiki.info.git] / doc / plugins / contrib / album.mdwn

diff --git a/doc/plugins/contrib/album.mdwn b/doc/plugins/contrib/album.mdwn
index 0393d26dc72d625c55525754bf8dd9e8732957b1..8dfbbf71692d44de30327ffff37dc9f2ba37e5e1 100644 (file)
--- a/doc/plugins/contrib/album.mdwn
+++ b/doc/plugins/contrib/album.mdwn
@@ -1,10 +1,10 @@
 [[!template id=plugin name=album author="[[Simon_McVittie|smcv]]"]]
 [[!template id=plugin name=album author="[[Simon_McVittie|smcv]]"]]

-[[!template id=gitbranch branch=smcv/album author="[[Simon_McVittie|smcv]]"]]
+[[!template id=gitbranch branch=smcv/album2 author="[[Simon_McVittie|smcv]]"]]

 [[!tag type/chrome]]
 
 [[!tag type/chrome]]
 

-Available from [[smcv]]'s git repository, in the `album` branch
-([[users/smcv/gallery|users/smcv/gallery]] contains some older
-thoughts about this plugin).
+Available from [[smcv]]'s git repository, in the `album2` branch.
+Older (pre-rebase) versions in `album`, `album-live` (the latter
+was used on an actual website and didn't explode too much).

 
 This plugin formats a collection of images into a photo album,
 in the same way as many websites: good examples include the
 
 This plugin formats a collection of images into a photo album,
 in the same way as many websites: good examples include the


@@ -16,9 +16,9 @@ I've called it `album` to distinguish it from
 a better name for this functionality.
 
 The web UI I'm trying to achieve consists of one
 a better name for this functionality.
 
 The web UI I'm trying to achieve consists of one

-[HTML page of thumbnails](http://www.pseudorandom.co.uk/2008/2008-03-08-panic-cell-gig/)
+[HTML page of thumbnails](http://ikialbum.hosted.pseudorandom.co.uk/album/)

 as an entry point to the album, where each thumbnail links to
 as an entry point to the album, where each thumbnail links to

-[a "viewer" HTML page](http://www.pseudorandom.co.uk/2008/2008-03-08-panic-cell-gig/img_0068/)
+[a "viewer" HTML page](http://ikialbum.hosted.pseudorandom.co.uk/album/img_0120/)

 with a full size image, next/previous thumbnail links, and
 [[plugins/comments]].
 
 with a full size image, next/previous thumbnail links, and
 [[plugins/comments]].
 


@@ -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
 
 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
 
 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


@@ -110,7 +110,7 @@ image viewer.
 * The plugin doesn't do anything special to handle albums that are subpages
   of each other. If, say, `debconf` and `debconf/monday` are both albums,
   then `debconf/monday/p100.jpg` will currently be assigned to one or the
 * The plugin doesn't do anything special to handle albums that are subpages
   of each other. If, say, `debconf` and `debconf/monday` are both albums,
   then `debconf/monday/p100.jpg` will currently be assigned to one or the

-  other, arbitrarily.
+  other, arbitrarily. It should probably pick the closest (longest) album name.

 
 * The plugin doesn't do anything special to handle photos with similar names.
   If you have `p100.jpg` and `p100.png`, one will get a viewer page called
 
 * The plugin doesn't do anything special to handle photos with similar names.
   If you have `p100.jpg` and `p100.png`, one will get a viewer page called


@@ -119,10 +119,18 @@ image viewer.
 * If there's no `albumimage` in a viewer page, one should probably be appended
   automatically.
 
 * If there's no `albumimage` in a viewer page, one should probably be appended
   automatically.
 

+* When editing a viewer page, rebuilding it seems to fail at the moment.
+  Probably related to:
+
+* Integration with [[plugins/contrib/trail]] is new, untested and not
+  very well implemented. In particular, the prev/up/next links are
+  redundant with the ones from `trail`.
+

 ## TODO
 
 * The documentation should mention how to replicate the appearance of
 ## TODO
 
 * The documentation should mention how to replicate the appearance of

-  `album` and `albumsection` using an `inline` of viewer pages.
+  `album` and `albumsection` using an `inline` of viewer pages,
+  elsewhere on the site.

 
 * The documentation should mention all the template variables and
   all the parameters.
 
 * The documentation should mention all the template variables and
   all the parameters.


@@ -134,10 +142,11 @@ image viewer.
 * The generated viewer page should extract as much metadata as possible from
   the photo's EXIF tags (creation/modification dates, author, title, caption,
   copyright). [[smcv]] has a half-written implementation which runs
 * The generated viewer page should extract as much metadata as possible from
   the photo's EXIF tags (creation/modification dates, author, title, caption,
   copyright). [[smcv]] has a half-written implementation which runs

-  `scanimage` hooks, and has an `exiftool` plugin using [[!cpan Image::ExifTool]].
+  `scanimage` hooks, and has an `exiftool` plugin using [[!cpan Image::ExifTool]]
+  as a reference implementation of that hook.

 
 * There should be an option to reduce the size of photos and write them into
 
 * 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
 
   * your laptop's local ikiwiki has two underlays, `photos` and `webphotos`
   * `photos` contains full resolution photos with EXIF tags