aboutsummaryrefslogtreecommitdiff
path: root/underlays/basewiki/directive/testpagespec.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:04:23 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:19 -0400
commit4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (patch)
tree725f523faeb8e8db0efd81be4024257799c93ef8 /underlays/basewiki/directive/testpagespec.mdwn
parent595b0359157d1f57ee5a87c63e665dfa1d2130ec (diff)
downloadikiwiki-4f0ac7fe59c196a602e07cc6c4abfc248999ec6b.tar
ikiwiki-4f0ac7fe59c196a602e07cc6c4abfc248999ec6b.tar.gz
add underlay files for listdirectives
As was noted, 'listdirectives' didn't include the underlay files that make it really worthwhile. I've just gone through all the plugin documentation, modified it to remove installation information and renamed the files to match the directives rather than the plugins. This can now serve as useful underlay. I've only gone through plugins in the 'plugins' dir. I did not go through the 'contrib' dir.
Diffstat (limited to 'underlays/basewiki/directive/testpagespec.mdwn')
-rw-r--r--underlays/basewiki/directive/testpagespec.mdwn22
1 files changed, 22 insertions, 0 deletions
diff --git a/underlays/basewiki/directive/testpagespec.mdwn b/underlays/basewiki/directive/testpagespec.mdwn
new file mode 100644
index 000000000..38b5c67ae
--- /dev/null
+++ b/underlays/basewiki/directive/testpagespec.mdwn
@@ -0,0 +1,22 @@
+The `testpagespec` directive is supplied by the [[!iki plugins/testpagespec]] plugin.
+
+This directive allows testing a [[ikiwiki/PageSpec]] to see if it matches a
+page, and to see the part that matches, or causes the match to fail.
+
+Example uses:
+
+ \[[!testpagespec pagespec="foopage and barpage" match="foopage"]]
+
+This will print out something like "no match: barpage does not match
+foopage", highlighting which part of the [[ikiwiki/PageSpec]] is causing
+the match to fail.
+
+ \[[!testpagespec pagespec="foopage or !bar*" match="barpage"]]
+
+This will print out something like "no match: bar* matches barpage", since
+the part of the [[ikiwiki/PageSpec]] that fails is this negated match.
+
+ \[[!testpagespec pagespec="foopage or barpage" match="barpage"]]
+
+This will print out something like "match: barpage matches barpage",
+indicating the part of the [[ikiwiki/PageSpec]] that caused it to match.