doc/todo/beef_up_sidebar_to_allow_for_multiple_sidebars.mdwn

   1 Maybe sidebar could be beefed up to take the name of a sidebar, such that I could use multiple sidebars in the same wiki. For instance, the default name would be 'sidebar', meaning the plugin looks for `sidebar.pm` and fills in the `sidebar` slot, but I might also want a footer in `footer.pm`, filling the template's `footer` slot.
   2
   3 One good way (if possible) would be to provide a directive like `\[[!sidebar
   4 id=sidebar]]` which would cause the file, in which it occurred to fill the
   5 slot `SIDEBAR` in the template: basically, a page `foo.mdwn` says
   6 `\[[!fillslot slot=myslot]]` and then its contents should go into `<TMPL_VAR
   7 SLOT_MYSLOT>` for all pages. Ideally, this can then be overridden, so if
   8 `/bar/foo.mdwn` also references `myslot` then pages under `/bar` should get
   9 those contents instead.
  10
  11
  12 --[[madduck]]
  13
  14 > In mine I just copied sidebar out and made some extra "sidebars", but they go elsewhere. Ugly hack, but it works. --[[simonraven]]
  15
  16 >> Here a simple [[patch]] for multiple sidebars. Not too fancy but better than having multiple copies of the sidebar plugin. --[[jeanprivat]]
  17
  18 >>> I made a [[git]] branch for it [[!template id=gitbranch branch="privat/multiple_sidebars" author="[[jeanprivat]]"]] --[[jeanprivat]]
  19
  20 >>>> Ping for [[Joey]]. Do you have any comment? I could improve it if there is things you do not like. I prefer to have such a feature integrated upstream. --[[JeanPrivat]]
  21
  22 <pre>
  23 --- /usr/share/perl5/IkiWiki/Plugin/sidebar.pm  2010-02-11 22:53:17.000000000 -0500
  24 +++ plugins/IkiWiki/Plugin/sidebar.pm   2010-02-27 09:54:12.524412391 -0500
  25 @@ -19,12 +19,20 @@
  26                         safe => 1,
  27                         rebuild => 1,
  28                 },
  29 +               active_sidebars => {
  30 +                       type => "string",
  31 +                       example => qw(sidebar banner footer),
  32 +                       description => "Which sidebars must be activated and processed.",
  33 +                       safe => 1,
  34 +                       rebuild => 1
  35 +               },
  36  }
  37
  38 -sub sidebar_content ($) {
  39 +sub sidebar_content ($$) {
  40         my $page=shift;
  41 +       my $sidebar=shift;
  42
  43 -       my $sidebar_page=bestlink($page, "sidebar") || return;
  44 +       my $sidebar_page=bestlink($page, $sidebar) || return;
  45         my $sidebar_file=$pagesources{$sidebar_page} || return;
  46         my $sidebar_type=pagetype($sidebar_file);
  47
  48 @@ -49,11 +57,17 @@
  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 +       my @sidebars;
  59 +       if (defined $config{active_sidebars} && length $config{active_sidebars}) { @sidebars = @{$config{active_sidebars}}; }
  60 +       else { @sidebars = qw(sidebar); }
  61 +
  62 +       foreach my $sidebar (@sidebars) {
  63 +               if ($template->query(name => $sidebar)) {
  64 +                       my $content=sidebar_content($page, $sidebar);
  65 +                       if (defined $content && length $content) {
  66 +                               $template->param($sidebar => $content);
  67 +                       }
  68                 }
  69         }
  70  }
  71 </pre>
  72
  73 [[!tag wishlist]]