ikiwiki/doc/plugins/testpagespec.mdwn

[[!template id=plugin name=testpagespec author="[[Joey]]"]]
[[!tag type/useful]]

This plugin 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.
Migrate doc/plugins via prefix_directives This is a partial commit of: egrep -rl '\[\[[a-z]+ ' doc \| xargs --max-args 1 ./ikiwiki-transition prefix_directives 2008-07-21 13:31:57 +02:00			`[[!template id=plugin name=testpagespec author="[[Joey]]"]]`
			`[[!tag type/useful]]`
* Make pagespec_match on failure return a value that is false, but in a scalar context, evaluates to a reason why the match failed. * Add testpagespec plugin, which might be useful to see why a pagespec isn't matching something. 2007-04-27 09:55:40 +02:00
MAJOR basewiki reorg Including redir pages for the moved basewiki pages. These will be removed in a future release. 2007-12-08 21:59:08 +01:00			`This plugin 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.`
* Make pagespec_match on failure return a value that is false, but in a scalar context, evaluates to a reason why the match failed. * Add testpagespec plugin, which might be useful to see why a pagespec isn't matching something. 2007-04-27 09:55:40 +02:00
the kind of perl code that can only be written at 4:30 am (Get a good message when a PageSpec fails due to a negated success by creating success objects with a reason string, which morph into failure objects when negated.) 2007-04-27 10:34:09 +02:00			`Example uses:`
* Make pagespec_match on failure return a value that is false, but in a scalar context, evaluates to a reason why the match failed. * Add testpagespec plugin, which might be useful to see why a pagespec isn't matching something. 2007-04-27 09:55:40 +02:00
Migrate escaped directives (\[[) in doc/plugins to have \[[! prefix 2008-07-21 13:46:35 +02:00			`\[[!testpagespec pagespec="foopage and barpage" match="foopage"]]`
* Make pagespec_match on failure return a value that is false, but in a scalar context, evaluates to a reason why the match failed. * Add testpagespec plugin, which might be useful to see why a pagespec isn't matching something. 2007-04-27 09:55:40 +02:00
MAJOR basewiki reorg Including redir pages for the moved basewiki pages. These will be removed in a future release. 2007-12-08 21:59:08 +01:00			`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.`
the kind of perl code that can only be written at 4:30 am (Get a good message when a PageSpec fails due to a negated success by creating success objects with a reason string, which morph into failure objects when negated.) 2007-04-27 10:34:09 +02:00
Migrate escaped directives (\[[) in doc/plugins to have \[[! prefix 2008-07-21 13:46:35 +02:00			`\[[!testpagespec pagespec="foopage or !bar*" match="barpage"]]`
the kind of perl code that can only be written at 4:30 am (Get a good message when a PageSpec fails due to a negated success by creating success objects with a reason string, which morph into failure objects when negated.) 2007-04-27 10:34:09 +02:00
minor improvements 2007-04-27 19:01:52 +02:00			`This will print out something like "no match: bar* matches barpage", since`
MAJOR basewiki reorg Including redir pages for the moved basewiki pages. These will be removed in a future release. 2007-12-08 21:59:08 +01:00			`the part of the [[ikiwiki/PageSpec]] that fails is this negated match.`
the kind of perl code that can only be written at 4:30 am (Get a good message when a PageSpec fails due to a negated success by creating success objects with a reason string, which morph into failure objects when negated.) 2007-04-27 10:34:09 +02:00
Migrate escaped directives (\[[) in doc/plugins to have \[[! prefix 2008-07-21 13:46:35 +02:00			`\[[!testpagespec pagespec="foopage or barpage" match="barpage"]]`
the kind of perl code that can only be written at 4:30 am (Get a good message when a PageSpec fails due to a negated success by creating success objects with a reason string, which morph into failure objects when negated.) 2007-04-27 10:34:09 +02:00
			`This will print out something like "match: barpage matches barpage",`
MAJOR basewiki reorg Including redir pages for the moved basewiki pages. These will be removed in a future release. 2007-12-08 21:59:08 +01:00			`indicating the part of the [[ikiwiki/PageSpec]] that caused it to match.`