summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2008-10-10 14:30:31 +0200
committerintrigeri <intrigeri@boum.org>2008-10-18 15:49:08 +0200
commite51089e11fc1093a253fc13ebfbd5d55912eba59 (patch)
tree81128b7f3a26ac81dbd9ef8341681deefb3568af /doc/plugins
parentc8330da6c050918eaea4a441ba2ed59258f49494 (diff)
added the tweakbestlink hook
Signed-off-by: intrigeri <intrigeri@boum.org>
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn11
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 15f6c8a20..e7656b299 100644
--- 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.
+### 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: