X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/eb5f8531fe3d9cc752a10343bb52abf8d0858196..792026fe97c47a3da4f941dc615ebf3bd428ad37:/doc/plugins/sidebar.mdwn diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index 7e0ad5cf6..36982eff3 100644 --- a/doc/plugins/sidebar.mdwn +++ b/doc/plugins/sidebar.mdwn @@ -1,21 +1,21 @@ -[[template id=plugin name=sidebar 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 updates. This can +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.