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 28e5ba7a73321172eaec91d643ff691a47c80c01..8180d5d4b5b374050301c4591ef7848b4e62157b 100644 (file)
--- a/doc/plugins/testpagespec.mdwn
+++ b/doc/plugins/testpagespec.mdwn
@@ -1,12 +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
-if not, why it fails to match.
-
-Example use:
-
-       \[[testpagespec pagespec="foopage and barpage" match="foopage"]]
-
-This will print out something like "barpage does not match foopage",
-highlighting which part of the [[PageSpec]] is causing the match to fail.
+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.