<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>sidebar</title> <meta name="viewport" content="width=device-width, initial-scale=1" /> <link rel="stylesheet" href="../style.css" type="text/css" /> <link rel="stylesheet" href="../local.css" type="text/css" /> </head> <body> <div class="page"> <div class="pageheader"> <div class="header"> <span> <span class="parentlinks"> <a href="../index.html">ikiwiki</a>/ <a href="../plugins.html">plugins</a>/ </span> <span class="title"> sidebar </span> </span> </div> </div> <div id="pagebody"> <div id="content" role="main"> <p><span class="infobox"> Plugin: sidebar<br /> Author: Tuomo Valkonen<br /> Included in ikiwiki: yes<br /> Enabled by default: no<br /> Included in <a href="./goodstuff.html">goodstuff</a>: no<br /> Currently enabled: no<br /> </span></p> <p>This plugin allows adding a sidebar to pages in the wiki.</p> <p>By default, and unless the <code>global_sidebars</code> 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").</p> <p>Typically this will be a page in the root of the wiki, but it can also be a <a href="../ikiwiki/subpage.html">SubPage</a>. In fact, this page, <span class="selflink">plugins/sidebar</span>, will be treated as a sidebar for the <a href="../plugins.html">plugins</a> page, and of all of its SubPages, if the plugin is enabled.</p> <p>There is also a <a href="../ikiwiki/directive/sidebar.html">sidebar</a> directive that can be used to provide a custom sidebar content for a page.</p> <hr /> <p>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 <a href="../ikiwiki/directive/inline.html">inline</a> directive, since any changes to pages inlined into the sidebar will change the sidebar and cause a full wiki rebuild.</p> <p>Instead, if you include a <a href="../ikiwiki/directive/map.html">map</a> directive on the sidebar, and it does not use the <code>show</code> parameter, only adding or removing pages included in the map will cause a full rebuild. Modifying pages will not.</p> </div> </div> <div id="footer" class="pagefooter" role="contentinfo"> <div id="pageinfo"> <div class="tags"> Tags: <a href="./type/chrome.html" rel="tag">type/chrome</a> </div> <div id="backlinks"> Links: <a href="./contrib/navbar.html">contrib/navbar</a> <a href="./contrib/sidebar2.html">contrib/sidebar2</a> <a href="../tips/optimising_ikiwiki.html">tips/optimising ikiwiki</a> </div> <div class="pagedate"> Last edited <span class="date">Tue Feb 26 23:01:54 2019</span> <!-- Created <span class="date">Tue Feb 26 23:01:54 2019</span> --> </div> </div> <!-- from ikiwiki --> </div> </div> </body> </html>