%%'' tag | ''%%%%'' tag |
| Can contain formatting | :-) | :-) |
| Can contain block elements((like tables, lists, new paragraphs, included files, etc.)) | --- | :-) |
| Can be used within a paragraph, table, list, etc. | :-) | --- |
You can see the plugin in action [[http://organact.mine.nu/dokuwiki/doku.php?id=wiki:playground|here]] FIXME.
^ Note: As of version 2005-09-02 the syntax has changed to allow linked titles to unfold and fold the section. The pipe char between title and text is mandatory. ^
===== Installation =====
You can install this plugin with the [[plugin]] manager.
To install the plugin manually:
- download the source to your plugin folder, ''lib/plugins''.
- extract the downloaded files contents.
That should create a new folder ''lib/plugins/folded'' containing all the files required by the plugin.
conf folder containing the configuration settings and their metadata
conf/default.php default values for configuration settings
conf/metadata.php configuration setting metadata used by [[plugin:config|Configuration Manger]]
lang folder containing all the localised language folders
lang/xx xx = language code, there maybe several of these, at least one being en for english
lang/xx/lang.php language strings for language code "xx"
lang/xx/settings.php configuration prompts used by [[plugin:config|Configuration Manger]]
script.js JavaScript to handle hiding and revealing of folded content
style.css styles for folding labels and folded content
open.gif arrow image pointing right
closed.gif arrow image pointing down
syntax folder containing the plugin scripts
syntax/span.php plugin script for inline folding (++)
syntax/div.php plugin script for block folded (++++)
The plugin is now installed.
===== Configuration =====
There are two configuration settings which can be used to override the folder link tooltips. These will be most useful for DokuWiki installations using a language not included with the plugin.
**reveal** --- the title tooltip to be used by folding links when the folded content is hidden. If left empty the localised string will be used.
**hide** --- the title tooltip to be used by folding links when the folded content is showing. If left empty the localised string will be used.
===== Localization =====
Please feel free to add the strings for your own language here and I will add them to the next release of the plugin. If your language isn't included at present, you can override the strings that are shown using the plugin's configuration settings as described above.
^Language ^title string ^title string ^alt string ^ alt string ^
^English ^reveal ^hide ^reveal hidden content ^hide content |
| | [...] | [...] | [...] |[...] |
There are also two strings used in the admin/configuration page.
^ Language ^ for hide string setting ^ for reveal string setting ^
| english | Folding tooltip to hide
(leave empty to use localized string) | Folding tooltip to reveal
(leave empty to use localized string) |
|... | [...] |[...] |
===== Bugs / Feature Requests =====
Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-folded/issues|Bug tracker]].
===== Revision List =====
[[https://github.com/feeds/dokufreaks/commits/plugin-folded/master|{{http://img529.imageshack.us/img529/5725/feedm.png|Recent commits to Folded Plugin (RSS feed)}}]]
{{rss>https://github.com/feeds/dokufreaks/commits/plugin-folded/master date}}
* 2008-08-13 --- Update plugin URL
* --- add Dutch and Russian language strings
* --- add support for unknown render formats (uses standard render functions for output, no folding)
* 2007-05-30 --- Language strings updated, **[[rc|RC2007-05-24]] & [[develonly]] only**
* --- hide & hidelong strings added for all those languages missing them
* --- Danish & Turkish strings added
* --- Turkish strings added
* 2007-01-24 --- Italian strings added, **darcs version only**
* 2006-12-15 --- Swedish strings added, **darcs version only**
* 2006-12-10 --- Updated release files for DokuWwiki 2006-11-06
* --- [[develonly]] darcs version updated for removal of domLib functions (DW patched 2006-11-10)
* 2006-05-22 --- [[develonly]] zh-tw strings added, **darcs version only**
* 2006-05-04 --- [[develonly]] Major revision
* JavaScript made unobtrusive
* fix hidden folded sections for browsers without JavaScript and for printing
* localised title tooltip prompts embedded in HTML comments where JavaScript can access them
* title tooltips can be overridden using config settings allowing wiki admins to use languages missing from the plugin.
* toggle graphic moved to background
* 2006-01-06 --- remove trim() from UNMATCHED rendering
* 2005-12-31 --- package update with language strings for cs (Czech), ja (Japanese), ko (Korean), po (Polish) & zh (Chinese). No source changes.
* 2005-09-18 --- source updated and initial release on darcs (see link above)
===== Requested Features / To Do =====
* allow title formatting --- //[[grokwik@free.fr|Fred]] 2007-06-20 15:54//
* Nesting folding sections... can be use for tree display and maybe other stuff ---- // Stephane Chamberland 2006-01-09 //
* When displaying search results, folded text needs to be displayed if it contains a search hit --- //[[henry.olders@mcgill.ca|Henry Olders]] 2006-04-08 //
* Make HTML id easier to understand. (for example I can put a link [[#requested_features_to_do|here]] based on the name, but the folded plugin ids are ''#folded_n'' - and if I link to that the folded section is not unfolded. This would make it much easier to do things for FAQs & such, like we are [[http://docs.blackfin.uclinux.org/doku.php?id=faq#folder_5|using]]. See?
* Have an "unfold all" option on the page, to allow browser text searches for pages like [[http://docs.blackfin.uclinux.org/doku.php?id=faq|this]].
* Have "fold all" option as well
Would it be possible to use an image instead of text? the idea is to have a small image "help.png" to open a local explanation in a box. Thank you. //[[emache47@gmail.com|Michel]] 2011-12-30//
===== Discussion =====
Please see the separate [[:plugin:folded:discussion|discussion]] page