From c01485ae1ad751ac87eb3cfa392f6d276d5b1157 Mon Sep 17 00:00:00 2001 From: intrigeri Date: Tue, 30 Dec 2008 21:36:40 +0100 Subject: renamed the renamepage hook to renamelink, added rename hook Signed-off-by: intrigeri --- doc/plugins/write.mdwn | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) (limited to 'doc/plugins/write.mdwn') diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 9b5cf27f7..79a9066ce 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -360,14 +360,24 @@ This hook is called whenever ikiwiki normally saves its state, just before the state is saved. The function can save other state, modify values before they're saved, etc. -### renamepage +### renamelink - hook(type => "renamepage", id => "foo", call => \&renamepage); + hook(type => "renamelink", id => "foo", call => \&renamelink); This hook is called by the [[plugins/rename]] plugin when it renames -something. The hook is passed named parameters: `page`, `oldpage`, -`newpage`, and `content`, and should try to modify the content to reflect -the name change. For example, by converting links to point to the new page. +something, once per page linking to the renamed page's old location. +The hook is passed named parameters: `page`, `oldpage`, `newpage`, and +`content`, and should try to modify the content of `page` to reflect +the name change. For example, by converting links to point to the +new page. + +### rename + + hook(type => "rename", id => "foo", call => \&renamepage); + +When a page or set of pages is renamed, the referenced function is +called once per renamed page, and passed named parameters: `oldpage`, +`newpage`. ### getsetup -- cgit v1.2.3