summaryrefslogtreecommitdiff
path: root/doc/plugins/testpagespec.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/testpagespec.mdwn')
-rw-r--r--doc/plugins/testpagespec.mdwn21
1 files changed, 2 insertions, 19 deletions
diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn
index a173f5a96..cd777fa1c 100644
--- a/doc/plugins/testpagespec.mdwn
+++ b/doc/plugins/testpagespec.mdwn
@@ -1,23 +1,6 @@
[[!template id=plugin name=testpagespec author="[[Joey]]"]]
[[!tag type/useful]]
-This plugin allows testing a [[ikiwiki/PageSpec]] to see if it matches a
+This plugin implements the [[ikiwiki/directive/testpagespec]] [[ikiwiki/directive]].
+The 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.