added hook urlpath

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

diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 6d2622272f01eaa5ed65d0fc496e886633fdf8c7..15f6c8a208e9b348bfe4a8461e23ce521a465055 100644 (file)
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -437,6 +437,16 @@ be compiled into.
 
 It should return the target filename.
 
+### urlpath
+
+       hook(type => "urlpath", id => "foo", call => \&urlpath);
+
+This hook can be used to modify the internal urls generated by
+ikiwiki; it is run just after ikiwiki has removed the trailing
+`index.html`, in case `usedirs` is enabled.
+
+It should return the modified url.
+
 ## Plugin interface
 
 To import the ikiwiki plugin interface: