Skip to content

Commit

Permalink
README and plugin info updated, getting ready to publish
Browse files Browse the repository at this point in the history
  • Loading branch information
medmen committed Jun 29, 2020
1 parent dbac9ce commit 03f544d
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 25 deletions.
46 changes: 34 additions & 12 deletions README.md
Expand Up @@ -4,12 +4,41 @@ plugin that makes an unordered list invisible after n items
## how to use?
simply wrap an unordered list into the tags

`<foldablelist>
my list
</foldablelist>`

```
<foldablelist>
* list item 1
* list item 2
* list item 3
</foldablelist>
```
this list can be generated via markup or dokuwiki plugins like the tag-plugin.

#### Advanced use
```
<foldablelist>
{{topic>ns1:sub-ns?tag}}
</foldablelist>
```
uses the tag plugin (topic component) to generate the list from all pages in the namespace ns1/sub-ns tagged with "tag"

## configuration
this plugin can be configured via dokuwikis admin config page
So far there is only 1 item to configure:

`collapse_after: 5` the number of list items to be displayed before hiding the rest of the list, default value: 5

#### new in 2020:
you can pass the config to every single instance:

```
<foldablelist collapse_after=2>
* list item 1
* list item 2
* list item 3
</foldablelist>
```
this will show only the first 2 items

## why use?
people like to put "important stuff" on startpage and the department i work in is not different.
Things considered "important" get written on startpage, usually as lists (upcoming meetings, changes in workflow, new orders by the boss ...)
Expand All @@ -20,13 +49,7 @@ or later my boss asked me to reduce the visible number of items on those lists t
a certain minimum.

This plugin adresses the issue in a quick and cosmetic way:
all information is still available, but (hopefully) less important stuff gets hidden by default.

## configuration
this plugin can be configured via dokuwikis admin config page
So far there is only 1 item to configure:

`collapse_after: 5` the number of list items to be displayed before hiding the rest of the list
all information is still available, but (hopefully) less important stuff gets hidden by default.

## great but i miss feature X
Feel free to improve, share and debug!
Expand All @@ -35,4 +58,3 @@ Feel free to improve, share and debug!
* found a bug? please report at github
* you are a programmer and want to improve the plugin?
Go ahead --> fork, rewrite, enhance and extend..

12 changes: 0 additions & 12 deletions action.php
Expand Up @@ -34,15 +34,3 @@ function addconfig2js($event, $params)
$JSINFO['plugin_foldablelist'] = $conf['plugin']['foldablelist'];
}
}

/**
public function register(Doku_Event_Handler $controller)
{
$controller->register_hook('PLUGIN_POPULARITY_DATA_SETUP', 'AFTER', $this, 'usage_data');
}

public function usage_data(Doku_Event $event)
{
$event->data['plugin_foldablelist'] = 'is used';
}
** /
2 changes: 1 addition & 1 deletion plugin.info.txt
@@ -1,7 +1,7 @@
base foldablelist
author medmen
email med-men@gmx.net
date 2019-03-17
date 2020-06-29
name foldablelist plugin
desc collapse a list after a configurable number of items
url https://github.com/medmen/dokuwiki-plugin-foldablelist

0 comments on commit 03f544d

Please sign in to comment.