ikiwiki/doc/plugins/sidebar.mdwn

[[template id=plugin name=sidebar author="Tuomo Valkonen"]]
[[tag type/chrome]]

If this plugin is enabled, then a sidebar is added to pages in the wiki.
The content of the sidebar is simply the content of a page named
"sidebar" (ie, create a "sidebar.mdwn").

Typically this will be a page in the root of the wiki, but it can also be a
[[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.

Note that to disable a sidebar for a [[SubPage]] of a page that has a sidebar,
you can create a sidebar page that is completely empty. This will turn off
the sidebar altogether.

Warning: Any change to the sidebar will cause a rebuild of the whole wiki,
since every page includes a copy that has to be updates. This can
especially be a problem if the sidebar includes [[inline]] or [[map]]
directives, since any changes to pages inlined or mapped onto the sidebar
will change the sidebar and cause a full wiki rebuild.
simplified plugin definitions 2007-02-13 19:51:21 +01:00			`[[template id=plugin name=sidebar author="Tuomo Valkonen"]]`
* Allow preprocessor directives to contain python-like triple-quoted text blocks, for easy nesting of quotes inside. * Add a template plugin. * Use the template plugin to add infoboxes to each plugin page listing basic info about the plugin. 2006-08-23 07:41:07 +02:00			`[[tag type/chrome]]`

* Add a tail fin^W^Wsidebar plugin by Tuomo Valkonen. * If a page links to itself, mark up the link text in a span with class="selflink" so that it can be styled. I don't have a useful style defined for that though. 2006-08-18 02:24:22 +02:00			`If this plugin is enabled, then a sidebar is added to pages in the wiki.`
			`The content of the sidebar is simply the content of a page named`
clarify 2006-08-19 00:23:34 +02:00			`"sidebar" (ie, create a "sidebar.mdwn").`
* Add a tail fin^W^Wsidebar plugin by Tuomo Valkonen. * If a page links to itself, mark up the link text in a span with class="selflink" so that it can be styled. I don't have a useful style defined for that though. 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`
			`[[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.`

note on disabling sidebar 2006-08-18 02:35:04 +02:00			`Note that to disable a sidebar for a [[SubPage]] of a page that has a sidebar,`
			`you can create a sidebar page that is completely empty. This will turn off`
			`the sidebar altogether.`
add warnings about using map, inline, etc with the sidebar causing performance nightmares 2007-07-25 03:31:08 +02:00
			`Warning: Any change to the sidebar will cause a rebuild of the whole wiki,`
			`since every page includes a copy that has to be updates. This can`
			`especially be a problem if the sidebar includes [[inline]] or [[map]]`
			`directives, since any changes to pages inlined or mapped onto the sidebar`
			`will change the sidebar and cause a full wiki rebuild.`