summaryrefslogtreecommitdiff
path: root/doc/plugins
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2010-11-29 14:43:57 -0400
committerJoey Hess <joey@kitenet.net>2010-11-29 14:43:57 -0400
commit0ae1e4cc0e598eacfeb508d11db81c33169631fd (patch)
treef779fd1bd4b4eaae315473ea70f9c1e85a7981d1 /doc/plugins
parentb3f7c6a9a579208f555a9ae7a409474d68897d04 (diff)
parent18bb93f5744c1b57b929d9f8a6042e51fc5256f0 (diff)
Merge remote branch 'smcv/ready/localurl'
Diffstat (limited to 'doc/plugins')
-rw-r--r--doc/plugins/write.mdwn4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 6b751f0cd..33db3e707 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -988,6 +988,10 @@ 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`.
+If the second parameter is `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 the wiki and the CGI are on different servers.
+
If the third parameter is passed and is true, an absolute url will be
constructed instead of the default relative url.