X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/01dfa1d4ac6d459d5b383f27640f0df9e2946a3e..808593eee946b50f19158ed9cf54732f07594567:/doc/plugins/sidebar.mdwn diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index f38e56817..7e0ad5cf6 100644 --- a/doc/plugins/sidebar.mdwn +++ b/doc/plugins/sidebar.mdwn @@ -1,3 +1,6 @@ +[[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" (ie, create a "sidebar.mdwn"). @@ -11,6 +14,8 @@ 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. -This plugin is included in ikiwiki, but is not enabled by default. - -[[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.