From: Joey Hess Date: Mon, 29 Nov 2010 18:59:15 +0000 (-0400) Subject: tweak urlto description X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=f60f15704e1f98ceea023561c9e411b6fc3ac4ea;p=ikiwiki.git tweak urlto description --- diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn index 33db3e707..726ace8d3 100644 --- a/doc/plugins/write.mdwn +++ b/doc/plugins/write.mdwn @@ -988,9 +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 second parameter is `undef` (or not specified), 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 domains. If the third parameter is passed and is true, an absolute url will be constructed instead of the default relative url.