the rename hook can now change the list of pages to rename

[ikiwiki.git] / doc / plugins / write.mdwn

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 79a9066ce7434dc96fa803661dba60bb0a119f48..d024a5dd47b6fe9066ece1413ad97e241536ba11 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -373,11 +373,12 @@ new page.
 
 ### rename
 
-       hook(type => "rename", id => "foo", call => \&renamepage);
+       hook(type => "rename", id => "foo", call => \&renamepages);
 
 When a page or set of pages is renamed, the referenced function is
-called once per renamed page, and passed named parameters: `oldpage`,
-`newpage`.
+called, and passed a reference to an array of hashes with keys:
+`src`, `srcfile`, `dest`, `destfile`, `required`. It can modify
+the array.
 
 ### getsetup