X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/297ff849b93e5a75074e321fe65500f0e091601c..c944bffe3dbad0746880a0cd573808f04505ebdd:/doc/plugins/testpagespec.mdwn?ds=sidebyside diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn index 36043cae8..8180d5d4b 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]] +[[!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.