Differences

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

--- faq:sidebar [2016-10-11 02:13] – Sidebar by namespace Digitalin
+++ faq:sidebar [2023-03-14 19:51] (current) – old revision restored (2023-01-25 07:24) From-Russia-with-Love
@@ Line 3: / Line 3: @@
 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 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? =====
@@ Line 24: / Line 24: @@
 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.
+*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.*
 ===== 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 '':*''
+  * '':sidebar'' -- applied for all pages in the wiki by default '':*''
-  * '':foo:sidebar'' - applied for all pages in the namespace ''foo:*''
+  * '':foo:sidebar'' -- applied for all pages in the namespace ''foo:*''
-More, you can easely have multiple sidebar, "the nearest sidebar page will be used" as said in the configuration setting: [[config:sidebar|sidebar]] page.
+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 have a specific sidebar by namespace in the site map to facilitate browsing as:
+There is no limit to having specific sidebars per namespace to facilitate browsing as:
   * '':foo:sidebar'' for the namespace ''foo:*''
@@ Line 40: / Line 40: @@
   * '':foo:bar:baz:sidebar'' for the namespace '':foo:bar:baz:*''
-However, you have to check if your template supports this setting, see further,
+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.
-as does for instance [[template:bootstrap3#dokuwiki_hooks|Bootstrap3 template]] for others bars editable in wiki, based on [[:include_hooks|hooks DokuWiki]].
+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".