]> sipb.mit.edu Git - ikiwiki.git/blob - doc/ikiwiki/pagespec.mdwn
Merge remote branch 'upstream/master' into prv/po
[ikiwiki.git] / doc / ikiwiki / pagespec.mdwn
1 [[!meta robots="noindex, follow"]]
2 To select a set of pages, such as pages that are locked, pages
3 whose commit emails you want subscribe to, or pages to combine into a
4 blog, the wiki uses a PageSpec. This is an expression that matches
5 a set of pages.
6
7 The simplest PageSpec is a simple list of pages. For example, this matches
8 any of the three listed pages:
9
10         foo or bar or baz
11
12 More often you will want to match any pages that have a particular thing in
13 their name. You can do this using a glob pattern. "`*`" stands for any part
14 of a page name, and "`?`" for any single letter of a page name. So this
15 matches all pages about music, and any [[SubPage]]s of the SandBox, but does
16 not match the SandBox itself:
17
18         *music* or SandBox/*
19
20 You can also prefix an item with "`!`" to skip pages that match it. So to
21 match all pages except for Discussion pages and the SandBox:
22
23         * and !SandBox and !*/Discussion
24
25 Some more elaborate limits can be added to what matches using these functions:
26
27 * "`glob(someglob)`" - matches pages and other files that match the given glob.
28   Just writing the glob by itself is actually a shorthand for this function.
29 * "`page(glob)`" - like `glob()`, but only matches pages, not other files
30 * "`link(page)`" - matches only pages that link to a given page (or glob)
31 * "`tagged(tag)`" - matches pages that are tagged or link to the given tag (or
32   tags matched by a glob)
33 * "`backlink(page)`" - matches only pages that a given page links to
34 * "`creation_month(month)`" - matches only files created on the given month
35 * "`creation_day(mday)`" - or day of the month
36 * "`creation_year(year)`" - or year
37 * "`created_after(page)`" - matches only files created after the given page
38   was created
39 * "`created_before(page)`" - matches only files created before the given page
40   was created
41 * "`internal(glob)`" - like `glob()`, but matches even internal-use 
42   pages that globs do not usually match.
43 * "`title(glob)`", "`author(glob)`", "`authorurl(glob)`",
44   "`license(glob)`", "`copyright(glob)`", "`guid(glob)`" 
45   - match pages that have the given metadata, matching the specified glob.
46 * "`user(username)`" - tests whether a modification is being made by a
47   user with the specified username. If openid is enabled, an openid can also
48   be put here. Glob patterns can be used in the username. For example, 
49   to match all openid users, use `user(*://*)`
50 * "`admin()`" - tests whether a modification is being made by one of the
51   wiki admins.
52 * "`ip(address)`" - tests whether a modification is being made from the
53   specified IP address.
54 * "`comment(glob)`" - matches comments to a page matching the glob.
55 * "`comment_pending(glob)`" - matches unmoderated, pending comments.
56 * "`postcomment(glob)`" - matches only when comments are being 
57   posted to a page matching the specified glob
58
59 For example, to match all pages in a blog that link to the page about music
60 and were written in 2005:
61
62         blog/* and link(music) and creation_year(2005)
63
64 Note the use of "and" in the above example, that means that only pages that
65 match each of the three expressions match the whole. Use "and" when you
66 want to combine expression like that; "or" when it's enough for a page to
67 match one expression. Note that it doesn't make sense to say "index and
68 SandBox", since no page can match both expressions.
69
70 More complex expressions can also be created, by using parentheses for
71 grouping. For example, to match pages in a blog that are tagged with either
72 of two tags, use:
73
74         blog/* and (tagged(foo) or tagged(bar))
75
76 Note that page names in PageSpecs are matched against the absolute
77 filenames of the pages in the wiki, so a pagespec "foo" used on page
78 "a/b" will not match a page named "a/foo" or "a/b/foo". To match
79 relative to the directory of the page containing the pagespec, you can
80 use "./". For example, "./foo" on page "a/b" matches page "a/foo".