diff options
author | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
---|---|---|
committer | Joey Hess <joey@kodama.kitenet.net> | 2008-09-11 18:41:26 -0400 |
commit | 9921a4a8a1a696ce69acce5e14943f0149d926ff (patch) | |
tree | 926ebf50f913087a99c05993a3b01e2d935c9878 /doc/ikiwiki/directive/toggle.mdwn | |
parent | 7d98c3d52bcdf2a3010843d176bf9fd79643207b (diff) | |
download | ikiwiki-9921a4a8a1a696ce69acce5e14943f0149d926ff.tar ikiwiki-9921a4a8a1a696ce69acce5e14943f0149d926ff.tar.gz |
Move the directive documentation into its own underlay, separate from basewiki, since it's sorta large compared to the rest of basewiki.
Diffstat (limited to 'doc/ikiwiki/directive/toggle.mdwn')
-rw-r--r-- | doc/ikiwiki/directive/toggle.mdwn | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/ikiwiki/directive/toggle.mdwn b/doc/ikiwiki/directive/toggle.mdwn new file mode 100644 index 000000000..5729fca11 --- /dev/null +++ b/doc/ikiwiki/directive/toggle.mdwn @@ -0,0 +1,34 @@ +The `toggle` and `toggleable` directives are supplied by the [[!iki plugins/toggle]] plugin. + +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=yes" when setting up the toggleable. + +[[!meta robots="noindex, follow"]] |