X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/63edea27bc71c3bdf1837f994fb7effdd93fb2dd..52cd9ae4bb891efb73a999d02dc2dffa0fc083be:/doc/plugins/sidebar.mdwn diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index 8ab416f6f..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,7 +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. -It was contributed by Tuomo Valkonen. - -[[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.