X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7960031135e74f6d36abc4294dbadb687117222c..a1138ae820d3ea121cbd28552a3300631179b0a5:/doc/plugins/sidebar.mdwn diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn index fd792400e..4e356d65a 100644 --- a/doc/plugins/sidebar.mdwn +++ b/doc/plugins/sidebar.mdwn @@ -1,5 +1,5 @@ -[[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 @@ -15,7 +15,11 @@ 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 -especially be a problem if the sidebar includes [[inline]] or [[map]] -directives, since any changes to pages inlined or mapped onto the sidebar +since every page includes a copy that has to be updated. This can +especially be a problem if the sidebar includes an [[ikiwiki/directive/inline]] +directive, since any changes to pages inlined into the sidebar will change the sidebar and cause a full wiki rebuild. + +Instead, if you include a [[ikiwiki/directive/map]] directive on the sidebar, +and it does not use the `show` parameter, only adding or removing pages +included in the map will cause a full rebuild. Modifying pages will not.