Differences

This shows you the differences between two versions of the page.

--- faq:sidebar [2013-09-09 15:08] – old revision restored (2013/07/12 00:26) 141.65.129.197
+++ faq:sidebar [2025-02-18 09:03] (current) – old revision restored (2024-06-17 12:26) Aleksandr
@@ Line 1: / Line 1: @@
 ====== How do I add a sidebar? ======
-If you're using [[template:dokuwiki|the new default template]] (or any other template which supports sidebars out of the box), you already have a sidebar functionality. If you're using a different template, there are basically two ways to add a sidebar functionality:
+If you're using [[template:dokuwiki|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:
-  * Either choose a template which already comes with a sidebar, see [[http://www.dokuwiki.org/template?plugintag=sidebar|templates tagged with 'sidebar']]. (There might be some which are missing the tag, so be sure to check out all of the [[:templates]].)
+  * Either choose a template which already comes with a sidebar, see [[templatetag>sidebar|templates tagged with 'sidebar']]. (There might be some which are missing the tag, so be sure to check out all of the [[:templates]].)
   * Or install a plugin which will add a sidebar to your template, see [[plugintag>sidebar|plugins tagged with 'sidebar']].
-Using a template which includes a sidebar functionality is often a better choice, as that sidebar will already be optimised to fit into the template's design and layout.
+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 [[config: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.
+Most templates use a normal wiki [[:page]] called "sidebar" for the sidebar. The name of that page is configurable via the [[config:sidebar]] config option. Some templates may have their own configuration or even have several sidebars - refer to your template's documentation.
-In the most likely event that your sidebar is a page called "sidebar", you just need to [[:page#create_a_page|create it]]. Go to "%%http://your-wiki.com/doku.php?id=sidebar%%", click "Create this page", edit the page, save, and you're done. That's it, your saved changes will appear in your sidebar.
+In the most likely event that your sidebar is a page called "sidebar", you just need to [[:page#create_a_page|create it]]. Go to ''%%http://your-wiki.com/doku.php?id=sidebar%%'', click "Create this page", edit the page, save, and you're done. That's it, your saved changes will appear in your sidebar.
-===== How can I have an automatic navigation in my sidebar? =====
-Best install one of the [[plugintag>menu|plugins tagged with 'menu']] or [[plugintag>navigation|plugins tagged with 'navigation']].
+===== My sidebar doesn't update properly or highlights the wrong parts =====
-In many cases you will also need to add the ''%%~~NOCACHE~~%%'' [[:wiki:syntax#control_macros|macro]] when using a plugin which changes the sidebar's appearance per page or namespace.
+If your sidebar contains dynamic elements (e.g. opening of a sub list, like a lot of navigation plugins do), then you may need to add the ''%%~~NOCACHE~~%%'' macro to your page to prevent [[:caching|caching]] of the sidebar.
+===== Sidebar by namespace=====
+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: [[config:sidebar|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.
+===== 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".
-===== 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|caching]] of the sidebar.