Compatible with DokuWiki
Similar to hidden, hiddenswitch, hidetext, htmldetailstag, inline_folding, inline_folding2, outliner, sectiontoggle, spoiler, spoiler2, stepbystep
This plugin is based on the inline folding plugin by ta' Lajżar and the slightly changed version thereof by Christopher Smith and Esther Brunner.
(A lot of the work was based on the older hacks by Chris Stoll. This one combines the features of all plugin variants in one.)
If you want to make additional information available that is hidden by default, you have two options with this plugin:
Inline:
This is example ++text | with some of it only shown when you unfold it++. And after that the text just continues to flow in the same paragraph.
This is example ++text | with some of it only shown when you unfold it++. And after that the text just continues to flow in the same paragraph.
Block:
This is example text. ++++ Title | | This table | is only shown | when you unfold the block | {{page>some other wiki page&inline}} ++++
Inline | Block | |
---|---|---|
Syntax | ++title| formatted text ++ | ++++title| any content ++++ |
HTML | <span> tag | <div> tag |
Can contain formatting | ||
Can contain block elements1) | — | |
Can be used within a paragraph, table, list, etc. | — |
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. |
---|
Search and install the plugin using the Extension Manager.
If you install this plugin manually (by copying the directory to the plugins directory) you need to clear DokuWikis cache in order to make this plugin working. Otherwise it won't fold/unfold correctly. To clear the cache open → modify any character → undo → save → close the file <YourDokuWikiRoot>/conf/local.php. This causes DokuWiki to rebuild its cache. The previous is probably true for even more plugins, thus, a general important information.
Alternatively open the configuration page and save it.
To install the plugin manually:
lib/plugins
.
That should create a new folder lib/plugins/folded
containing all the files required by the plugin.
action.php action part for making the translated/configured titles available in the JavaScript code 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.
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.
unfold_default — if this option is activated, then all sections will be unfolded per default.
show_fold_unfold_all_button — if this option is activated, then a button will be displayed in the toolbar. If it is clicked, the button folds or unfolds all sections at once.
The look of the folded sections can be customized by adding CSS code to userstyle.css. The following examples show the CSS selectors to be used to modify the style of the folded plugin:
Adding this CSS code to userstyles.css
would give the clickable section a 2 pixel broad black border:
.folder { border: 2px solid black; } .folder.open { border: 2px solid black; }
The selector .folder
can be used to control the style of the folded state and the selector .folder.open
for controlling the unfolded state.
Adding this CSS code to userstyles.css
would give the unfolded section a 2 pixel broad black border:
div.folded { border: 2px solid black; } span.folded { border: 2px solid black; }
The selector div.folded
can be used to control the style of a block section and the selector span.folded
for controlling the inline section.
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 |
French | révéler | cacher | révéler le contenu | cacher le contenu |
German | aufdecken | verstecken | versteckten Inhalt aufdecken | Inhalt verstecken |
Korean | 보이기 | 감추기 | 감춰진 내용 보이기 | 내용 감추기 |
Swedish | visa | dölj | visa dolt innehåll | dölj innehåll |
Italian | mostra | nascondi | mostra i contenuti nascosti | nascondi i contenuti |
Chinese | 显示 | 隐藏 | 显示隐藏的内容 | 将内容隐藏 |
Danish | vis | skjul | vis skjult indhold | skjul indhold |
Russian | показать | скрыть | показать содержимое | скрыть содержимое |
Spanish | muestra | oculta | muestra el contenido oculto | oculta el contenido |
Dutch | tonen | verbergen | toon verborgen inhoud | verberg inhoud |
Norwegian | vis | skjul | vis skjult innhold | skjul innhold |
Ukrainian | показати | приховати | показати вміст | приховати вміст |
Estonian | näita | peida | näita peidetud sisu | peida sisu |
Catalan | mostra | amaga | mostra el contingut amagat | amaga el contingut |
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<br />(leave empty to use localized string) | Folding tooltip to reveal<br />(leave empty to use localized string) |
Korean | 감추기 위한 접기 풍선도움말<br />(현지화된 문자열을 사용하려면 공백으로 두세요) | 보이기 위한 접기 풍선도움말<br />(현지화된 문자열을 사용하려면 공백으로 두세요) |
Chinese | 将工具条折叠来隐藏<br />(要使用本地化的字符串则留空) | 展开工具条来显示<br />(要使用本地化的字符串则留空) |
Russian | Подсказка для отображения содержимого<br />(оставьте пустым для использования значения по умолчанию) | Подсказка для сокрытия содержимого<br />(оставьте пустым для использования значения по умолчанию) |
Ukrainian | Підказка для відображення вмісту<br />(залиште порожнім для використання значення за замовчуванням) | Підказка для приховування вмісту<br />(залиште порожнім для використання значення за замовчуванням) |
Estonian | voltimise vihje peitmiseks<br />(jäta tühjaks, et kuvataks lokaliseeritud vaikimisi väärtust) | voltimise vihje näitamiseks<br />(jäta tühjaks, et kuvataks lokaliseeritud vaikimisi väärtust) |
Catalan | Etiqueta d'indicador de funció per amagar<br />(deixeu-la en blanc per utilitzar la cadena traduïda) | Etiqueta d'indicador de funció per mostrar<br />(deixeu-la en blanc per utilitzar la cadena traduïda) |
… | […] | […] |
With the help of the Wrap plugin you can create nested folds:
++++ Outer Fold | The trick is to wrap the inner fold: <WRAP> ++++ Inner Fold | This is the content of the inner fold. ++++ </WRAP> ++++
Another method to achieve nesting is the Include plugin.
Please report bugs or feature requests at the Bug tracker.
Previous releases can be found on GitHub.
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. Michel 2011-12-30
Please see the separate discussion page.