9e741a224125364e1a9086e3579b46cfb0c0c810
[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 linke 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`, ![file.gif](http://www.dementia.org/twiki//view/file.gif) `file.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
53 ## <a name="Examples"></a> Examples
54
55 <table border="0" cellpadding="3" cellspacing="5">
56   <tr>
57     <th bgcolor="#CCCCC" valign="top"><strong><em>You type:</em></strong></th>
58     <th bgcolor="#CCCCC" valign="top"><strong><em>You get: (simulated)</em></strong></th>
59     <th bgcolor="#CCCCC" valign="top"><strong><em>You get: (if installed)</em></strong></th>
60   </tr>
61   <tr>
62     <td bgcolor="#EEEEEE" valign="top"><pre>
63 %RENDERLIST{"thread"}%
64         * one
65                 * one.a
66                         * one.a.x
67                 * one.b
68                         * one.b.x
69                           continue
70                         * one.b.y
71                                 * icon:person Tim
72                                 * icon:person Mico
73         * two
74         * three
75 </pre></td>
76     <td bgcolor="#EEEEEE" valign="top">
77       <p>
78       </p>
79       <table border="0" cellpadding="0" cellspacing="0">
80         <tr>
81           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
82           <td valign="top"><nobr> one </nobr></td>
83         </tr>
84       </table>
85       <table border="0" cellpadding="0" cellspacing="0">
86         <tr>
87           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
88           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
89           <td valign="top"><nobr> one.a </nobr></td>
90         </tr>
91       </table>
92       <table border="0" cellpadding="0" cellspacing="0">
93         <tr>
94           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
95           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
96           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
97           <td valign="top"><nobr> one.a.x </nobr></td>
98         </tr>
99       </table>
100       <table border="0" cellpadding="0" cellspacing="0">
101         <tr>
102           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
103           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
104           <td valign="top"><nobr> one.b </nobr></td>
105         </tr>
106       </table>
107       <table border="0" cellpadding="0" cellspacing="0">
108         <tr>
109           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
110           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
111           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
112           <td valign="top"><nobr> one.b.x </nobr></td>
113         </tr>
114       </table>
115       <table border="0" cellpadding="0" cellspacing="0">
116         <tr>
117           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
118           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
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"><nobr> continue </nobr></td>
121         </tr>
122       </table>
123       <table border="0" cellpadding="0" cellspacing="0">
124         <tr>
125           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
126           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
127           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
128           <td valign="top"><nobr> one.b.y </nobr></td>
129         </tr>
130       </table>
131       <table border="0" cellpadding="0" cellspacing="0">
132         <tr>
133           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
134           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
135           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
136           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
137           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
138           <td valign="top"><nobr> Tim </nobr></td>
139         </tr>
140       </table>
141       <table border="0" cellpadding="0" cellspacing="0">
142         <tr>
143           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
144           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
145           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
146           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
147           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
148           <td valign="top"><nobr> Mico </nobr></td>
149         </tr>
150       </table>
151       <table border="0" cellpadding="0" cellspacing="0">
152         <tr>
153           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
154           <td valign="top"><nobr> two </nobr></td>
155         </tr>
156       </table>
157       <table border="0" cellpadding="0" cellspacing="0">
158         <tr>
159           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
160           <td valign="top"><nobr> three </nobr></td>
161         </tr>
162       </table>
163       <p>
164       </p>
165     </td>
166     <td bgcolor="#EEEEEE" valign="top">
167       <p> %RENDERLIST{"thread"}% </p>
168       <ul>
169         <li> one <ul>
170             <li> one.a <ul>
171                 <li> one.a.x </li>
172               </ul>
173             </li>
174             <li> one.b <ul>
175                 <li> one.b.x continue </li>
176                 <li> one.b.y <ul>
177                     <li> icon:person Tim </li>
178                     <li> icon:person Mico </li>
179                   </ul>
180                 </li>
181               </ul>
182             </li>
183           </ul>
184         </li>
185         <li> two </li>
186         <li> three </li>
187       </ul>
188       <p>
189       </p>
190     </td>
191   </tr>
192   <tr>
193     <td bgcolor="#EEEEEE" valign="top"><pre>
194 %RENDERLIST{"org"}%
195         * one
196                 * one.a
197                         * one.a.x
198                 * one.b
199                         * one.b.x
200                           continue
201                         * one.b.y
202                                 * icon:person Tim
203                                 * icon:person Mico
204         * two
205         * three
206 </pre></td>
207     <td bgcolor="#EEEEEE" valign="top">
208       <p>
209       </p>
210       <table border="0" cellpadding="0" cellspacing="0">
211         <tr>
212           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
213           <td valign="top"><nobr>  one </nobr></td>
214         </tr>
215       </table>
216       <table border="0" cellpadding="0" cellspacing="0">
217         <tr>
218           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
219           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
220           <td valign="top"><nobr>  one.a </nobr></td>
221         </tr>
222       </table>
223       <table border="0" cellpadding="0" cellspacing="0">
224         <tr>
225           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
226           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
227           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
228           <td valign="top"><nobr>  one.a.x </nobr></td>
229         </tr>
230       </table>
231       <table border="0" cellpadding="0" cellspacing="0">
232         <tr>
233           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
234           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
235           <td valign="top"><nobr>  one.b </nobr></td>
236         </tr>
237       </table>
238       <table border="0" cellpadding="0" cellspacing="0">
239         <tr>
240           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
241           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
242           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
243           <td valign="top"><nobr>  one.b.x </nobr></td>
244         </tr>
245       </table>
246       <table border="0" cellpadding="0" cellspacing="0">
247         <tr>
248           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
249           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
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"><nobr>  continue </nobr></td>
252         </tr>
253       </table>
254       <table border="0" cellpadding="0" cellspacing="0">
255         <tr>
256           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
257           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
258           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
259           <td valign="top"><nobr>  one.b.y </nobr></td>
260         </tr>
261       </table>
262       <table border="0" cellpadding="0" cellspacing="0">
263         <tr>
264           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
265           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
266           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
267           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
268           <td valign="top"><nobr>  Tim </nobr></td>
269         </tr>
270       </table>
271       <table border="0" cellpadding="0" cellspacing="0">
272         <tr>
273           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
274           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
275           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
276           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
277           <td valign="top"><nobr>  Mico </nobr></td>
278         </tr>
279       </table>
280       <table border="0" cellpadding="0" cellspacing="0">
281         <tr>
282           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
283           <td valign="top"><nobr>  two </nobr></td>
284         </tr>
285       </table>
286       <table border="0" cellpadding="0" cellspacing="0">
287         <tr>
288           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
289           <td valign="top"><nobr>  three </nobr></td>
290         </tr>
291       </table>
292       <p>
293       </p>
294     </td>
295     <td bgcolor="#EEEEEE" valign="top">
296       <p> %RENDERLIST{"org"}% </p>
297       <ul>
298         <li> one <ul>
299             <li> one.a <ul>
300                 <li> one.a.x </li>
301               </ul>
302             </li>
303             <li> one.b <ul>
304                 <li> one.b.x continue </li>
305                 <li> one.b.y <ul>
306                     <li> icon:person Tim </li>
307                     <li> icon:person Mico </li>
308                   </ul>
309                 </li>
310               </ul>
311             </li>
312           </ul>
313         </li>
314         <li> two </li>
315         <li> three </li>
316       </ul>
317       <p>
318       </p>
319     </td>
320   </tr>
321   <tr>
322     <td bgcolor="#EEEEEE" valign="top"><pre>
323 %RENDERLIST{ "org" focus="one.b" }%
324         * one
325                 * one.a
326                         * one.a.x
327                 * one.b
328                         * one.b.x
329                           continue
330                         * one.b.y
331                                 * icon:person Tim
332                                 * icon:person Mico
333         * two
334         * three
335 </pre></td>
336     <td bgcolor="#EEEEEE" valign="top">
337       <p>
338       </p>
339       <table border="0" cellpadding="0" cellspacing="0">
340         <tr>
341           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
342           <td valign="top"><nobr>  one </nobr></td>
343         </tr>
344       </table>
345       <table border="0" cellpadding="0" cellspacing="0">
346         <tr>
347           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
348           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
349           <td valign="top"><nobr>  <b> one.b </b> </nobr></td>
350         </tr>
351       </table>
352       <table border="0" cellpadding="0" cellspacing="0">
353         <tr>
354           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
355           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
356           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
357           <td valign="top"><nobr>  one.b.x </nobr></td>
358         </tr>
359       </table>
360       <table border="0" cellpadding="0" cellspacing="0">
361         <tr>
362           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
363           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ud.gif" width="16" /></td>
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"><nobr>  continue </nobr></td>
366         </tr>
367       </table>
368       <table border="0" cellpadding="0" cellspacing="0">
369         <tr>
370           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
371           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
372           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/home.gif" width="16" /></td>
373           <td valign="top"><nobr>  one.b.y </nobr></td>
374         </tr>
375       </table>
376       <table border="0" cellpadding="0" cellspacing="0">
377         <tr>
378           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
379           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
380           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_udr.gif" width="16" /></td>
381           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
382           <td valign="top"><nobr>  Tim </nobr></td>
383         </tr>
384       </table>
385       <table border="0" cellpadding="0" cellspacing="0">
386         <tr>
387           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
388           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/empty.gif" width="16" /></td>
389           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/dot_ur.gif" width="16" /></td>
390           <td valign="top"><img alt="" border="0" height="16" src="http://www.dementia.org/twiki//view/person.gif" width="16" /></td>
391           <td valign="top"><nobr>  Mico </nobr></td>
392         </tr>
393       </table>
394       <p>
395       </p>
396     </td>
397     <td bgcolor="#EEEEEE" valign="top">
398       <p> %RENDERLIST{ "org" focus="one.b" }% </p>
399       <ul>
400         <li> one <ul>
401             <li> one.a <ul>
402                 <li> one.a.x </li>
403               </ul>
404             </li>
405             <li> one.b <ul>
406                 <li> one.b.x continue </li>
407                 <li> one.b.y <ul>
408                     <li> icon:person Tim </li>
409                     <li> icon:person Mico </li>
410                   </ul>
411                 </li>
412               </ul>
413             </li>
414           </ul>
415         </li>
416         <li> two </li>
417         <li> three </li>
418       </ul>
419       <p>
420       </p>
421     </td>
422   </tr>
423 </table>
424
425 ## <a name="%TOPIC% Settings"></a> %TOPIC% Settings
426
427 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>
428
429 - One line description, is shown in the [[TextFormattingRules]] topic:
430   - Set SHORTDESCRIPTION = Render bullet lists in a variety of formats
431
432 - Debug plugin: (See output in `data/debug.txt`)
433   - Set DEBUG = 0
434
435 - Themes are named `<SOMETHING>_THEME` and contain a comma delimited list of render type with parameters:
436   - Set THREAD\_THEME = tree, 1
437   - 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)
438   - 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)
439   - 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)
440   - 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)
441   - 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)
442   - 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)
443
444 ## <a name="Plugin Installation Instructions"></a> Plugin Installation Instructions
445
446 **_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.
447
448 - Download the ZIP file from the Plugin web (see below)
449 - Unzip <code>**%TOPIC%.zip**</code> in your twiki installation directory. Content: <table border="1" cellpadding="0" cellspacing="0">
450   <tr>
451     <th bgcolor="#99CCCC"><strong> File: </strong></th>
452     <th bgcolor="#99CCCC"><strong> Description: </strong></th>
453   </tr>
454   <tr>
455     <td><code><b>data/TWiki/%TOPIC%.txt</b></code></td>
456     <td> Plugin topic </td>
457   </tr>
458   <tr>
459     <td><code><b>data/TWiki/%TOPIC%.txt,v</b></code></td>
460     <td> Plugin topic repository </td>
461   </tr>
462   <tr>
463     <td><code><b>lib/TWiki/Plugins/%TOPIC%.pm</b></code></td>
464     <td> Plugin Perl module </td>
465   </tr>
466   <tr>
467     <td><code><b>pub/TWiki/%TOPIC%/*.gif</b></code></td>
468     <td> Image files for themes </td>
469   </tr>
470 </table>
471 - Test if the installation was successful:
472   - See if the above example works
473
474 ## <a name="Plugin Info"></a> Plugin Info
475
476 <table border="1" cellpadding="0" cellspacing="0">
477   <tr>
478     <td align="right"> Plugin Author: </td>
479     <td> TWiki:Main/PeterThoeny </td>
480   </tr>
481   <tr>
482     <td align="right"> Plugin Version: </td>
483     <td> 01 Mar 2004 (V1.031) </td>
484   </tr>
485   <tr>
486     <td align="right"> Change History: </td>
487     <td>  </td>
488   </tr>
489   <tr>
490     <td align="right"> 01 Mar 2004: </td>
491     <td> Added FILE_THEME and folder/file icons </td>
492   </tr>
493   <tr>
494     <td align="right"> 29 Dec 2003: </td>
495     <td> Fixed rendering issue if focus bullet contains <code>icon:name</code>; added TREND_THEME </td>
496   </tr>
497   <tr>
498     <td align="right"> 16 Dec 2003: </td>
499     <td> Specify icons with <code>icon:name</code> syntax </td>
500   </tr>
501   <tr>
502     <td align="right"> 11 Dec 2003: </td>
503     <td> Added <code>focus</code> and <code>depth</code> parameters </td>
504   </tr>
505   <tr>
506     <td align="right"> 05 Dec 2003: </td>
507     <td> Fixed rendering issue with IE; added EMAIL_THEME </td>
508   </tr>
509   <tr>
510     <td align="right"> 02 Dec 2003: </td>
511     <td> Initial version </td>
512   </tr>
513   <tr>
514     <td align="right"> CPAN Dependencies: </td>
515     <td> none </td>
516   </tr>
517   <tr>
518     <td align="right"> Other Dependencies: </td>
519     <td> none </td>
520   </tr>
521   <tr>
522     <td align="right"> Perl Version: </td>
523     <td> 5.005 </td>
524   </tr>
525   <tr>
526     <td align="right"> Plugin Home: </td>
527     <td><a href="http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%" target="_top">http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%</a></td>
528   </tr>
529   <tr>
530     <td align="right"> Feedback: </td>
531     <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>
532   </tr>
533 </table>
534
535 **_Related Topics:_** [[TWikiPreferences]], [[TWikiPlugins]], TWiki:Plugins/TreePlugin
536
537 -- TWiki:Main/PeterThoeny - 01 Mar 2004