added the tweakbestlink hook

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 15f6c8a208e9b348bfe4a8461e23ce521a465055..e7656b2998bbb1fe19207f10e8d60b451a15938e 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -447,6 +447,17 @@ ikiwiki; it is run just after ikiwiki has removed the trailing
 
 It should return the modified url.
 
 
 It should return the modified url.
 

+### tweakbestlink
+
+       hook(type => "tweakbestlink", id => "foo", call => \&tweakbestlink);
+
+This hook can be used to modify the page returned by `bestlink`. It is
+passed named parameters `page` and `link`. These are, respectively,
+the page where the link will appear and the link ikiwiki would choose
+as the best one, if no `tweakbestlink` hook was in effect.
+
+It should return the modified link.
+

 ## Plugin interface
 
 To import the ikiwiki plugin interface:
 ## Plugin interface
 
 To import the ikiwiki plugin interface: