summaryrefslogtreecommitdiff
path: root/doc/plugins/sidebar.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-10-04 16:28:14 -0400
committerJoey Hess <joey@gnu.kitenet.net>2009-10-04 16:28:14 -0400
commita8af271e5aed1c4aef3f66cee0847d609aedc705 (patch)
treefc4b843c49259f03df280df9895c6bd4081c9125 /doc/plugins/sidebar.mdwn
parent7982c3c1773feef0d7f248ff3efe09dd2cd94ad8 (diff)
document effect of contentless dependencies on sidebar efficiency
Diffstat (limited to 'doc/plugins/sidebar.mdwn')
-rw-r--r--doc/plugins/sidebar.mdwn8
1 files changed, 6 insertions, 2 deletions
diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
index 36982eff3..4e356d65a 100644
--- a/doc/plugins/sidebar.mdwn
+++ b/doc/plugins/sidebar.mdwn
@@ -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.