X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b44a63126ad37a8d5bf1e92df425d2052f3013ed..6836070c171d7a9b37c884320caefe312420d3f7:/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn diff --git a/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn b/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn index ee46973c8..9ac400cd2 100644 --- a/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn +++ b/doc/todo/Add_a_plugin_to_list_available_pre-processor_commands.mdwn @@ -30,7 +30,10 @@ I've found myself wanting to know which [[plugins]] are switched on so I know wh >> Adding a whole new hook for a usage example is more effort than I >> wanted to go to. I was thinking of either: ->> + +>>> Just to clarify, I meant adding new parameters to the same hook call +>>> that registers the plugin. --[[Joey]] + >> - Adding a configuration for a wiki directory. If a matching page is in the >> specified wiki directory then the plugin name gets turned into a link to that >> page @@ -45,6 +48,24 @@ I've found myself wanting to know which [[plugins]] are switched on so I know wh >>Hrm. After listing all of that, maybe your idea with the hooks is the better >>solution. I'll think about it some more. -- [[Will]] +>>> I've also run into this problem with the websetup plugin, and +>>> considered those ideas too. I don't like the external url, because +>>> ikiwiki.info may be out of sync with the version of ikiwiki being used. +>>> (Or maybe it's gone! :-) The first idea is fine, except for the bloat +>>> issue. If turning on listpreprocessors and/or websetup means adding +>>> hundreds of pages (and of kilobytes) to your wiki, that could be an +>>> incentive to not turn them on.. +>>> +>>> Hmm.. maybe the thing to do is to use _internal pages for the plugins; +>>> then the individual pages would not be rendered, and your inlines would +>>> still work. Although I don't know how websetup would use it then, and +>>> also they would have to be non-internal for ikiwiki's own docwiki. Hmm. +>>> Maybe these are two different things; one is a set of pages describing +>>> preprocessor directives, and the second a set of pages describing +>>> plugins. They're so closely related though it seems a shame to keep +>>> them separate.. +>>> --[[Joey]] + >>> I started implementing the hook based solution, and decided I didn't like >>> it because there was no nice way to rebuild pages when the preprocessor >>> descriptions changed. So instead I assumed that the the [[plugins]] pages @@ -71,183 +92,50 @@ I've found myself wanting to know which [[plugins]] are switched on so I know wh >>>> shortcuts have been added). While this was unplanned, it seems a reasonable >>>> tradeoff between including all the large number of shortcuts and including none. -- [[Will]] -Here is the main listpreprocessors plugin. (Note, because this has double square brackets in the source, it isn't quite displaying correctly - look at the page source for details.) New template files follow: - - #!/usr/bin/perl - # Ikiwiki listpreprocessors plugin. - package IkiWiki::Plugin::listpreprocessors; - - use warnings; - use strict; - use Encode; - use IkiWiki 2.00; - - sub import { #{{{ - hook(type => "getsetup", id => "listpreprocessors", call => \&getsetup); - hook(type => "preprocess", id => "listpreprocessors", call => \&preprocess); - hook(type => "refresh", id => "listpreprocessors", call => \&refresh); - } # }}} - - sub getsetup () { #{{{ - return - plugin => { - safe => 1, - rebuild => undef, - }, - preprocessor_description_dir => { - type => "string", - description => "The ikiwiki directory that contains plugin descriptions.", - safe => 1, - rebuild => 1, - }, - preprocessor_description_autocreate => { - type => "boolean", - description => "Should pre-processor command descriptions be automatically created from a template.", - safe => 1, - rebuild => 1, - }, - } #}}} - - sub gendescription ($$) { #{{{ - my $plugin=shift; - my $page=shift; - my $file=$page.".".$config{default_pageext}; - my $template=template("preprocessor-description.tmpl"); - $template->param(page => $page, plugin => $plugin); - writefile($file, $config{srcdir}, $template->output); - if ($config{rcs}) { - IkiWiki::rcs_add($file); - } - } #}}} - - sub refresh () { #{{{ - eval q{use File::Find}; - error($@) if $@; - - if (defined $config{preprocessor_description_autocreate} && ! $config{preprocessor_description_autocreate}) { - return; # create pages unless they explicitly ask us not to - } - - if (!defined $config{preprocessor_description_dir}) { - $config{preprocessor_description_dir} = "ikiwiki/plugin/"; - } - - my @pluginlist = sort( keys %{ $IkiWiki::hooks{preprocess} } ); - my %pluginpages; - - if (@pluginlist) { - my ($plugin,$page); - - foreach $plugin (@pluginlist) { - $pluginpages{$plugin} = $config{preprocessor_description_dir} . $plugin; - } - - my %pages; - foreach my $dir ($config{srcdir}, @{$config{underlaydirs}}, $config{underlaydir}) { - find({ - no_chdir => 1, - wanted => sub { - $_=decode_utf8($_); - if (IkiWiki::file_pruned($_, $dir)) { - $File::Find::prune=1; - } - elsif (! -l $_) { - my ($f)=/$config{wiki_file_regexp}/; # untaint - return unless defined $f; - $f=~s/^\Q$dir\E\/?//; - return unless length $f; - return if $f =~ /\._([^.]+)$/; # skip internal page - if (! -d _) { - $pages{pagename($f)}=$f; - } - } - } - }, $dir); - } - - if ($config{rcs}) { - IkiWiki::disable_commit_hook(); - } - - my $needcommit = 0; - - while (($plugin,$page) = each %pluginpages) { - if (! exists $pages{$page}) { - $needcommit = 1; - gendescription($plugin,$page); - } - } - - if ($config{rcs}) { - if ($needcommit) { - IkiWiki::rcs_commit_staged( - gettext("automatic pre-processor description generation"), - undef, undef); - } - IkiWiki::enable_commit_hook(); - } - } - } #}}} - - sub preprocess (@) { #{{{ - my %params=@_; - - if (!defined $config{plugin_description_dir}) { - $config{plugin_description_dir} = "ikiwiki/plugin/"; - } - - my @pluginlist = sort( keys %{ $IkiWiki::hooks{preprocess} } ); - foreach my $plugin (@pluginlist) { - $plugin = $config{plugin_description_dir} . $plugin; - } - my $pluginString = join (' or ', @pluginlist); - - my $result = "[[!inline pages=\"$pluginString\" feeds=\"no\" show=0 sort=\"title\""; - - if (defined $params{inline}) { - $result .= ' template=\"listpreprocessors-listonly\" archive="yes"'; - } else { - $result .= ' template=\"listpreprocessors-inline\" archive="no"'; - } - - $result .= "]]"; - - return IkiWiki::preprocess($params{page}, $params{destpage}, - IkiWiki::filter($params{page}, $params{destpage}, $result)); - } # }}} - - 1 - --------- - -This is what I was using for `listpreprocessors-inline.tmpl`: - -
- --------- - -This is what I was using for `listpreprocessors-listonly.tmpl`: - - - --------- - -This is what I was using for `preprocessor-description.tmpl`: - - The