fixed description for open parameter
[ikiwiki.git] / doc / plugins / toggle.mdwn
index fd3e935dab041d50a602eb92c7ef09ee189196e0..5eac6e4a1ab80a4b2d2a7a84abf57ff3e63603cd 100644 (file)
@@ -1,5 +1,5 @@
-[[template id=plugin name=toggle author="[[Joey]]"]]
-[[tag type/chrome]]
+[[!template id=plugin name=toggle 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.
@@ -9,19 +9,17 @@ always see the full page content.
 
 Example use:
 
-       \[[toggle id="ipsum" text="show"]]
+       \[[!toggle id="ipsum" text="show"]]
 
-       \[[toggleable id="ipsum" text="""
+       \[[!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"]]
+       [[!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.
 
@@ -30,3 +28,6 @@ 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.