]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/plugins/write.mdwn
pagespec error/failure distinction and error display by inline
[ikiwiki.git] / doc / plugins / write.mdwn
index 11ed312aebcfd73f8ec3b3f5cff463e98bfb6696..23df01ca7a73546e9e9354868464a3ba5664a7be 100644 (file)
@@ -890,9 +890,12 @@ It's also possible to write plugins that add new functions to
 IkiWiki::PageSpec package, that is named `match_foo`, where "foo()" is
 how it will be accessed in a [[ikiwiki/PageSpec]]. The function will be passed
 two parameters: The name of the page being matched, and the thing to match
-against. It may also be passed additional, named parameters. It should return
-a IkiWiki::SuccessReason object if the match succeeds, or an
-IkiWiki::FailReason object if the match fails.
+against. It may also be passed additional, named parameters.
+
+It should return a IkiWiki::SuccessReason object if the match succeeds, or
+an IkiWiki::FailReason object if the match fails. If the match cannot be
+attempted at all, for any page, it can instead return an
+IkiWiki::ErrorReason object explaining why.
 
 ### Setup plugins