ikiwiki (3.20130711) unstable; urgency=low
[ikiwiki.git] / doc / plugins / contrib / pagespec_alias.mdwn
1 [[!template id=plugin name=pagespec_alias author="[[Jon]]"]]
2 [[!tag type/meta]]
3
4 The pagespec_alias plugin allows the administrator(s) of a wiki to define
5 [[PageSpec]] aliases: short names for PageSpecs to ease re-use.
6
7 Within the setup file, the `pagespec_aliases` value is treated as a list
8 of key/value pairs.  The keys define alias names, the values the pagespecs
9 to which they refer.
10
11 For example:
12
13     pagespec_aliases:
14        image: "*.png or *.jpg or *.jpeg or *.gif or *.ico"
15        helper: "*.css or *.js"
16        boring: "image() or helper() or internal(*)"
17
18 With the above, you could use the pagespec aliases such as 
19
20     \[[!map pages="!boring()"]]
21
22 To define a site map which excluded various page names which might be
23 uninteresting to include in a site map.
24
25
26 ## Download
27  
28  * <https://github.com/jmtd/ikiwiki/blob/pagespec-alias/IkiWiki/Plugin/pagespec_alias.pm>