listdirectives: Avoid listing _comment directives and generally assume any directive...
[ikiwiki.git] / IkiWiki / Plugin / listdirectives.pm
index fe4aee3bbb8393a60941f32bd1092341ec8da230..bd73f1a04e728638c19994c0d64a4f288a120150 100644 (file)
@@ -4,16 +4,17 @@ package IkiWiki::Plugin::listdirectives;
 
 use warnings;
 use strict;
-use IkiWiki 2.00;
+use IkiWiki 3.00;
 
-sub import { #{{{
+sub import {
+       add_underlay("directives");
        hook(type => "getsetup", id => "listdirectives", call => \&getsetup);
        hook(type => "checkconfig", id => "listdirectives", call => \&checkconfig);
        hook(type => "needsbuild", id => "listdirectives", call => \&needsbuild);
        hook(type => "preprocess", id => "listdirectives", call => \&preprocess);
-} # }}}
+}
 
-sub getsetup () { #{{{
+sub getsetup () {
        return
                plugin => {
                        safe => 1,
@@ -21,33 +22,32 @@ sub getsetup () { #{{{
                },
                directive_description_dir => {
                        type => "string",
-                       description => "directory in srcdir that contains PreprocessorDirective descriptions",
-                       example => "ikiwiki/plugin",
+                       description => "directory in srcdir that contains directive descriptions",
+                       example => "ikiwiki/directive",
                        safe => 1,
                        rebuild => 1,
                },
-} #}}}
+}
 
 my @fulllist;
-my @earlylist;
+my @shortlist;
 my $pluginstring;
 
-sub checkconfig () { #{{{
+sub checkconfig () {
        if (! defined $config{directive_description_dir}) {
-               $config{directive_description_dir} = "ikiwiki/plugin";
+               $config{directive_description_dir} = "ikiwiki/directive";
        }
        else {
-               $config{directive_description_dir}=~s/\/+$//;
+               $config{directive_description_dir} =~ s/\/+$//;
        }
+}
 
-       @earlylist = sort( keys %{ $IkiWiki::hooks{preprocess} } );
-} #}}}
-
-sub needsbuild (@) { #{{{
+sub needsbuild (@) {
        my $needsbuild=shift;
 
-       @fulllist = sort( keys %{ $IkiWiki::hooks{preprocess} } );
-       $pluginstring = join (' ', @earlylist) . " : ". join (' ', @fulllist);
+       @fulllist = grep { ! /^_/ } sort keys %{$IkiWiki::hooks{preprocess}};
+       @shortlist = grep { ! $IkiWiki::hooks{preprocess}{$_}{shortcut} } @fulllist;
+       $pluginstring = join(' ', @shortlist) . " : " . join(' ', @fulllist);
 
        foreach my $page (keys %pagestate) {
                if (exists $pagestate{$page}{listdirectives}{shown}) {
@@ -63,9 +63,9 @@ sub needsbuild (@) { #{{{
                        }
                }
        }
-} # }}}
+}
 
-sub preprocess (@) { #{{{
+sub preprocess (@) {
        my %params=@_;
        
        $pagestate{$params{destpage}}{listdirectives}{shown}=$pluginstring;
@@ -76,21 +76,22 @@ sub preprocess (@) { #{{{
                @pluginlist = @fulllist;
        }
        else {
-               @pluginlist = @earlylist;
+               @pluginlist = @shortlist;
        }
        
        my $result = '<ul class="listdirectives">';
        
        foreach my $plugin (@pluginlist) {
                $result .= '<li class="listdirectives">';
-               $result .= htmllink($params{page}, $params{destpage},
-                       IkiWiki::linkpage($config{directive_description_dir}."/".$plugin));
+               my $link=linkpage($config{directive_description_dir}."/".$plugin);
+               add_depends($params{page}, $link);
+               $result .= htmllink($params{page}, $params{destpage}, $link);
                $result .= '</li>';
        }
        
        $result .= "</ul>";
 
        return $result;
-} # }}}
+}
 
 1