DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:folded

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
plugin:folded [2017-05-30 18:09] – [Configuration]: updated LarsDW223plugin:folded [2023-08-14 14:10] (current) – [Folded Plugin] Updated compatibility: Seems to work fine on Jack Jackrum fiwswe
Line 6: Line 6:
 email      : freaks@dokuwiki.org email      : freaks@dokuwiki.org
 type       : syntax type       : syntax
-lastupdate : 2017-05-30 +lastupdate : 2023-07-22 
-compatible : Detritus, Hrun, Ponder Stibbons, Binky, Weatherwax, Adora Belle, Angua+compatible : Jack Jackrum, Igor, Hogfather, Greebo, Frusterick Manners, Detritus, Hrun, Ponder Stibbons, Binky, Weatherwax, Adora Belle, Angua
 depends    :  depends    : 
 conflicts  conflicts 
-similar    : hidden, outliner, inline_folding, inline_folding2, sectiontoggle +similar    : hidden, outliner, inline_folding, inline_folding2, sectiontoggle, spoiler, htmldetailstag, stepbystep 
-tags       : section, hide, collapsible+tags       : section, hide, collapsible, fold
  
 downloadurl: https://github.com/dokufreaks/plugin-folded/archive/master.zip downloadurl: https://github.com/dokufreaks/plugin-folded/archive/master.zip
Line 17: Line 17:
 bugtracker:  https://github.com/dokufreaks/plugin-folded/issues bugtracker:  https://github.com/dokufreaks/plugin-folded/issues
 ---- ----
- 
-===== Download ===== 
- 
-^ Download | [[https://github.com/dokufreaks/plugin-folded/tarball/master|Latest Archive]] | 
  
 ===== Description ===== ===== Description =====
Line 60: Line 56:
 | Can contain block elements((like tables, lists, new paragraphs, included files, etc.)) |  ---  |  :-)  | | Can contain block elements((like tables, lists, new paragraphs, included files, etc.)) |  ---  |  :-)  |
 | Can be used within a paragraph, table, list, 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. ^ ^ 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. ^
Line 68: Line 62:
 ===== Installation ===== ===== Installation =====
  
