Learn about DokuWiki
Learn about DokuWiki
Compatible with DokuWiki
If you use a version of Dokuwiki older than Angua, please use this older version of the plugin.
If you ever wonder “should I add this detail since it may be very interesting to some readers, or shouldn't I since it would complicate a first reading?”, then you may be interested in this plugin. Indeed, you'll just have to write
<hidden click here if you want to know more>Since you want to know more, here is an explanation with more details […]</hidden>
and the complicated explanation won't clutter up the page, but will still be readable.
Here is a quick example:
To avoid annoying readers we could have:
But an interested reader may click and get:
The simplest way is:
This will display the default text “Click to display ⇲” when the text is hidden, and “Click to hide ⇱” when it's visible.
Some options may be added inside the opening <hidden> tag:
|any text||use this text instead of the defaults “Click to display” and “Click to hide”||<hidden click me!>hidden text</hidden>|
|onHidden=“any text”||Display this text when the section is hidden||see below|
|onVisible=“any text”||Display this text when the section is unfolded||<hidden onHidden=“Click to read more” onVisible=“Click to see less”>Hidden text</hidden>|
|onExportPdf=“any text”||Display this text when the page is dw2pdf exported in pdf (defaults to the onVisible text)||<hidden onExportPdf=“you're reading a pdf, you can't click me”>hidden text</hidden>|
|initialState=“visible”||The block will initially be expanded. Readers may still click to hide it|
|-noprint||the text “click to display” won't appear on the printed copy|
|-edit=“any text”||Add an “edit” button below the hidden section.The text will appear when one let his mouse on the button|
|-edit||Same as above, but a default text is used|
Please note that Dokuwiki formatting syntax may be used with options like “onHidden”.
It's possible to add a button that will hide/display every hidden blocks at once using:
<hiddenSwitch Here comes my custom text>
Therefore, to see it in action, you could create such a page:
<hidden>My first hidden block</hidden> <hidden>My second hidden block</hidden> <hiddenSwitch>
Note: this feature used to be provided by a separate plugin. However, since “hidden v2015-08-12”, they have been merged
You may download this archive and unpack it in the /lib/plugins directory of your wiki.
You may also use the plugin manager, using this URL: https://github.com/gturri/hidden/zipball/master
Please use the bugtracker to report bugs, rather than using this page.
Consequently, before submitting a bug, please try to
This plugin is provided as a charityware. It can be downloaded and installed at no charge. If you found it useful and would like to support its development, you may make a donation to a non-profit charitable organization.
The preference goes to the World Wildlife Fund (WWF) because the are both protecting biodiversity and fighting climate change effectively.
If it isn't possible, any association acting for the environment would do the trick.
Forwarding me (address available at the top of the page) the confirmation email you send or receive will ensure your kind gesture will motivate me to continue developing this software.
Making sure you have a positive impact would already be awesome: