X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/297ff849b93e5a75074e321fe65500f0e091601c..0d8ed6481b8d6caee0fc6f166bac7a382a10d733:/doc/plugins/toggle.mdwn diff --git a/doc/plugins/toggle.mdwn b/doc/plugins/toggle.mdwn index f25719ad3..d1500eba0 100644 --- a/doc/plugins/toggle.mdwn +++ b/doc/plugins/toggle.mdwn @@ -1,33 +1,7 @@ [[!template id=plugin name=toggle author="[[Joey]]"]] -[[!tag type/chrome]] +[[!tag type/widget]] -With this plugin you can create links on pages that, when clicked, toggle +This plugin provides the [[ikiwiki/directive/toggle]] and +[[ikiwiki/directive/toggleable]] [[directives|ikiwiki/directive]]. +With these directives you can create links on pages that, when clicked, toggle display of other parts of the page. - -It uses javascript to accomplish this; browsers without javascript will -always see the full page content. - -Example use: - - \[[toggle id="ipsum" text="show"]] - - \[[toggleable id="ipsum" text=""" - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do - eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim - ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut - aliquip ex ea commodo consequat. - - [[toggle id="ipsum" text="hide"]] - """]] - -Note that you can include wiki markup in the toggleable text, -including even additional toggles, as shown in the above example. - -Also, the toggle and the togglable definitions do not need to be next to -each other, but can be located anywhere on the page. There can also be -mutiple toggles that all toggle a single togglable. - -The id has a default value of "default", so can be omitted in simple cases. - -If you'd like a toggleable to be displayed by default, and toggle to -hidden, then pass a parameter "open=true" when setting up the toggleable.