It's better when it's simple

User Tools

Site Tools


How do I add a sidebar?

If you're using the default template (or any other template which supports sidebars out of the box), you already have a sidebar functionality. If you are using a different template, there are basically two ways to add a sidebar functionality:

Using a template which includes a sidebar functionality is often a better choice, as that sidebar will already be optimized to fit into the template's design and layout.

I have a sidebar functionality. How can I create or edit a sidebar now?

Most templates use a normal wiki page called “sidebar” for the sidebar. Some make this configurable, so you can choose the name of the page. (E.g. since Adora Belle there is the sidebar config option which some templates support.) And others have several sidebars, each of which will have their own page, sometimes even depending on namespaces. sssss In the most likely event that your sidebar is a page called “sidebar”, you just need to create it. Go to, click “Create this page”, edit the page, save, and you're done. That's it, your saved changes will appear in your sidebar.

My sidebar doesn't update properly or highlights the wrong parts

If your sidebar contains dynamic elements (e.g. highlighting of the current page or opening of a sub list, like a lot of navigation plugins do), then you need to add the ~~NOCACHE~~ macro to your page to prevent caching of the sidebar.

*This NOCACHE is no longer needed to fix link highlighting after Hogfather is released, because it has been changed in implementation to use front-end JavaScript highlighting.*

A single sidebar is applied by default to all pages in the namespace where the wiki sidebar page is created. So, you can choose where you want to display a sidebar :

  • :sidebar – applied for all pages in the wiki by default :*
  • :foo:sidebar – applied for all pages in the namespace foo:*

Moreover, you can easily have multiple sidebars: “the nearest sidebar page will be used” as said in the configuration setting: sidebar page. There is no limit to having specific sidebars per namespace to facilitate browsing as:

  • :foo:sidebar for the namespace foo:*
  • :bar:sidebar for the namespace bar:*
  • :foo:bar:sidebar for the namespace :foo:bar:*
  • :foo:bar:baz:sidebar for the namespace :foo:bar:baz:*

To be clear, all you need to do is create a page named 'sidebar' in a namespace and it will apply to all pages within the namespace.

However, you have to check if your template supports this setting. Bootstrap3, and possibly other templates, extends the namespace capability to other elements of the template (rightsidebar, navbar, pageheader,….). Check the template's configuration options.

The contents of the sidebar remains empty

You have to fill the page “sidebar” with static links and/or navigation plugin calls. In principle, the sidebar page is to edit and to fill like every other wiki page. (One small exception: be aware the ~~NOCACHE~~ option mentioned above.)

For some users the sidebar does not appear

Q: For some or all non-admin users the sidebar does not appear.

A: The user to whom the sidebar should be displayed must have read permission on the page “sidebar”.

faq/sidebar.txt · Last modified: 2024-04-02 21:14 by bactram

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki