]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/plugins/contrib/ikiwiki/directive/albumimage.mdwn
ikiwiki (3.20130711) unstable; urgency=low
[git.ikiwiki.info.git] / doc / plugins / contrib / ikiwiki / directive / albumimage.mdwn
1 The `albumimage` directive is supplied by the [[!iki plugins/contrib/album desc=album]] plugin.
3 Each viewer page produced by the [[album]] directive
4 contains an `albumimage` directive, which is replaced by an
5 [[ikiwiki/directive/img]], wrapped in some formatting using a
6 template (by default it's `albumviewer.tmpl`). That template can also include
7 links to the next and previous photos, in addition to those provided by the
8 [[!iki plugins/contrib/trail desc=trail]] plugin.
10 The next/previous links are themselves implemented by evaluating a template,
11 either `albumnext.tmpl` or `albumprev.tmpl` by default.
13 The directive can also have parameters:
15 * `title`, `date`, `updated`, `author`, `authorurl`, `copyright`, `license`
16   and `description` are short-cuts for the corresponding
17   [[ikiwiki/directive/meta]] directives
19 * `caption` sets a caption which is displayed near this image in the album
20   and viewer pages
22 The viewer page can also contain any text and markup before or after the
23 `albumimage` directive, which will appear before or after the image in the
24 viewer page.
26 [[!meta robots="noindex, follow"]]