summaryrefslogtreecommitdiff
path: root/doc/plugins/toggle.mdwn
diff options
context:
space:
mode:
authorWilliam Uther <willu@cse.unsw.edu.au>2008-09-11 17:05:51 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-09-11 17:05:51 -0400
commitc69a7f758590c91bd137a8d1cfa99f37bf28045a (patch)
tree16cbc730e9b63528b6a608856e8221b4fba40390 /doc/plugins/toggle.mdwn
parent4f0ac7fe59c196a602e07cc6c4abfc248999ec6b (diff)
patch plugin documentation to refer to directive pages
Diffstat (limited to 'doc/plugins/toggle.mdwn')
-rw-r--r--doc/plugins/toggle.mdwn32
1 files changed, 3 insertions, 29 deletions
diff --git a/doc/plugins/toggle.mdwn b/doc/plugins/toggle.mdwn
index 5eac6e4a1..3dbdbac73 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]]
-With this plugin you can create links on pages that, when clicked, toggle
+This plugin implements the [[ikiwiki/directive/toggle]] and
+[[ikiwiki/directive/toggleable]] [[ikiwiki/directive]]s.
+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.