]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/plugins/toggle.mdwn
Merge commit 'origin/master'
[git.ikiwiki.info.git] / doc / plugins / toggle.mdwn
index 5e0b8392a50c20d621dd4292c5c311a5187a78b8..69ac613e01e63eada17f05ef4f9da4adbcf06a0c 100644 (file)
@@ -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 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.