summaryrefslogtreecommitdiff
path: root/doc/ikiwiki/directive
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2010-04-15 17:38:13 -0400
committerJoey Hess <joey@gnu.kitenet.net>2010-04-15 17:38:13 -0400
commitd63e043f0abf642ff4048cc20c6caf03db3e55fb (patch)
tree888d018126f548b9627bd3b61d8cb4477098bf83 /doc/ikiwiki/directive
parentd7c164dbf29ef57f8ed2963985bd250acbef96df (diff)
allow sidebar directive to enable use of sidebar page
This way, the example blog always has a sidebar on the index page, but not the overhead of sidebars on all the other pages. And if a user wants to, they can enable global_sidebars to switch to sidebars on every page.
Diffstat (limited to 'doc/ikiwiki/directive')
-rw-r--r--doc/ikiwiki/directive/sidebar.mdwn8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/ikiwiki/directive/sidebar.mdwn b/doc/ikiwiki/directive/sidebar.mdwn
index 34f078672..401d7c786 100644
--- a/doc/ikiwiki/directive/sidebar.mdwn
+++ b/doc/ikiwiki/directive/sidebar.mdwn
@@ -1,8 +1,12 @@
The `sidebar` directive is supplied by the [[!iki plugins/sidebar desc=sidebar]] plugin.
-This directive specifies a custom sidebar to display on the page,
+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 """
@@ -11,4 +15,6 @@ overriding any sidebar that is displayed globally.
\[[!calendar pages="posts/*"]]
"""]]
+ \[[!sidebar]]
+
[[!meta robots="noindex, follow"]]