Merge branch 'master' of ssh://git.kitenet.net/srv/git/ikiwiki.info

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

diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
index 04bf6666f40925b2af2300767bf4f5b74b56e955..7e0ad5cf6b4158e25950e47ad727115d81d51e1f 100644 (file)
--- a/doc/plugins/sidebar.mdwn
+++ b/doc/plugins/sidebar.mdwn
@@ -1,4 +1,4 @@
-[[template id=plugin name=sidebar included=1 author="Tuomo Valkonen"]]
+[[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.
@@ -13,3 +13,9 @@ 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.
+
+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.