doc/plugins/sidebar.mdwn

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