the pod bold thingy didn't work, making it a markdown one

[git.ikiwiki.info.git] / doc / plugins / sidebar.mdwn

diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
index 9ddfa19fb42b1d0c009ef2b671714c961688d027..4e356d65a8984885a256788f82f1f2173ffeaa67 100644 (file)
--- 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
@@ -16,6 +16,10 @@ 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
+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.