Merge commit 'upstream/master'

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

diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn
index 9a13ab5909f462f53f1c221efaa22ba48dc7aff0..dabcb0becd9c68410d9a285cbcf0a17dba936728 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]]
+[[!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 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.
 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.