summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-28 04:43:45 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-28 04:43:45 +0000
commit51d20d72f63b6f633747421c7afde171e189f50d (patch)
treeb827ebc878dca0403c7f2e2db85414d4441f63b2 /doc
parent437825b25a4553dba993264ef40db2215e007284 (diff)
small improvements
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins/write.mdwn9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 24da94dd5..90ffca3f4 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -172,12 +172,15 @@ use the following hashes, using a page name as the key:
# A note on generating html links
Many plugins need to generate html links and add them to a page. This is
-done by using the htmllink() function in ikiwiki. The usual way to call
-htmlllink is: `htmllink($page, $page, $link)`
+done by using the `IkiWiki::htmllink` function. The usual way to call
+htmlllink is:
+
+ htmllink($page, $page, $link)
Why is $page repeated? Because if a page is inlined inside another, and a
link is placed on it, the right way to make that link is actually:
-`htmllink($page, $destpage, $link)`
+
+ htmllink($page, $destpage, $link)
Here $destpage is the inlining page. A destpage parameter is passed to some
of the hook functions above; the ones that are not passed it are not used