]> sipb.mit.edu Git - ikiwiki.git/blob - doc/plugins/contrib/ikiwiki/directive/albumsection.mdwn
document album v3, based on trail v3
[ikiwiki.git] / doc / plugins / contrib / ikiwiki / directive / albumsection.mdwn
1 The `albumsection` directive is supplied by the [[!iki plugins/contrib/album desc=album]] plugin.
2
3 The `albumsection` directive is used to split an album into sections. It can
4 only appear on a page that also has the [[album]] directive.
5
6 The `filter` parameter is a [[ikiwiki/PageSpec]] against which viewer pages
7 are matched. The `albumsection` directive displays all the images that match
8 the filter, and the `album` directive displays any leftover images, like
9 this:
10
11     # Holiday photos
12
13     \[[!album]]
14     <!-- replaced with a list of any uncategorized photos; it will be
15          empty if they're all tagged as 'people' and/or 'landscapes' -->
16
17     ## People
18
19     \[[!albumsection filter="tagged(people)"]]
20     <!-- replaced with a list of photos tagged 'people', including
21          any that are also tagged 'landscapes' -->
22
23     ## Landscapes
24
25     \[[!albumsection filter="tagged(landscapes)"]]
26     <!-- replaced with a list of photos tagged 'landscapes', including
27          any that are also tagged 'people' -->
28
29 [[!meta robots="noindex, follow"]]