Merge commit 'ecdfd1b8644bc926db008054ab6192e18351afed' into sipb

[ikiwiki.git] / doc / todo / beef_up_sidebar_to_allow_for_multiple_sidebars.mdwn

diff --git a/doc/todo/beef_up_sidebar_to_allow_for_multiple_sidebars.mdwn b/doc/todo/beef_up_sidebar_to_allow_for_multiple_sidebars.mdwn
index fb942a49552246a0d56ca5e32c6e75d2a85ea0c1..1f7b48764bab11eca7618a425c434fcc017a9f08 100644 (file)
--- a/doc/todo/beef_up_sidebar_to_allow_for_multiple_sidebars.mdwn
+++ b/doc/todo/beef_up_sidebar_to_allow_for_multiple_sidebars.mdwn
@@ -13,5 +13,76 @@ those contents instead.
 
 > In mine I just copied sidebar out and made some extra "sidebars", but they go elsewhere. Ugly hack, but it works. --[[simonraven]]
 
+>> Here a simple [[patch]] for multiple sidebars. Not too fancy but better than having multiple copies of the sidebar plugin. --[[jeanprivat]]
+
+>>> I made a [[git]] branch for it [[!template id=gitbranch branch="privat/multiple_sidebars" author="[[jeanprivat]]"]] --[[jeanprivat]]
+
+>>>> 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]]
+
+>>>>> The code is fine.
+>>>>>
+>>>>> I did think about having it examine
+>>>>> the `page.tmpl` for parameters with names like `FOO_SIDEBAR`
+>>>>> and automatically enable page `foo` as a sidebar in that case,
+>>>>> instead of using the setup file to enable. But I'm not sure about
+>>>>> that idea..
+>>>>> 
+>>>>> The full compliment of sidebars would be a header, a footer,
+>>>>> a left, and a right sidebar. It would make sense to go ahead
+>>>>> and add the parameters to `page.tmpl` so enabling each just works,
+>>>>> and add whatever basic CSS makes sense. Although I don't know
+>>>>> if I want to try to get a 3 column CSS going, so perhaps leave the
+>>>>> left sidebar out of that.
+
+<pre>
+--- /usr/share/perl5/IkiWiki/Plugin/sidebar.pm 2010-02-11 22:53:17.000000000 -0500
++++ plugins/IkiWiki/Plugin/sidebar.pm  2010-02-27 09:54:12.524412391 -0500
+@@ -19,12 +19,20 @@
+                       safe => 1,
+                       rebuild => 1,
+               },
++              active_sidebars => {
++                      type => "string",
++                      example => qw(sidebar banner footer),
++                      description => "Which sidebars must be activated and processed.",
++                      safe => 1,
++                      rebuild => 1
++              },
+ }
+ 
+-sub sidebar_content ($) {
++sub sidebar_content ($$) {
+       my $page=shift;
++      my $sidebar=shift;
+       
+-      my $sidebar_page=bestlink($page, "sidebar") || return;
++      my $sidebar_page=bestlink($page, $sidebar) || return;
+       my $sidebar_file=$pagesources{$sidebar_page} || return;
+       my $sidebar_type=pagetype($sidebar_file);
+       
+@@ -49,11 +57,17 @@
+ 
+       my $page=$params{page};
+       my $template=$params{template};
+-      
+-      if ($template->query(name => "sidebar")) {
+-              my $content=sidebar_content($page);
+-              if (defined $content && length $content) {
+-                      $template->param(sidebar => $content);
++
++      my @sidebars;
++      if (defined $config{active_sidebars} && length $config{active_sidebars}) { @sidebars = @{$config{active_sidebars}}; }
++      else { @sidebars = qw(sidebar); }
++
++      foreach my $sidebar (@sidebars) {
++              if ($template->query(name => $sidebar)) {
++                      my $content=sidebar_content($page, $sidebar);
++                      if (defined $content && length $content) {
++                              $template->param($sidebar => $content);
++                      }
+               }
+       }
+ }
+</pre>
 
 [[!tag wishlist]]