summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-07-25 01:31:08 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-07-25 01:31:08 +0000
commiteb5f8531fe3d9cc752a10343bb52abf8d0858196 (patch)
tree0eeae715c00030d4c2056534e5cc1dbab6c22ed2
parent1612dce6bbb050eacf6843b972ffaf9816d724be (diff)
add warnings about using map, inline, etc with the sidebar causing
performance nightmares
-rw-r--r--doc/plugins/sidebar.mdwn6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
index 14cfa08c6..7e0ad5cf6 100644
--- a/doc/plugins/sidebar.mdwn
+++ b/doc/plugins/sidebar.mdwn
@@ -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.