# Render List Plugin Render bullet lists in a variety of formats ## Syntax Rules - Place a `%RENDERLIST{ }%` before any bullet list - The lists can be handcrafted, generated by another Plugin, a `%TOC%`, or the result of a [[FormattedSearch]] - Supported parameters:

`"name"` or%BR% `theme="name"`	Select a rendering theme
`focus="any text"`	Focus list on a bullet with specified text
`depth="2"`	Remove bullets with an indent greater then the depth. The depth is relative to the highlighted bullet in case `focus` is specified

- Rendering themes can be defined by `_THEME` Plugin settings - Each theme is defined by a comma separated list containing the render type and parameters required by that render type - There are different render types; this initial Plugin version has **tree** and **icon** render types - Format of the **tree** render type: - `Set _THEME = tree, <0/1 flag to suppress/show lines of first level>` - Format of the **icon** render type: - `Set _THEME = icon, <0/1 flag to suppress/show lines of first level>, , , , , , , ` - To define new Icon themes, attach images to this Plugin topic and set the parameters accordingly - Focus bullet list: - Search bullet list for text. If a bullet is found: 1. Highlight text and remove `[[][]]` links on bullet where text is found 2. Reduce bullet list to show only its parents and children - This is useful to maintain one large bullet list with links to team pages, representing the organization of a company. Each team page can INCLUDE the bullet list with focus set to itself. ## Examples

You type:

You get: (simulated)

You get: (if installed)

%RENDERLIST{"thread"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
			  continue
	* two
	* three

one

one.a

one.a.x

one.b

one.b.x

continue

one.b.y

continue

two

three

%RENDERLIST{"thread"}%

one
- one.a
  - one.a.x
- one.b
  - one.b.x continue
  - one.b.y continue
two
three

%RENDERLIST{"org"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
			  continue
	* two
	* three

one

one.a

one.a.x

one.b

one.b.x

continue

one.b.y

continue

two

three

%RENDERLIST{"org"}%

one
- one.a
  - one.a.x
- one.b
  - one.b.x continue
  - one.b.y continue
two
three

%RENDERLIST{ "org" focus="one.b" }%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
			  continue
	* two
	* three

one

one.b

one.b.x

continue

one.b.y

continue

%RENDERLIST{ "org" focus="one.b" }%

one
- one.a
  - one.a.x
- one.b
  - one.b.x continue
  - one.b.y continue
two
three

## %TOPIC% Settings Plugin settings are stored as preferences variables. To reference a plugin setting write **%<plugin>\_<setting>%**, i.e. **%RENDERPLUGIN\_SHORTDESCRIPTION%** - One line description, is shown in the [[TextFormattingRules]] topic: - Set SHORTDESCRIPTION = Render bullet lists in a variety of formats - Debug plugin: (See output in `data/debug.txt`) - Set DEBUG = 0 - Themes are named `_THEME` and contain a comma delimited list of render type with parameters: - Set THREAD\_THEME = tree, 1 - Set HOME\_THEME = icon, 1, 16, 16, ![empty.gif](http://www.dementia.org/twiki//view/empty.gif), ![dot\_udr.gif](http://www.dementia.org/twiki//view/dot_udr.gif), ![dot\_ud.gif](http://www.dementia.org/twiki//view/dot_ud.gif), ![dot\_ur.gif](http://www.dementia.org/twiki//view/dot_ur.gif), ![home.gif](http://www.dementia.org/twiki//view/home.gif) - Set ORG\_THEME = icon, 0, 16, 16, ![empty.gif](http://www.dementia.org/twiki//view/empty.gif), ![dot\_udr.gif](http://www.dementia.org/twiki//view/dot_udr.gif), ![dot\_ud.gif](http://www.dementia.org/twiki//view/dot_ud.gif), ![dot\_ur.gif](http://www.dementia.org/twiki//view/dot_ur.gif), ![home.gif](http://www.dementia.org/twiki//view/home.gif) - Set GROUP\_THEME = icon, 0, 16, 16, ![empty.gif](http://www.dementia.org/twiki//view/empty.gif), ![dot\_udr.gif](http://www.dementia.org/twiki//view/dot_udr.gif), ![dot\_ud.gif](http://www.dementia.org/twiki//view/dot_ud.gif), ![dot\_ur.gif](http://www.dementia.org/twiki//view/dot_ur.gif), ![group.gif](http://www.dementia.org/twiki//view/group.gif) - Set EMAIL\_THEME = icon, 0, 16, 16, ![empty.gif](http://www.dementia.org/twiki//view/empty.gif), ![dot\_udr.gif](http://www.dementia.org/twiki//view/dot_udr.gif), ![dot\_ud.gif](http://www.dementia.org/twiki//view/dot_ud.gif), ![dot\_ur.gif](http://www.dementia.org/twiki//view/dot_ur.gif), ![email.gif](http://www.dementia.org/twiki//view/email.gif) ## Plugin Installation Instructions **_Note:_** You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running. - Download the ZIP file from the Plugin web (see below) - Unzip **%TOPIC%.zip** in your twiki installation directory. Content:

File:	Description:
`data/TWiki/%TOPIC%.txt`	Plugin topic
`data/TWiki/%TOPIC%.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/%TOPIC%.pm`	Plugin Perl module
`pub/TWiki/%TOPIC%/*.gif`	Image files for themes

- Test if the installation was successful: - See if the above example works ## Plugin Info

Plugin Author:	TWiki:Main/PeterThoeny
Plugin Version:	11 Dec 2003 (V1.020)
Change History:
11 Dec 2003:	Added `focus` and `depth` parameters
05 Dec 2003:	Fixed rendering issue with IE, added EMAIL_THEME
02 Dec 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev

**_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], TWiki:Plugins/TreePlugin -- TWiki:Main/PeterThoeny - 11 Dec 2003