git.oblomov.eu Git - ikiwiki/blob - 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 There is also a [[ikiwiki/directive/sidebar]] directive that can be used
  14 to provide a custom sidebar content for a page.
  15
  16 ----
  17
  18 Warning: Any change to the sidebar page will cause a rebuild of the whole
  19 wiki, since every page includes a copy that has to be updated. This can
  20 especially be a problem if the sidebar includes an
  21 [[ikiwiki/directive/inline]] directive, since any changes to pages inlined
  22 into the sidebar will change the sidebar and cause a full wiki rebuild.
  23
  24 Instead, if you include a [[ikiwiki/directive/map]] directive on the sidebar,
  25 and it does not use the `show` parameter, only adding or removing pages
  26 included in the map will cause a full rebuild. Modifying pages will not.