tweak urlto description

master
Joey Hess 2010-11-29 14:59:15 -04:00
parent 0ae1e4cc0e
commit f60f15704e
1 changed files with 4 additions and 3 deletions

View File

@ -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 second. The first parameter can be either a page name, or some other
destination file, as registered by `will_render`. destination file, as registered by `will_render`.
If the second parameter is `undef`, the URL will be valid from any page on the If the second parameter is `undef` (or not specified), the URL will be
wiki, or from the CGI; if possible it'll be a path starting with `/`, but an valid from any page on the wiki, or from the CGI; if possible it'll
absolute URL will be used if the wiki and the CGI are on different servers. 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 If the third parameter is passed and is true, an absolute url will be
constructed instead of the default relative url. constructed instead of the default relative url.