aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorhttp://smcv.pseudorandom.co.uk/ <smcv@web>2010-12-26 14:22:54 +0000
committerJoey Hess <joey@kitenet.net>2010-12-26 14:22:54 +0000
commit5faf0c08ff583e2b3cea7e296ff38dde47632230 (patch)
tree61086040ad0964a551514a63ce3fd7047430212f /doc
parentd17387cdfbcd36a4715eab31cf2ac79928fad6b1 (diff)
downloadikiwiki-5faf0c08ff583e2b3cea7e296ff38dde47632230.tar
ikiwiki-5faf0c08ff583e2b3cea7e296ff38dde47632230.tar.gz
recommend 2-argument urlto whenever possible
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/write.mdwn3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 3cab7588e..adc20af72 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -988,6 +988,9 @@ Construct a relative url to the first parameter from the page named by the
second. The first parameter can be either a page name, or some other
destination file, as registered by `will_render`.
+Provide a second parameter whenever possible, since this leads to better
+behaviour for the [[plugins/po]] plugin and `file:///` URLs.
+
If the second parameter is not specified (or `undef`), the URL will be
valid from any page on the wiki, or from the CGI; if possible it'll
be a path starting with `/`, but an absolute URL will be used if