64710a2a5e72e349bc23db59899fa2281c4ae8b5
[ikiwiki.git] / basewiki / pagespec.mdwn
1 To select a set of pages, such as pages that are locked, pages
2 whose commit emails you want subscribe to, or pages to combine into a
3 [[blog]], the wiki uses a PageSpec. This is an expression that matches
4 a set of pages.
5
6 The simplest PageSpec is a simple list of pages. For example, this matches
7 any of the three listed pages:
8
9         foo or bar or baz
10
11 More often you will want to match any pages that have a particular thing in
12 their name. You can do this using a glob pattern. "`*`" stands for any part
13 of a page name, and "`?`" for any single letter of a page name. So this
14 matches all pages about music, and any [[SubPage]]s of the SandBox, but does
15 not match the SandBox itself:
16
17         *music* or SandBox/*
18
19 You can also prefix an item with "`!`" to skip pages that match it. So to
20 match all pages except for Discussion pages and the SandBox:
21
22         * and !SandBox and !*/Discussion
23
24 It's also possible to match pages that link to a given page, by writing
25 "`link(page)`". Or, match pages that a given page links to, by
26 writing "`backlink(page)`". Or match pages created in a given month, year,
27 or day of the month by writing "`creation_month(month)`",
28 "`creation_year(year)`" or "`creation_day(mday)`".
29
30 For example, to match all pages in a blog that link to the page about music
31 and were written on Mondays in 2005:
32
33         blog/* and link(music) and creation_year(2005) and creation_day(0)
34
35 More complex expressions can also be created, by using parentheses for
36 grouping. For example, to match pages in a blog that are tagged with either
37 of two tags, use:
38
39         blog/* and (link(tag/foo) or link(tag/bar))
40
41 ## Old syntax
42
43 The old PageSpec syntax was called a "GlobList", and worked differently in
44 two ways:
45
46 1. "and" and "or" were not used; any page matching any item from the list
47    matched.
48 2. If an item was prefixed with "`!`", then no page matching that item
49    matched, even if it matched an earlier list item.
50
51 For example, here is the old way to match all pages except for the SandBox
52 and Discussion pages:
53
54         * !SandBox !*/Discussion
55
56 Using this old syntax is still supported. However, the old syntax is
57 deprecated and will be removed at some point, and using the new syntax is
58 recommended.