summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--IkiWiki/Plugin/meta.pm1
-rw-r--r--IkiWiki/Plugin/tag.pm1
-rw-r--r--doc/plugins/write.mdwn14
3 files changed, 16 insertions, 0 deletions
diff --git a/IkiWiki/Plugin/meta.pm b/IkiWiki/Plugin/meta.pm
index 5691ff6a9..15a8bad84 100644
--- a/IkiWiki/Plugin/meta.pm
+++ b/IkiWiki/Plugin/meta.pm
@@ -26,6 +26,7 @@ sub preprocess (@) { #{{{
delete $params{$key};
my $page=$params{page};
delete $params{page};
+ delete $params{destpage};
eval q{use CGI 'escapeHTML'};
diff --git a/IkiWiki/Plugin/tag.pm b/IkiWiki/Plugin/tag.pm
index f1f3b77f5..957fd986d 100644
--- a/IkiWiki/Plugin/tag.pm
+++ b/IkiWiki/Plugin/tag.pm
@@ -22,6 +22,7 @@ sub preprocess (@) { #{{{
my %params=@_;
my $page = $params{page};
delete $params{page};
+ delete $params{destpage};
$tags{$page} = [];
foreach my $tag (keys %params) {
diff --git a/doc/plugins/write.mdwn b/doc/plugins/write.mdwn
index 16b6e9d8e..24da94dd5 100644
--- a/doc/plugins/write.mdwn
+++ b/doc/plugins/write.mdwn
@@ -169,6 +169,20 @@ use the following hashes, using a page name as the key:
it is by using the IkiWiki::add_depends function, which takes as its
parameters the page name and a [[GlobList]] of dependencies to add.
+# 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)`
+
+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)`
+
+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
+during inlining and don't need to worry about this issue.
+
# RCS plugins
ikiwiki's support for revision control systems also uses pluggable perl