X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/9d7375c3b263e77da29a5db22af480db8b99d990..cdd1b58b386da575f3c73ab94ae72e5e66be797b:/doc/plugins/sidebar.mdwn diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index 4be012e39..36982eff3 100644 --- a/doc/plugins/sidebar.mdwn +++ b/doc/plugins/sidebar.mdwn @@ -1,15 +1,21 @@ -[[template id=plugin name=sidebar included=1 author="""Tuomo Valkonen"""]] -[[tag type/chrome]] +[[!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"). 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. +[[ikiwiki/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. -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. +Note that to disable a sidebar for a [[ikiwiki/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. + +Warning: Any change to the sidebar will cause a rebuild of the whole wiki, +since every page includes a copy that has to be updated. 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.