]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/commitdiff
more tweaks to urlto documentation
authorJoey Hess <joey@kitenet.net>
Mon, 29 Nov 2010 19:09:38 +0000 (15:09 -0400)
committerJoey Hess <joey@kitenet.net>
Mon, 29 Nov 2010 19:09:38 +0000 (15:09 -0400)
doc/plugins/write.mdwn

index ccdf9f393cfc34a1d34c654fc0a27e062a0366ac..3cab7588ec99c7a83fa6755fe3870fc93d6fb4d3 100644 (file)
@@ -1,4 +1,4 @@
-Ikiwiki's plugin interface allows all kinds of useful [[plugins]] to be
+lkiwiki's plugin interface allows all kinds of useful [[plugins]] to be
 written to extend ikiwiki in many ways. Despite the length of this page,
 it's not really hard. This page is a complete reference to everything a
 plugin might want to do. There is also a quick [[tutorial]].
@@ -988,13 +988,13 @@ 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` (or not specified), the URL will be
+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
 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.
+If the third parameter is passed and is true, the url will be a fully
+absolute url. This is useful when generating an url to publish elsewhere.
 
 ### `newpagefile($$)`