X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/cedb48765b52d3e074f43703cf55611b3bce101d..bf34ced2fc3e8cf8623a576b8601234de70024ad:/doc/plugins/sidebar.mdwn diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index 644d1e630..7e0ad5cf6 100644 --- a/doc/plugins/sidebar.mdwn +++ b/doc/plugins/sidebar.mdwn @@ -1,12 +1,21 @@ +[[template id=plugin name=sidebar author="Tuomo Valkonen"]] +[[tag type/chrome]] + If this plugin is enabled, then a sidebar is added to pages in the wiki. The content of the sidebar is simply the content of a page named -"sidebar". +"sidebar" (ie, create a "sidebar.mdwn"). Typically this will be a page in the root of the wiki, but it can also be a [[SubPage]]. In fact, this page, [[plugins/sidebar|plugins/sidebar]], will be treated as a sidebar for the [[plugins]] page, and of all of its SubPages, if the plugin is enabled. -This plugin is included in ikiwiki, but is not enabled by default. +Note that to disable a sidebar for a [[SubPage]] of a page that has a sidebar, +you can create a sidebar page that is completely empty. This will turn off +the sidebar altogether. -[[tag type/chrome]] +Warning: Any change to the sidebar will cause a rebuild of the whole wiki, +since every page includes a copy that has to be updates. This can +especially be a problem if the sidebar includes [[inline]] or [[map]] +directives, since any changes to pages inlined or mapped onto the sidebar +will change the sidebar and cause a full wiki rebuild.