aboutsummaryrefslogtreecommitdiff
path: root/doc/plugins/testpagespec.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugins/testpagespec.mdwn')
-rw-r--r--doc/plugins/testpagespec.mdwn12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/plugins/testpagespec.mdwn b/doc/plugins/testpagespec.mdwn
new file mode 100644
index 000000000..28e5ba7a7
--- /dev/null
+++ b/doc/plugins/testpagespec.mdwn
@@ -0,0 +1,12 @@
+[[template id=plugin name=testpagespec author="[[Joey]]"]]
+[[tag type/useful]]
+
+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.