Welcome to 2019
[ikiwiki.git] / doc / plugins / sidebar.mdwn
1 [[!template id=plugin name=sidebar author="Tuomo Valkonen"]]
2 [[!tag type/chrome]]
3
4 This plugin allows adding a sidebar to pages in the wiki.
5
6 By default, and unless the `global_sidebars` setting is turned off,
7 a sidebar is added to all pages in the wiki. The content of the sidebar
8 is simply the content of a page named "sidebar" (ie, create a "sidebar.mdwn").
9
10 Typically this will be a page in the root of the wiki, but it can also be a
11 [[ikiwiki/SubPage]]. In fact, this page,
12 [[plugins/sidebar|plugins/sidebar]], will be treated as a sidebar for the
13 [[plugins]] page, and of all of its SubPages, if the plugin is enabled.
14
15 There is also a [[ikiwiki/directive/sidebar]] directive that can be used
16 to provide a custom sidebar content for a page.
17
18 ----
19
20 Warning: Any change to the sidebar page will cause a rebuild of the whole
21 wiki, since every page includes a copy that has to be updated. This can
22 especially be a problem if the sidebar includes an
23 [[ikiwiki/directive/inline]] directive, since any changes to pages inlined
24 into the sidebar will change the sidebar and cause a full wiki rebuild.
25
26 Instead, if you include a [[ikiwiki/directive/map]] directive on the sidebar,
27 and it does not use the `show` parameter, only adding or removing pages
28 included in the map will cause a full rebuild. Modifying pages will not.