this plugin is different from the [[html]] plugin and it is safe in most cases.

[ikiwiki.git] / doc / plugins / testpagespec.mdwn

diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn
index 36043cae82e989093c0988011928a4035fb6b20e..8180d5d4b5b374050301c4591ef7848b4e62157b 100644 (file)
--- a/doc/plugins/testpagespec.mdwn
+++ b/doc/plugins/testpagespec.mdwn
@@ -1,23 +1,6 @@
 [[!template id=plugin name=testpagespec author="[[Joey]]"]]
-[[!tag type/useful]]
+[[!tag type/special-purpose]]
 
-This plugin allows testing a [[ikiwiki/PageSpec]] to see if it matches a
+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.
-
-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.