add plugin safe/rebuild info (part 3 of 3)
[ikiwiki.git] / IkiWiki / Plugin / sidebar.pm
1 #!/usr/bin/perl
2 # Sidebar plugin.
3 # by Tuomo Valkonen <tuomov at iki dot fi>
4
5 package IkiWiki::Plugin::sidebar;
6
7 use warnings;
8 use strict;
9 use IkiWiki 2.00;
10
11 sub import { #{{{
12         hook(type => "getsetup", id => "sidebar", call => \&getsetup);
13         hook(type => "pagetemplate", id => "sidebar", call => \&pagetemplate);
14 } # }}}
15
16 sub getsetup () { #{{{
17         return
18                 plugin => {
19                         safe => 1,
20                         rebuild => 1,
21                 },
22 } #}}}
23
24 sub sidebar_content ($) { #{{{
25         my $page=shift;
26         
27         my $sidebar_page=bestlink($page, "sidebar") || return;
28         my $sidebar_file=$pagesources{$sidebar_page} || return;
29         my $sidebar_type=pagetype($sidebar_file);
30         
31         if (defined $sidebar_type) {
32                 # FIXME: This isn't quite right; it won't take into account
33                 # adding a new sidebar page. So adding such a page
34                 # currently requires a wiki rebuild.
35                 add_depends($page, $sidebar_page);
36
37                 my $content=readfile(srcfile($sidebar_file));
38                 return unless length $content;
39                 return IkiWiki::htmlize($sidebar_page, $page, $sidebar_type,
40                        IkiWiki::linkify($sidebar_page, $page,
41                        IkiWiki::preprocess($sidebar_page, $page,
42                        IkiWiki::filter($sidebar_page, $page, $content))));
43         }
44
45 } # }}}
46
47 sub pagetemplate (@) { #{{{
48         my %params=@_;
49
50         my $page=$params{page};
51         my $template=$params{template};
52         
53         if ($template->query(name => "sidebar")) {
54                 my $content=sidebar_content($page);
55                 if (defined $content && length $content) {
56                         $template->param(sidebar => $content);
57                 }
58         }
59 } # }}}
60
61 1