DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:outliner

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:outliner [2012-11-28 00:35] – issue is already moved to github Klap-inplugin:outliner [2024-01-24 06:32] (current) Aleksandr
Line 1: Line 1:
-====== Outliner plugin ======+====== Outliner Plugin ======
  
 ---- plugin ---- ---- plugin ----
-description: Enable collapsible outline tree page layout(Previous author: Pavel Vitis) +description: Enable collapsible outline tree page layout 
-author     : Michael Hamann, Pavel Vitis +author     : Vincent31FR (Previous author: Michael Hamann, Pavel Vitis) 
-email      : michael@content-space.de+email      : 
 type       : syntax type       : syntax
-lastupdate : 2010-03-12 +lastupdate : 2024-01-23 
-compatible : 2005-08-022006-11-062009-12-25c+compatible : AnguaAdora BelleWeatherwax, Hrun, Detritus, Hogfather
 depends    :  depends    : 
-conflicts  :  +conflicts include 
-similar    : folded, hidden+similar    : folded, hidden, sectiontoggle
 tags       : collapsible, hide tags       : collapsible, hide
-downloadurl: https://github.com/michitux/dokuwiki-plugin-outliner/tarball/devel + 
-sourcerepo : https://github.com/michitux/dokuwiki-plugin-outliner/ +downloadurl: https://github.com/Vincent31Fr/dokuwiki-plugin-outliner/tarball/master 
-bugtracker : https://github.com/michitux/dokuwiki-plugin-outliner/issues+sourcerepo : https://github.com/Vincent31Fr/dokuwiki-plugin-outliner/ 
 +bugtracker : https://github.com/Vincent31Fr/dokuwiki-plugin-outliner/issues 
 +donationurl:  
 +screenshot_img: https://raw.githubusercontent.com/Vincent31Fr/dokuwiki-plugin-outliner/master/screenshots/dokuwiki_plugin_outliner.PNG
 ---- ----
  
-This plugin provides syntax for collapsible sections. It includes support for section titles, nesting, a preview of the section when the mouse is over a closed section title, saving of the current state in cookies and sections opened by default.+:!: If you are upgrading this plugin please read the [[#changelog]]
  
-This plugin was unmaintained and has been restructured and almost completely rewrittenThe old version is available at [[https://github.com/downloads/michitux/dokuwiki-plugin-outliner/dokuwiki-plugin-outliner-2010-03-12.zip|github]]but please aware that it is brokene.g. it doesn't work at all when you enable previews (see below for details). There is new version available in the devel branch of the source repository, it can be downloaded at the link provided above. It still doesn't work in Internet Explorer 6but in the other browsers it should work. Please test the code and report bugs. Feedback concerning the visual appearance is also highly appreciated. The behavior in details and the visual appearance are still subject to change.+This plugin provides syntax for collapsible sectionsIt includes support for section titles linknesting, a preview of the section when the mouse is over a closed section titlesaving of the current state in localStorage and sections opened by default.
  
 ===== Usage ===== ===== Usage =====
  
-The beginning of a section has to be marked with <code>--> Title[FLAGS]</code>, [FLAGS] is optional and can be: +The beginning of a section has to be marked with ''%%--> Title[FLAGS]%%''''[FLAGS]'' is optional and can be: 
-  * # for no preview +  * ''#'' for no preview 
-  * ^ for opened by default+  * ''^'' for opened by default 
 +  * ''@'' for internal wiki link in title
  
-Sections can be closed by using <code><--</code> on a new line. Sections can also be nested. Example:+Sections can be closed by using ''%%<--%%'' on a new line. Sections can also be nested. Example:
  
 <code> <code>
Line 45: Line 49:
  
 <-- <--
-</code> 
  
-===== Development and issues =====+--> [[ plugin:outliner| Outliner]] @
  
-I've added the code to my github account, URL see above, fixed a HTML/JS injection and provided a download. I will probably try to restructure that plugin as it's not just a simple fix that's necessary. If somebody wants to help, just contact me (e.g. using the bugtracker or my email address), patches are welcome, please use the bugtracker.  --- //[[michael@content-space.de|Michitux]] 2010/03/04 10:57//+<-- 
 +</code>
  
-Github [[http://github.com/michitux/dokuwiki-plugin-outliner/issues|Issue tracker]]+Formatting syntax, like lists, can be used within a block, but a blank line must be included before closing the block.
  
- 
-===== Notes concerning the "old" plugin ===== 
- 
-[[http://blackdaemon.no-ip.org/wiki/dokuwiki:plugin:outliner|Details and Download]] FIXME 
- 
-It does work with the current release (2009-12-25c), at least as far as I tried it but you have to disable the mouse over effect by adding a # after each outline syntax. It also seems to be necessary to keep one line spacing from the syntax to the rest of the wiki text or code. 
- 
-Example: 
 <code> <code>
---> Group1 #+--> First Section# 
 +  * A list item 
 +  * Another list item
  
-  * Item 1 +<-- 
-  * Item 2 +--> Second Section
-  +Content 
-<-- Group1 +<--</code>
-</code> +
- +
-%%--> Group1 #%% +
- +
-  * Item 1 +
-  * Item 2 +
-  +
-%%<-- Group1%% +
- +
-If someone with more PHP background could strip down the code to the stuff that is working with the current release would be very appreciated. +
- +
-If you have problems with the output of this plugin, make sure the added newlines do not contain any white spaces. Otherwise the rendering output may be a mess or sometimes just not complete. Use a text editor of your choice that can display white spaces to clean up the page from white spaces in between the Group and the item elements. -This worked for me using this plugin on DokuWiki 2009-12-25c inside the sidebar when using the arctic template.+
  
 +===== Settings =====
  
 +There is currently just one setting ''useLocalStorage'' that controls if the current state of all sections shall be stored in LocalStorage for each section and is disabled per default.
  
 +===== Changelog =====
 +  * **2021-06-21** 
 +    * Use of localStorage instead of cookie 
 +    * Add possibility to use internal wiki link in title
 +  * **2013-08-01**
 +    * Fix the CSS code to be valid so it won't break the LESS parser (which will probably be introduced in the next DokuWiki release)
 +  * **2013-02-22**
 +    * Migrated the plugin to jQuery so the plugin will still work in the next DokuWiki release (but doesn't work anymore in Rincewind or older).
 +    * Fundamentally changed the cookie support:
 +      * Cookies are now disabled per default, but can be enabled again in the settings
 +      * The ids for the sections are now only based on the id of the page and the position in the page and no longer randomly generated, this means that the cookies should work a lot more reliably
 +      * The outliner plugin no longer uses the settings cookie but it's own cookies that expire after 7 days (previously the values were stored in the settings cookie and were never deleted which could produce a lot of garbage)
 +      * the old values are removed from the settings cookie
  
 +===== Issues =====
  
 +Please report any issues in the [[https://github.com/michitux/dokuwiki-plugin-outliner/issues|Issue tracker]].
plugin/outliner.1354059341.txt.gz · Last modified: 2012-11-28 00:35 by Klap-in

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