Claim: The sidebar plugin has nothing
to do with sidebars. This plugin renders some page (which happens to be named
sidebar) and put the result in template variable
SIDEBAR of template
page.tmpl. But the fact that it is a sidebar, i.e. a bar appearing on the
side on the screen, is done by CSS.
What if I want a sidebar, and a navigation bar, and a footer a bit more elaborated than the one in the template, etc.? This plugin allows this.
If no option is given, or if option
global_sidebars is a boolean, this plugin
is identical to the sidebar plugin (if not, please report
global_sidebars is a list of sidebars to include. The list is as
global_sidebars => [ "var1", "page1", "pagespec1", "var2", "page2", "pagespec2", ]
The meaning is: if available, render
page1 in pages matching
put it in variable
var1 of the page template, and so on for
The default, which gives the behaviour of the sidebar plugin, is
global_sidebars => ["sidebar", "sidebar", "*"].
Remark: It would be more sensible to have a list of lists, as the following example, but I did not manage to do so because of this bug.
global_sidebars => [ ["var1", "page1", "pagespec1"], ["var2", "page2", "pagespec2"], ]
Improvements over sidebar plugin
You can add several "sidebars" to your wiki. For example, to have a sidebar, a submenu that appears only in documentation pages (
doc/*), and a footer, your
global_sidebars => [ "sidebar", "sidebar", "*", "menu", "/doc/menu", "doc/*", "footer", "/footer", "*" ]
You can enable sidebars only in certain pages matching the pagespec. If, for the same template variable, several pagespec match the current page, the first page in the list is taken into account.
For example, the following configuration says: render
menuas the sidebar for every page, excepted subpages of
doc, for which the
doc_menupage should be rendered.
global_sidebars => [ "sidebar", "doc_menu", "doc/*", "sidebar", "menu", "*", ]
The behaviour of the
sidebar directive is similar to the directive of the
original sidebar, excepted that a new
var argument is
var argument is set, instead of applying to the default
template variable, the directive applies to the value given in the argument.
For example, the following command forces the
footer sidebar to appear on the
The following command forces the
footer sidebar to appaer, containing the
content given in argument.
[[!sidebar var=footer content="TEST"]]
Which pages to render?
Here is the decision process to decide what is rendered in a template variable handled by this plugin.
- If the page contains the sidebar directive, with a
contentargument, this content is rendered.
- If the page contains the sidebar directive with no
contentargument, the first rule for the considered template variable is applied, disregarding the pagespec.
- If none of the above, the first rule having its pagespec patching the current page is applied.
- If none of the above, the variable is left empty.
Download and install
Code and documentation: https://atelier.gresille.org/projects/gresille-ikiwiki/wiki/Sidebar2.