]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/write.mdwn
add_depends: optimise influence calculation
[git.ikiwiki.info.git] / doc / plugins / write.mdwn
index f6ea76c3607fca1104ae9d999799d8e693c598ca..c72418c3c24eefe06662497a1197c33b5c0d4fab 100644 (file)
@@ -632,16 +632,19 @@ in the wiki that match the [[ikiwiki/PageSpec]].
 
 The page will automatically be made to depend on the specified
 [[ikiwiki/PageSpec]], so `add_depends` does not need to be called. This
-is significantly more efficient than calling `add_depends` and
+is often significantly more efficient than calling `add_depends` and
 `pagespec_match` in a loop. You should use this anytime a plugin
 needs to match a set of pages and do something based on that list.
 
+Unlike pagespec_match, this may throw an error if there is an error in
+the pagespec.
+
 Additional named parameters can be specified:
 
 * `deptype` optionally specifies the type of dependency to add. Use the
   `deptype` function to generate a dependency type.
-* `limit` is a reference to a function, that is called and passed a page,
-  and must return true for the page to be included.
+* `filter` is a reference to a function, that is called and passed a page,
+  and returns true if the page should be filtered out of the list.
 * `sort` specifies a sort order for the list. See
   [[ikiwiki/PageSpec/sorting]] for the avilable sort methods.
 * `reverse` if true, sorts in reverse.
@@ -650,8 +653,8 @@ Additional named parameters can be specified:
 * `list` makes it only match amoung the specified list of pages.
   Default is to match amoung all pages in the wiki.
 
-Unlike pagespec_match, this may throw an error if there is an error in
-the pagespec.
+Any other named parameters are passed on to `pagespec_match`, to further
+limit the match.
 
 #### `add_depends($$;$)`