diff options
Diffstat (limited to 'doc/plugins/toggle.mdwn')
-rw-r--r-- | doc/plugins/toggle.mdwn | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/doc/plugins/toggle.mdwn b/doc/plugins/toggle.mdwn new file mode 100644 index 000000000..b59004e6e --- /dev/null +++ b/doc/plugins/toggle.mdwn @@ -0,0 +1,32 @@ +[[template id=plugin name=toggle included=1 author="[[Joey]]"]] +[[tag type/chrome]] + +With this plugin 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"]] + """]] + +Clicking on "more" will toggle the display of the togglable text. + +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. |