diff options
author | Christopher Baines <mail@cbaines.net> | 2014-06-27 23:35:03 +0100 |
---|---|---|
committer | Christopher Baines <mail@cbaines.net> | 2014-06-27 23:35:03 +0100 |
commit | 117a01bdcb984b0b9b2dbf1fef7f90c1113ff85c (patch) | |
tree | f09c30e6365d66d572c4c3483f7e4a18fb51b3cf | |
parent | 42da98f368c68ce7f5fc8aa945231f22ef08bf85 (diff) | |
download | ikiwiki-117a01bdcb984b0b9b2dbf1fef7f90c1113ff85c.tar ikiwiki-117a01bdcb984b0b9b2dbf1fef7f90c1113ff85c.tar.gz |
Reorder the content of the album page
-rw-r--r-- | doc/plugins/contrib/album.mdwn | 80 |
1 files changed, 40 insertions, 40 deletions
diff --git a/doc/plugins/contrib/album.mdwn b/doc/plugins/contrib/album.mdwn index 7344a158e..ce3c10184 100644 --- a/doc/plugins/contrib/album.mdwn +++ b/doc/plugins/contrib/album.mdwn @@ -11,40 +11,16 @@ This plugin automatically enables the [[filecheck]], [[img]], [[inline]], [[trail]] and [[transient]] plugins. The [[meta]] plugin is also recommended. -## Changing the templates - -When a viewer page is generated or inlined into an album, the template can -contain these extra variables: - -* `<TMPL_VAR ALBUM>` - page name of the album -* `<TMPL_VAR ALBUMURL>` - relative URL to the album -* `<TMPL_VAR ALBUMTITLE>` - title of the album, usually taken from - a [[ikiwiki/directive/meta]] directive -* `<TMPL_VAR CAPTION>` - caption for the image -* `<TMPL_VAR THUMBNAIL>` - a small [[ikiwiki/directive/img]] for the image -* `<TMPL_VAR IMAGEWIDTH>` - width of the full-size image in pixels -* `<TMPL_VAR IMAGEHEIGHT>` - height of the full-size image in pixels -* `<TMPL_VAR IMAGEFILESIZE>` - size of the image, e.g. `1.2 MiB` -* `<TMPL_VAR IMAGEFORMAT>` - format of the image, typically `JPEG` - -The template for the viewer page can also contain: - -* `<TMPL_VAR IMG>` - a large [[ikiwiki/directive/img]] to display the image -* `<TMPL_VAR PREV>` - a link to the previous viewer, typically with a - thumbnail -* `<TMPL_VAR NEXT>` - a link to the next viewer, typically with a - thumbnail - -## Including album entries elsewhere - -To display images from elsewhere in the wiki with the same appearance as -an [[ikiwiki/directive/album]] or [[ikiwiki/directive/albumsection]], -you can use an [[ikiwiki/directive/inline]] with the `albumitem` -template: +## Demo - \[[!inline pages="..." sort="-age" template="albumitem"]] +* [HTML page of thumbnails](http://ikialbum.hosted.pseudorandom.co.uk/album/) + as an entry point to the album +* Each thumbnail links to + [a "viewer" HTML page](http://ikialbum.hosted.pseudorandom.co.uk/album/img_0120/) + with a full size image, optional next/previous thumbnail links, and + optional [[plugins/comments]] ----- +## Installation [[!template id=gitbranch branch=smcv/album4 author="[[Simon_McVittie|smcv]]"]] @@ -61,7 +37,7 @@ is to provide a direct link to the image.) Updated, April 2012: rebased onto the version of [[trail]] that got merged -## Manual installation +### Manual installation First, you need a version of ikiwiki with the [[trail]] plugin merged in (version 3.20120203 or later). @@ -80,14 +56,38 @@ to download): [stylesheet](http://git.pseudorandom.co.uk/smcv/ikiwiki.git/blob/album4:/doc/style.css) (put them in your local.css) -## Demo +## Changing the templates -* [HTML page of thumbnails](http://ikialbum.hosted.pseudorandom.co.uk/album/) - as an entry point to the album -* Each thumbnail links to - [a "viewer" HTML page](http://ikialbum.hosted.pseudorandom.co.uk/album/img_0120/) - with a full size image, optional next/previous thumbnail links, and - optional [[plugins/comments]] +When a viewer page is generated or inlined into an album, the template can +contain these extra variables: + +* `<TMPL_VAR ALBUM>` - page name of the album +* `<TMPL_VAR ALBUMURL>` - relative URL to the album +* `<TMPL_VAR ALBUMTITLE>` - title of the album, usually taken from + a [[ikiwiki/directive/meta]] directive +* `<TMPL_VAR CAPTION>` - caption for the image +* `<TMPL_VAR THUMBNAIL>` - a small [[ikiwiki/directive/img]] for the image +* `<TMPL_VAR IMAGEWIDTH>` - width of the full-size image in pixels +* `<TMPL_VAR IMAGEHEIGHT>` - height of the full-size image in pixels +* `<TMPL_VAR IMAGEFILESIZE>` - size of the image, e.g. `1.2 MiB` +* `<TMPL_VAR IMAGEFORMAT>` - format of the image, typically `JPEG` + +The template for the viewer page can also contain: + +* `<TMPL_VAR IMG>` - a large [[ikiwiki/directive/img]] to display the image +* `<TMPL_VAR PREV>` - a link to the previous viewer, typically with a + thumbnail +* `<TMPL_VAR NEXT>` - a link to the next viewer, typically with a + thumbnail + +## Including album entries elsewhere + +To display images from elsewhere in the wiki with the same appearance as +an [[ikiwiki/directive/album]] or [[ikiwiki/directive/albumsection]], +you can use an [[ikiwiki/directive/inline]] with the `albumitem` +template: + + \[[!inline pages="..." sort="-age" template="albumitem"]] ## Bugs |