aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-10-07 20:02:43 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-10-07 20:02:43 -0400
commit76746c5fe6a8e851b971c8222a4929fe3be7f60a (patch)
tree1c1ccd6014f07e10384142b776b04bf2eee4c61c /doc
parentc72fda7d695142cc29ac986125234140f6414d97 (diff)
parent4528b95d2562831208d490ef378a089631000767 (diff)
downloadikiwiki-76746c5fe6a8e851b971c8222a4929fe3be7f60a.tar
ikiwiki-76746c5fe6a8e851b971c8222a4929fe3be7f60a.tar.gz
Merge branch 'master' into dependency-types
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/write.mdwn6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 133030f08..8e8c3311e 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -627,9 +627,13 @@ used to indicate weaker types of dependencies:
#### `pagespec_match($$;@)`
-Passed a page name, and [[ikiwiki/PageSpec]], returns true if the
+Passed a page name, and [[ikiwiki/PageSpec]], returns a true value if the
[[ikiwiki/PageSpec]] matches the page.
+Note that the return value is overloaded. If stringified, it will be a
+message indicating why the PageSpec succeeded, or failed, to match the
+page.
+
Additional named parameters can be passed, to further limit the match.
The most often used is "location", which specifies the location the
PageSpec should match against. If not passed, relative PageSpecs will match