2 # Ikiwiki listdirectives plugin.
3 package IkiWiki::Plugin::listdirectives;
10 add_underlay("directives");
11 hook(type => "getsetup", id => "listdirectives", call => \&getsetup);
12 hook(type => "checkconfig", id => "listdirectives", call => \&checkconfig);
13 hook(type => "needsbuild", id => "listdirectives", call => \&needsbuild);
14 hook(type => "preprocess", id => "listdirectives", call => \&preprocess);
23 directive_description_dir => {
25 description => "directory in srcdir that contains directive descriptions",
26 example => "ikiwiki/directive",
37 if (! defined $config{directive_description_dir}) {
38 $config{directive_description_dir} = "ikiwiki/directive";
41 $config{directive_description_dir} =~ s/\/+$//;
48 @fulllist = sort keys %{$IkiWiki::hooks{preprocess}};
49 @shortlist = grep { ! $IkiWiki::hooks{preprocess}{$_}{shortcut} } @fulllist;
50 $pluginstring = join(' ', @shortlist) . " : " . join(' ', @fulllist);
52 foreach my $page (keys %pagestate) {
53 if (exists $pagestate{$page}{listdirectives}{shown}) {
54 if ($pagestate{$page}{listdirectives}{shown} ne $pluginstring) {
55 push @$needsbuild, $pagesources{$page};
57 if (exists $pagesources{$page} &&
58 grep { $_ eq $pagesources{$page} } @$needsbuild) {
59 # remove state, will be re-added if
60 # the [[!listdirectives]] is still there during the
62 delete $pagestate{$page}{listdirectives}{shown};
71 $pagestate{$params{destpage}}{listdirectives}{shown}=$pluginstring;
75 if (defined $params{generated}) {
76 @pluginlist = @fulllist;
79 @pluginlist = @shortlist;
82 my $result = '<ul class="listdirectives">';
84 foreach my $plugin (@pluginlist) {
85 $result .= '<li class="listdirectives">';
86 my $link=linkpage($config{directive_description_dir}."/".$plugin);
87 add_depends($params{page}, $link);
88 $result .= htmllink($params{page}, $params{destpage}, $link);