>>>>>>> pages get linked correctly, and missing pages get normal creation
>>>>>>> links. The old patch is still here if you decide you prefer that. -- [[Will]]
-Note that because there are double square brackets in the source, this might not
-display quite right.
+>>>>>>>> Can you explain the full/early list (why track both?) and generated parameter?
+
+>>>>>>>>> If you add in all the shortcuts you get quite a long list. My original idea
+>>>>>>>>> was to just track the plugin commands. This is the early list. But then
+>>>>>>>>> I thought that it might be nice for someone looking at wiki source and
+>>>>>>>>> seeing a shortcut to know where it came from. So I decided to make
+>>>>>>>>> displaying the full list an option, with the original concept as the default.
+
+>>>>>>>>> Another option here might be to generate the full list every time, but give
+>>>>>>>>> generated pre-processor commands (e.g. shortcuts) a different css class.
+>>>>>>>>> I'm not sure that is better than what I have though.
+
+>>>>>>>>> I keep track of both in the page state because if a command moves from
+>>>>>>>>> a shortcut to the early list (or vice versa) it changes what should be
+>>>>>>>>> displayed in the default use of the plugin. I thought about tracking just what
+>>>>>>>>> was actually used on the page, but I don't know in the needsbuild hook whether the `generated`
+>>>>>>>>> parameter has been supplied (or maybe the plugin is used twice on the page -
+>>>>>>>>> once in each form). It was just easier to track both.
+
+>>>>>>>> Only code change I'd suggest is using `htmllink` rather than
+>>>>>>>> generating a wikilink.
+
+>>>>>>>>> Yeah - that would make sense. Will do. -- [[Will]]
#!/usr/bin/perl
# Ikiwiki listpreprocessors plugin.
sub import { #{{{
hook(type => "getsetup", id => "listpreprocessors", call => \&getsetup);
- hook(type => "preprocess", id => "listpreprocessors", call => \&preprocess);
hook(type => "checkconfig", id => "listpreprocessors", call => \&checkconfig);
+ hook(type => "needsbuild", id => "listpreprocessors", call => \&needsbuild);
+ hook(type => "preprocess", id => "listpreprocessors", call => \&preprocess);
} # }}}
sub getsetup () { #{{{
},
} #}}}
+ my @fullPluginList;
my @earlyPluginList;
+ my $pluginString;
sub checkconfig () { #{{{
+ if (!defined $config{plugin_description_dir}) {
+ $config{plugin_description_dir} = "ikiwiki/plugin/";
+ }
- if (!defined $config{plugin_description_dir}) {
- $config{plugin_description_dir} = "ikiwiki/plugin/";
- }
-
- @earlyPluginList = sort( keys %{ $IkiWiki::hooks{preprocess} } );
+ @earlyPluginList = sort( keys %{ $IkiWiki::hooks{preprocess} } );
} #}}}
+ sub needsbuild (@) { #{{{
+ my $needsbuild=shift;
+
+ @fullPluginList = sort( keys %{ $IkiWiki::hooks{preprocess} } );
+ $pluginString = join (' ', @earlyPluginList) . " : ". join (' ', @fullPluginList);
+
+ foreach my $page (keys %pagestate) {
+ if (exists $pagestate{$page}{listpreprocessors}{shown}) {
+ if ($pagestate{$page}{listpreprocessors}{shown} ne $pluginString) {
+ push @$needsbuild, $pagesources{$page};
+ }
+ if (exists $pagesources{$page} &&
+ grep { $_ eq $pagesources{$page} } @$needsbuild) {
+ # remove state, will be re-added if
+ # the [[!listpreprocessors]] is still there during the
+ # rebuild
+ delete $pagestate{$page}{listpreprocessors}{shown};
+ }
+ }
+ }
+ } # }}}
+
sub preprocess (@) { #{{{
my %params=@_;
+ $pagestate{$params{destpage}}{listpreprocessors}{shown}=$pluginString;
+
my @pluginlist;
if (! defined $params{generated}) {
- @pluginlist = sort( keys %{ $IkiWiki::hooks{preprocess} } );
+ @pluginlist = @fullPluginList;
} else {
@pluginlist = @earlyPluginList;
}
my $result = '<ul class="listpreprocessors">';
-
+
foreach my $plugin (@pluginlist) {
$result .= '<li class="listpreprocessors">[[' . $config{plugin_description_dir} . $plugin . ']]</li>';
}
-
- $result .= "</ul>";
- print $result;
+ $result .= "</ul>";
return IkiWiki::preprocess($params{page}, $params{destpage},
IkiWiki::filter($params{page}, $params{destpage}, $result));