-You can install this plugin with the [[plugin]] manager+Search and install the plugin using the [[plugin:extension|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 it'cache. FIXME The previous is probably true for even more plugins, thus, a general important information.+:!: 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. FIXME The previous is probably true for even more plugins, thus, a general important information.
  
 Alternatively open the configuration page and save it. Alternatively open the configuration page and save it.
Line 110: Line 104:
  
 **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. **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.
 +
 +===== Styling =====
 +
 +The look of the folded sections can be customized by adding CSS code to [[devel:css#user_styles|userstyle.css]]. The following examples show the CSS selectors to be used to modify the style of the folded plugin:
 +
 +==== Example 1 ====
 +
 +Adding this CSS code to ''userstyles.css'' would give the clickable section a 2 pixel broad black border:
 +<code CSS>
 +.folder {
 +    border: 2px solid black;
 +}
 +
 +.folder.open {
 +    border: 2px solid black;
 +}
 +</code>
 +
 +The selector ''.folder'' can be used to control the style of the folded state and the selector ''.folder.open'' for controlling the unfolded state.
 +
 +==== Example 2 ====
 +
 +Adding this CSS code to ''userstyles.css'' would give the unfolded section a 2 pixel broad black border:
 +<code CSS>
 +div.folded {
 +    border: 2px solid black;
 +}
 +
 +span.folded {
 +    border: 2px solid black;
 +}
 +</code>
 +
 +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.
  
 ===== Localization ===== ===== Localization =====
Line 115: Line 143:
 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. 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            ^ +^ Language   ^ title string  ^ title string  ^ alt string                    ^ alt string            ^ 
-^ English   ^ reveal        ^ hide          ^ reveal hidden content         ^ hide content          ^ +^ English    ^ reveal        ^ hide          ^ reveal hidden content         ^ hide content          ^ 
-^ French    | révéler       | cacher        | révéler le contenu            | cacher le contenu     | +^ French     | révéler       | cacher        | révéler le contenu            | cacher le contenu     | 
-^ German    | aufdecken     | verstecken    | versteckten Inhalt aufdecken  | Inhalt verstecken     | +^ German     | aufdecken     | verstecken    | versteckten Inhalt aufdecken  | Inhalt verstecken     | 
-^ Korean    | 보이기           | 감추기           | 감춰진 내용 보이기                    | 내용 감추기                +^ Korean     | 보이기        | 감추기        | 감춰진 내용 보이기            | 내용 감추기           
-^ Swedish   | visa          | dölj          | visa dolt innehåll            | dölj innehåll         | +^ Swedish    | visa          | dölj          | visa dolt innehåll            | dölj innehåll         | 
-^ Italian   | mostra        | nascondi      | mostra i contenuti nascosti   | nascondi i contenuti +^ Italian    | mostra        | nascondi      | mostra i contenuti nascosti   | nascondi i contenuti 
-^ Chinese   | 显示            | 隐藏            | 显示隐藏的内容                       | 将内容隐藏                 +^ Chinese    | 显示          | 隐藏          | 显示隐藏的内容                | 将内容隐藏            
-^ Danish    | vis           | skjul         | vis skjult indhold            | skjul indhold         | +^ Danish     | vis           | skjul         | vis skjult indhold            | skjul indhold         | 
-^ Russian   | показать      | скрыть        | показать содержимое           | скрыть содержимое     | +^ Russian    | показать      | скрыть        | показать содержимое           | скрыть содержимое     | 
-^ Spanish   | muestra       | oculta        | muestra el contenido oculto   | oculta el contenido   | +^ Spanish    | muestra       | oculta        | muestra el contenido oculto   | oculta el contenido   | 
-Dutch     | tonen         | verbergen     | toon verborgen inhoud         | verberg inhoud        | +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. There are also two strings used in the admin/configuration page.
  
-^ Language ^ for hide string setting ^ for reveal string setting ^ +^ 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) | +| 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 />(현지화된 문자열을 사용하려면 공백으로 두세요) | +| Korean     | 감추기 위한 접기 풍선도움말<br />(현지화된 문자열을 사용하려면 공백으로 두세요)                       | 보이기 위한 접기 풍선도움말<br />(현지화된 문자열을 사용하려면 공백으로 두세요)                        
-|Chinese| 将工具条折叠来隐藏<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)  
 +| ...        | [...]                                                                                                 | [...]                                                                                                  | 
 + 
 +===== Nested Folds ===== 
 + 
 +With the help of the [[plugin:wrap|Wrap plugin]] you can create nested folds: 
 + 
 +<code> 
 +++++ Outer Fold | 
 + 
 +The trick is to wrap the inner fold: 
 + 
 +<WRAP> 
 + 
 +++++ Inner Fold | 
 + 
 +This is the content of the inner fold. 
 + 
 +++++ 
 + 
 +</WRAP> 
 + 
 +++++ 
 +</code> 
 + 
 +Another method to achieve nesting is the [[plugin:include|Include plugin]]. 
 ===== Bugs / Feature Requests ===== ===== Bugs / Feature Requests =====
 Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-folded/issues|Bug tracker]]. Please report bugs or feature requests at the [[https://github.com/dokufreaks/plugin-folded/issues|Bug tracker]].
Line 146: Line 206:
     * --- add Dutch and Russian language strings     * --- add Dutch and Russian language strings
     * --- add support for unknown render formats (uses standard render functions for output, no folding)     * --- 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**+  * 2007-05-30 --- Language strings updated, **RC2007-05-24 & [[devel:develonly]] only**
     * --- hide & hidelong strings added for all those languages missing them     * --- hide & hidelong strings added for all those languages missing them
     * --- Danish & Turkish strings added     * --- Danish & Turkish strings added
Line 152: Line 212:
   * 2007-01-24 --- Italian strings added, **darcs version only**   * 2007-01-24 --- Italian strings added, **darcs version only**
   * 2006-12-15 --- Swedish 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 +  * 2006-12-10 --- Updated release files for DokuWiki 2006-11-06 
-    * --- [[develonly]] darcs version updated for removal of domLib functions (DW patched 2006-11-10) +    * --- [[devel: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-22 --- [[devel:develonly]] zh-tw strings added, **darcs version only** 
-  * 2006-05-04 --- [[develonly]] Major revision+  * 2006-05-04 --- [[devel:develonly]] Major revision
     * JavaScript made unobtrusive     * JavaScript made unobtrusive
     * fix hidden folded sections for browsers without JavaScript and for printing     * fix hidden folded sections for browsers without JavaScript and for printing
Line 167: Line 227:
 ===== Old Releases ===== ===== Old Releases =====
  
-Previous releases can be found on [[https://github.com/dokufreaks/plugin-folded/releases|gitub]].+Previous releases can be found on [[https://github.com/dokufreaks/plugin-folded/releases|GitHub]].
  
 ===== Requested Features / To Do ===== ===== Requested Features / To Do =====
plugin/folded.1496160543.txt.gz · Last modified: 2017-05-30 18:09 by LarsDW223

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki