web commit by martin

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

diff --git a/doc/plugins/sidebar.mdwn b/doc/plugins/sidebar.mdwn
index 316579a1d7349b0ecb2632a52a371fef364a77ac..7e0ad5cf6b4158e25950e47ad727115d81d51e1f 100644 (file)
--- a/doc/plugins/sidebar.mdwn
+++ b/doc/plugins/sidebar.mdwn
@@ -1,6 +1,9 @@
+[[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
 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

-"sidebar".
+"sidebar" (ie, create a "sidebar.mdwn").

 
 Typically this will be a page in the root of the wiki, but it can also be a
 [[SubPage]]. In fact, this page, [[plugins/sidebar|plugins/sidebar]], will
 
 Typically this will be a page in the root of the wiki, but it can also be a
 [[SubPage]]. In fact, this page, [[plugins/sidebar|plugins/sidebar]], will


@@ -11,6 +14,8 @@ 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.
 
 you can create a sidebar page that is completely empty. This will turn off
 the sidebar altogether.
 

-This plugin is included in ikiwiki, but is not enabled by default.
-
-[[tag type/chrome]]
+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.