none
[openafs-wiki.git] / TWiki / RenderListPlugin.mdwn
1 # <a name="Render List Plugin"></a> Render List Plugin
2
3 Render bullet lists in a variety of formats
4
5 ## <a name="Syntax Rules"></a> Syntax Rules
6
7 ### <a name="RENDERLIST Variable"></a> RENDERLIST Variable
8
9 - Place a `%RENDERLIST{ <parameters> }%` before any bullet list
10   - The lists can be handcrafted, generated by another Plugin, a `%TOC%`, or the result of a [[FormattedSearch]]
11 - Supported parameters: <table border="1" cellpadding="0" cellspacing="0">
12   <tr>
13     <td><code>"name"</code> or%BR% <code>theme="name"</code></td>
14     <td> Select a rendering theme </td>
15   </tr>
16   <tr>
17     <td><code>focus="any text"</code></td>
18     <td> Focus list on a bullet with specified text </td>
19   </tr>
20   <tr>
21     <td><code>depth="2"</code></td>
22     <td> Remove bullets with an indent greater then the depth. The depth is relative to the highlighted bullet in case <code>focus</code> is specified </td>
23   </tr>
24 </table>
25 - Rendering themes can be defined by `<name>_THEME` Plugin settings
26   - Each theme is defined by a comma separated list containing the render type and parameters required by that render type
27   - There are different render types; this initial Plugin version has **tree** and **icon** render types
28 - Format of the **tree** render type:
29   - `Set <name>_THEME = tree, <0/1 flag to suppress/show lines of first level>`
30 - Format of the **icon** render type:
31   - `Set <name>_THEME = icon, <0/1 flag to suppress/show lines of first level>, <icon width>, <icon height>, <spacer graph>, <T-line graph>, <I-line graph>, <L-line graph>, <icon image>`
32   - To define new Icon themes, attach images to this Plugin topic and set the parameters accordingly
33 - Focus bullet list:
34   - Search bullet list for text. If a bullet is found:
35     1. Highlight text and remove `[[][]]` links on bullet where text is found
36     2. Reduce bullet list to show only its parents and children
37   - 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.
38
39 ### <a name="Bullets"></a> Bullets
40
41 - Use regular <code>**\***</code> bullets
42 - Start with level one
43   - Increase indentation only one level at a time
44     - `Like this`
45 - Decreasing indentation many levels at a time is OK
46 - Wrap long text with continuation lines, the Plugin does not do that for you%BR% `Align continuation lines with leading spaces like this`
47 - You can specify an icon for a bullet of render type **tree** or **icon**:
48   - Attach the icon to this Plugin topic, e.g. `myicon.gif`, or
49   - Use one of the existing icons: ![globe.gif](http://www.dementia.org/twiki//view/globe.gif) `globe.gif`, ![home.gif](http://www.dementia.org/twiki//view/home.gif) `home.gif`, ![virtualhome.gif](http://www.dementia.org/twiki//view/virtualhome.gif) `virtualhome.gif`, ![group.gif](http://www.dementia.org/twiki//view/group.gif) `group.gif`, ![persons.gif](http://www.dementia.org/twiki//view/persons.gif) `persons.gif`, ![virtualpersons.gif](http://www.dementia.org/twiki//view/virtualpersons.gif) `virtualpersons.gif`, ![person.gif](http://www.dementia.org/twiki//view/person.gif) `person.gif`, ![virtualperson.gif](http://www.dementia.org/twiki//view/virtualperson.gif) `virtualperson.gif`, ![email.gif](http://www.dementia.org/twiki//view/email.gif) `email.gif`, ![trend.gif](http://www.dementia.org/twiki//view/trend.gif) `trend.gif`, ![folder.gif](http://www.dementia.org/twiki//view/folder.gif) `folder.gif`, ![folders.gif](http://www.dementia.org/twiki//view/folders.gif) `folders.gif`, ![file.gif](http://www.dementia.org/twiki//view/file.gif) `file.gif`, ![files.gif](http://www.dementia.org/twiki//view/files.gif) `files.gif`, ![doc.gif](http://www.dementia.org/twiki//view/doc.gif) `doc.gif`, ![image.gif](http://www.dementia.org/twiki//view/image.gif) `image.gif`, ![pdf.gif](http://www.dementia.org/twiki//view/pdf.gif) `pdf.gif`, ![ppt.gif](http://www.dementia.org/twiki//view/ppt.gif) `ppt.gif`, ![sound.gif](http://www.dementia.org/twiki//view/sound.gif) `sound.gif`, ![xls.gif](http://www.dementia.org/twiki//view/xls.gif) `xls.gif`, ![zip.gif](http://www.dementia.org/twiki//view/zip.gif) `zip.gif`, ![see.gif](http://www.dementia.org/twiki//view/see.gif) `see.gif`
50   - Refer to an attached icon at the beginning of the bullet with:
51     - `icon:myicon Followed by normal bullet text`
52   - Any [[TWikiDocGraphics]] icon can be used as well:
53     - `%ICON{name}% Followed by normal bullet text`
54
55 ## <a name="Examples"></a> Examples
56
57 <table border="0" cellpadding="3" cellspacing="5">
58   <tr>
59     <th bgcolor="#CCCCC" valign="top"><strong><em>You type:</em></strong></th>
60     <th bgcolor="#CCCCC" valign="top"><strong><em>You get: (simulated)</em></strong></th>
61     <th bgcolor="#CCCCC" valign="top"><strong><em>You get: (if installed)</em></strong></th>
62   </tr>
63   <tr>
64     <td bgcolor="#EEEEEE" valign="top"><pre>
65 %RENDERLIST{"thread"}%
66         * one
67                 * one.a
68                         * one.a.x
69                 * one.b
70                         * one.b.x
71                           continue
72                         * one.b.y
73                                 * icon:person Tim
74                                 * icon:person Mico
75         * two
76         * three
77 </pre></td>
78     <td bgcolor="#EEEEEE" valign="top">
79       <p>
80       </p>
81       <table border="0" cellpadding="0" cellspacing="0">
82         <tr>
83           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
84           <td valign="top"><nobr> one </nobr></td>
85         </tr>
86       </table>
87       <table border="0" cellpadding="0" cellspacing="0">
88         <tr>
89           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
90           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
91           <td valign="top"><nobr> one.a </nobr></td>
92         </tr>
93       </table>
94       <table border="0" cellpadding="0" cellspacing="0">
95         <tr>
96           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
97           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
98           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
99           <td valign="top"><nobr> one.a.x </nobr></td>
100         </tr>
101       </table>
102       <table border="0" cellpadding="0" cellspacing="0">
103         <tr>
104           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
105           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
106           <td valign="top"><nobr> one.b </nobr></td>
107         </tr>
108       </table>
109       <table border="0" cellpadding="0" cellspacing="0">
110         <tr>
111           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
112           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
113           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
114           <td valign="top"><nobr> one.b.x </nobr></td>
115         </tr>
116       </table>
117       <table border="0" cellpadding="0" cellspacing="0">
118         <tr>
119           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
120           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
121           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
122           <td valign="top"><nobr> continue </nobr></td>
123         </tr>
124       </table>
125       <table border="0" cellpadding="0" cellspacing="0">
126         <tr>
127           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
128           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
129           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
130           <td valign="top"><nobr> one.b.y </nobr></td>
131         </tr>
132       </table>
133       <table border="0" cellpadding="0" cellspacing="0">
134         <tr>
135           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
136           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
137           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
138           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
139           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
140           <td valign="top"><nobr> Tim </nobr></td>
141         </tr>
142       </table>
143       <table border="0" cellpadding="0" cellspacing="0">
144         <tr>
145           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
146           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
147           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
148           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
149           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
150           <td valign="top"><nobr> Mico </nobr></td>
151         </tr>
152       </table>
153       <table border="0" cellpadding="0" cellspacing="0">
154         <tr>
155           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
156           <td valign="top"><nobr> two </nobr></td>
157         </tr>
158       </table>
159       <table border="0" cellpadding="0" cellspacing="0">
160         <tr>
161           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
162           <td valign="top"><nobr> three </nobr></td>
163         </tr>
164       </table>
165       <p>
166       </p>
167     </td>
168     <td bgcolor="#EEEEEE" valign="top">
169       <p> %RENDERLIST{"thread"}% </p>
170       <ul>
171         <li> one <ul>
172             <li> one.a <ul>
173                 <li> one.a.x </li>
174               </ul>
175             </li>
176             <li> one.b <ul>
177                 <li> one.b.x continue </li>
178                 <li> one.b.y <ul>
179                     <li> icon:person Tim </li>
180                     <li> icon:person Mico </li>
181                   </ul>
182                 </li>
183               </ul>
184             </li>
185           </ul>
186         </li>
187         <li> two </li>
188         <li> three </li>
189       </ul>
190       <p>
191       </p>
192     </td>
193   </tr>
194   <tr>
195     <td bgcolor="#EEEEEE" valign="top"><pre>
196 %RENDERLIST{"org"}%
197         * one
198                 * one.a
199                         * one.a.x
200                 * one.b
201                         * one.b.x
202                           continue
203                         * one.b.y
204                                 * icon:person Tim
205                                 * icon:person Mico
206         * two
207         * three
208 </pre></td>
209     <td bgcolor="#EEEEEE" valign="top">
210       <p>
211       </p>
212       <table border="0" cellpadding="0" cellspacing="0">
213         <tr>
214           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
215           <td valign="top"><nobr>  one </nobr></td>
216         </tr>
217       </table>
218       <table border="0" cellpadding="0" cellspacing="0">
219         <tr>
220           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
221           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
222           <td valign="top"><nobr>  one.a </nobr></td>
223         </tr>
224       </table>
225       <table border="0" cellpadding="0" cellspacing="0">
226         <tr>
227           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
228           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
229           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
230           <td valign="top"><nobr>  one.a.x </nobr></td>
231         </tr>
232       </table>
233       <table border="0" cellpadding="0" cellspacing="0">
234         <tr>
235           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
236           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
237           <td valign="top"><nobr>  one.b </nobr></td>
238         </tr>
239       </table>
240       <table border="0" cellpadding="0" cellspacing="0">
241         <tr>
242           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
243           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
244           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
245           <td valign="top"><nobr>  one.b.x </nobr></td>
246         </tr>
247       </table>
248       <table border="0" cellpadding="0" cellspacing="0">
249         <tr>
250           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
251           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
252           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
253           <td valign="top"><nobr>  continue </nobr></td>
254         </tr>
255       </table>
256       <table border="0" cellpadding="0" cellspacing="0">
257         <tr>
258           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
259           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
260           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
261           <td valign="top"><nobr>  one.b.y </nobr></td>
262         </tr>
263       </table>
264       <table border="0" cellpadding="0" cellspacing="0">
265         <tr>
266           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
267           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
268           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
269           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
270           <td valign="top"><nobr>  Tim </nobr></td>
271         </tr>
272       </table>
273       <table border="0" cellpadding="0" cellspacing="0">
274         <tr>
275           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
276           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
277           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
278           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
279           <td valign="top"><nobr>  Mico </nobr></td>
280         </tr>
281       </table>
282       <table border="0" cellpadding="0" cellspacing="0">
283         <tr>
284           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
285           <td valign="top"><nobr>  two </nobr></td>
286         </tr>
287       </table>
288       <table border="0" cellpadding="0" cellspacing="0">
289         <tr>
290           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
291           <td valign="top"><nobr>  three </nobr></td>
292         </tr>
293       </table>
294       <p>
295       </p>
296     </td>
297     <td bgcolor="#EEEEEE" valign="top">
298       <p> %RENDERLIST{"org"}% </p>
299       <ul>
300         <li> one <ul>
301             <li> one.a <ul>
302                 <li> one.a.x </li>
303               </ul>
304             </li>
305             <li> one.b <ul>
306                 <li> one.b.x continue </li>
307                 <li> one.b.y <ul>
308                     <li> icon:person Tim </li>
309                     <li> icon:person Mico </li>
310                   </ul>
311                 </li>
312               </ul>
313             </li>
314           </ul>
315         </li>
316         <li> two </li>
317         <li> three </li>
318       </ul>
319       <p>
320       </p>
321     </td>
322   </tr>
323   <tr>
324     <td bgcolor="#EEEEEE" valign="top"><pre>
325 %RENDERLIST{ "org" focus="one.b" }%
326         * one
327                 * one.a
328                         * one.a.x
329                 * one.b
330                         * one.b.x
331                           continue
332                         * one.b.y
333                                 * icon:person Tim
334                                 * icon:person Mico
335         * two
336         * three
337 </pre></td>
338     <td bgcolor="#EEEEEE" valign="top">
339       <p>
340       </p>
341       <table border="0" cellpadding="0" cellspacing="0">
342         <tr>
343           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
344           <td valign="top"><nobr>  one </nobr></td>
345         </tr>
346       </table>
347       <table border="0" cellpadding="0" cellspacing="0">
348         <tr>
349           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
350           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
351           <td valign="top"><nobr>  <b> one.b </b> </nobr></td>
352         </tr>
353       </table>
354       <table border="0" cellpadding="0" cellspacing="0">
355         <tr>
356           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
357           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
358           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
359           <td valign="top"><nobr>  one.b.x </nobr></td>
360         </tr>
361       </table>
362       <table border="0" cellpadding="0" cellspacing="0">
363         <tr>
364           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
365           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
366           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
367           <td valign="top"><nobr>  continue </nobr></td>
368         </tr>
369       </table>
370       <table border="0" cellpadding="0" cellspacing="0">
371         <tr>
372           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
373           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
374           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
375           <td valign="top"><nobr>  one.b.y </nobr></td>
376         </tr>
377       </table>
378       <table border="0" cellpadding="0" cellspacing="0">
379         <tr>
380           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
381           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
382           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
383           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
384           <td valign="top"><nobr>  Tim </nobr></td>
385         </tr>
386       </table>
387       <table border="0" cellpadding="0" cellspacing="0">
388         <tr>
389           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
390           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
391           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
392           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
393           <td valign="top"><nobr>  Mico </nobr></td>
394         </tr>
395       </table>
396       <p>
397       </p>
398     </td>
399     <td bgcolor="#EEEEEE" valign="top">
400       <p> %RENDERLIST{ "org" focus="one.b" }% </p>
401       <ul>
402         <li> one <ul>
403             <li> one.a <ul>
404                 <li> one.a.x </li>
405               </ul>
406             </li>
407             <li> one.b <ul>
408                 <li> one.b.x continue </li>
409                 <li> one.b.y <ul>
410                     <li> icon:person Tim </li>
411                     <li> icon:person Mico </li>
412                   </ul>
413                 </li>
414               </ul>
415             </li>
416           </ul>
417         </li>
418         <li> two </li>
419         <li> three </li>
420       </ul>
421       <p>
422       </p>
423     </td>
424   </tr>
425 </table>
426
427 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
428
429 Plugin settings are stored as preferences variables. To reference a plugin setting write <code>**%&lt;plugin&gt;\_&lt;setting&gt;%**</code>, i.e. <code>**%RENDERPLUGIN\_SHORTDESCRIPTION%**</code>
430
431 - One line description, is shown in the [[TextFormattingRules]] topic:
432   - Set SHORTDESCRIPTION = Render bullet lists in a variety of formats
433
434 - Debug plugin: (See output in `data/debug.txt`)
435   - Set DEBUG = 0
436
437 - Themes are named `<SOMETHING>_THEME` and contain a comma delimited list of render type with parameters:
438   - Set THREAD\_THEME = tree, 1
439   - 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)
440   - 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)
441   - 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)
442   - 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)
443   - Set TREND\_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), ![trend.gif](http://www.dementia.org/twiki//view/trend.gif)
444   - Set FILE\_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), ![file.gif](http://www.dementia.org/twiki//view/file.gif)
445
446 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
447
448 **_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 TWiki server.
449
450 - Download the ZIP file from the Plugin web (see below)
451 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
452   <tr>
453     <th bgcolor="#99CCCC"><strong> File: </strong></th>
454     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
455   </tr>
456   <tr>
457     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
458     <td> Plugin topic </td>
459   </tr>
460   <tr>
461     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
462     <td> Plugin topic repository </td>
463   </tr>
464   <tr>
465     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
466     <td> Plugin Perl module </td>
467   </tr>
468   <tr>
469     <td><code><b>pub/TWiki/%TOPIC%/*.gif</b></code></td>
470     <td> Image files for themes </td>
471   </tr>
472 </table>
473 - TWiki 4.0 and up: Run the [configure](http://www.dementia.org/twiki//configure) script to enable the Plugin
474 - Test if the installation was successful: See if above examples work
475
476 ## <a name="Plugin Info"></a> Plugin Info
477
478 <table border="1" cellpadding="0" cellspacing="0">
479   <tr>
480     <td align="right"> Plugin Author: </td>
481     <td> TWiki:Main/PeterThoeny </td>
482   </tr>
483   <tr>
484     <td align="right"> Copyright: </td>
485     <td> © 2006, <a href="http://www.structuredwikis.com/peter.html" target="_top">Peter Thoeny</a></td>
486   </tr>
487   <tr>
488     <td align="right"> License: </td>
489     <td> GPL (<a href="http://www.gnu.org/copyleft/gpl.html" target="_top">GNU General Public License</a>) </td>
490   </tr>
491   <tr>
492     <td align="right"> Plugin Version: </td>
493     <td> 23 Sep 2006 (V1.034) </td>
494   </tr>
495   <tr>
496     <td align="right"> Change History: </td>
497     <td>  </td>
498   </tr>
499   <tr>
500     <td align="right"> 23 Sep 2006: </td>
501     <td> Support for img tag and image URL after <code>icon:</code> (suggested by TWiki:Main.JanFilipsky); support for [[TWiki/TWikiDocGraphics]] icons, such as <code>%ICON{folder}%</code> instead of <code>icon:folder</code>; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs) </td>
502   </tr>
503   <tr>
504     <td align="right"> 25 Apr 2006: </td>
505     <td> SVN sync, Cairo + Dakar compatibility </td>
506   </tr>
507   <tr>
508     <td align="right"> 14 Apr 2006: </td>
509     <td><a href="http://TWiki.org/cgi-bin/view/Codev/TWikiRelease04x00" target="_top">TWikiRelease04x00</a> compatibility update </td>
510   </tr>
511   <tr>
512     <td align="right"> 21 Nov 2004: </td>
513     <td> Added benchmarks (no code changes) </td>
514   </tr>
515   <tr>
516     <td align="right"> 21 Mar 2004: </td>
517     <td> Internal change: Fixed unofficial function call </td>
518   </tr>
519   <tr>
520     <td align="right"> 01 Mar 2004: </td>
521     <td> Added FILE_THEME and folder/file icons </td>
522   </tr>
523   <tr>
524     <td align="right"> 29 Dec 2003: </td>
525     <td> Fixed rendering issue if focus bullet contains <code>icon:name</code>; added TREND_THEME </td>
526   </tr>
527   <tr>
528     <td align="right"> 16 Dec 2003: </td>
529     <td> Specify icons with <code>icon:name</code> syntax </td>
530   </tr>
531   <tr>
532     <td align="right"> 11 Dec 2003: </td>
533     <td> Added <code>focus</code> and <code>depth</code> parameters </td>
534   </tr>
535   <tr>
536     <td align="right"> 05 Dec 2003: </td>
537     <td> Fixed rendering issue with IE; added EMAIL_THEME </td>
538   </tr>
539   <tr>
540     <td align="right"> 02 Dec 2003: </td>
541     <td> Initial version </td>
542   </tr>
543   <tr>
544     <td align="right"> CPAN Dependencies: </td>
545     <td> none </td>
546   </tr>
547   <tr>
548     <td align="right"> Other Dependencies: </td>
549     <td> none </td>
550   </tr>
551   <tr>
552     <td align="right"> Perl Version: </td>
553     <td> 5.005 </td>
554   </tr>
555   <tr>
556     <td align="right"> TWiki:Plugins/Benchmark: </td>
557     <td>[[TWiki/GoodStyle]] 97%, [[TWiki/FormattedSearch]] 98%, [[Main/RenderListPlugin]] 93% </td>
558   </tr>
559   <tr>
560     <td align="right"> Plugin Home: </td>
561     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
562   </tr>
563   <tr>
564     <td align="right"> Feedback: </td>
565     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev</a></td>
566   </tr>
567   <tr>
568     <td align="right"> Appraisal: </td>
569     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal</a></td>
570   </tr>
571 </table>
572
573 **_Related Topics:_** [[TWikiPlugins]], [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], [[TWikiPreferences]], TWiki:Plugins/TreePlugin
574
575 -- TWiki:Main/PeterThoeny - 23 Sep 2006