update with new features to deal with large sites

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

diff --git a/doc/ikiwiki/directive/sidebar.mdwn b/doc/ikiwiki/directive/sidebar.mdwn
index 46f016747c01da0c3caab8d6332e0c8711e4b224..599695d22e45efb687d70acf2df2e5f0c234c9d5 100644 (file)
--- a/doc/ikiwiki/directive/sidebar.mdwn
+++ b/doc/ikiwiki/directive/sidebar.mdwn
@@ -1,14 +1,20 @@
 The `sidebar` directive is supplied by the [[!iki plugins/sidebar desc=sidebar]] plugin.
 
-This directive specifies a custom sidebar to display on the page, instead
-of any sidebar that is displayed globally.
+This directive can specify a custom sidebar to display on the page,
+overriding any sidebar that is displayed globally.
+
+If no custom sidebar content is specified, it forces the sidebar page to
+be used as the sidebar, even if the `global_sidebars` setting has been
+used to disable use of the sidebar page by default.
 
 ## examples
 
-       \[[!sidebar """
+       \[[!sidebar content="""
        This is my custom sidebar for this page.
 
        \[[!calendar pages="posts/*"]]
        """]]
 
+       \[[!sidebar]]
+
 [[!meta robots="noindex, follow"]]