]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/testpagespec.mdwn
(no commit message)
[git.ikiwiki.info.git] / doc / plugins / testpagespec.mdwn
index c5155129dcdb53bddd90a7e5a442556101f911d5..8180d5d4b5b374050301c4591ef7848b4e62157b 100644 (file)
@@ -1,22 +1,6 @@
-[[template id=plugin name=testpagespec author="[[Joey]]"]]
-[[tag type/useful]]
+[[!template id=plugin name=testpagespec author="[[Joey]]"]]
+[[!tag type/special-purpose]]
 
-This plugin allows testing a [[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 [[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 [[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 [[PageSpec]] that did match.
+This plugin provides a [[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.