2008-07-21 13:31:57 +02:00
|
|
|
[[!template id=plugin name=sidebar author="Tuomo Valkonen"]]
|
|
|
|
|
[[!tag type/chrome]]
|
2006-08-23 07:41:07 +02:00
|
|
|
|
2010-04-15 23:31:50 +02:00
|
|
|
This plugin allows adding a sidebar to pages in the wiki.
|
|
|
|
|
|
|
|
|
|
By default, and unless the `global_sidebars` setting is turned off,
|
|
|
|
|
a sidebar is added to all pages in the wiki. The content of the sidebar
|
|
|
|
|
is simply the content of a page named "sidebar" (ie, create a "sidebar.mdwn").
|
2006-08-18 02:24:22 +02:00
|
|
|
|
|
|
|
|
Typically this will be a page in the root of the wiki, but it can also be a
|
2007-12-08 21:59:08 +01:00
|
|
|
[[ikiwiki/SubPage]]. In fact, this page,
|
|
|
|
|
[[plugins/sidebar|plugins/sidebar]], will be treated as a sidebar for the
|
|
|
|
|
[[plugins]] page, and of all of its SubPages, if the plugin is enabled.
|
2006-08-18 02:24:22 +02:00
|
|
|
|
2010-04-15 22:40:01 +02:00
|
|
|
There is also a [[ikiwiki/directive/sidebar]] directive that can be used
|
|
|
|
|
to provide a custom sidebar content for a page.
|
2007-07-25 03:31:08 +02:00
|
|
|
|
2010-04-15 22:40:01 +02:00
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Warning: Any change to the sidebar page 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 an
|
|
|
|
|
[[ikiwiki/directive/inline]] directive, since any changes to pages inlined
|
|
|
|
|
into the sidebar will change the sidebar and cause a full wiki rebuild.
|
2009-10-04 22:28:14 +02:00
|
|
|
|
|
|
|
|
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.
|
