Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

• Place a CGI %RENDERLIST{ <parameters> }% before any bullet list
  • The lists can be handcrafted, generated by another Plugin, a CGI %TOC%, or the result of a FormattedSearch
• Supported parameters:

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

• Rendering themes can be defined by CGI <name>_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:
  • CGI Set <name>_THEME = tree, <0/1 flag to suppress/show lines of first level>
• Format of the icon render type:
  • CGI 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>
  • 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 CGI [[][]] 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.

Bullets

• Use regular CGI CGI * bullets
• Start with level one
  • Increase indentation only one level at a time
    • CGI Like this
• Decreasing indentation many levels at a time is OK
• Wrap long text with continuation lines, the Plugin does not do that for you
  CGI Align continuation lines with leading spaces like this
• You can specify an icon for a bullet of render type tree or icon:
  • Attach the icon to this Plugin topic, e.g. CGI myicon.gif, or
  • Use one of the existing icons: CGI globe.gif, CGI home.gif, CGI virtualhome.gif, CGI group.gif, CGI persons.gif, CGI virtualpersons.gif, CGI person.gif, CGI virtualperson.gif, CGI email.gif, CGI trend.gif, CGI folder.gif, CGI folders.gif, CGI file.gif, CGI files.gif, CGI doc.gif, CGI image.gif, CGI pdf.gif, CGI ppt.gif, CGI sound.gif, CGI xls.gif, CGI zip.gif, CGI see.gif
  • Refer to an attached icon at the beginning of the bullet with:
    • CGI icon:myicon Followed by normal bullet text
  • Any TWikiDocGraphics icon can be used as well:
    • CGI %ICON{name}% Followed by normal bullet text

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 * icon:person Tim * icon:person Mico * two * three	one one.a one.a.x one.b one.b.x continue one.b.y Tim Mico two three	%RENDERLIST{"thread"}% one one.a one.a.x one.b one.b.x continue one.b.y icon:person Tim icon:person Mico two three
%RENDERLIST{"org"}% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three	one   one.a   one.a.x   one.b   one.b.x   continue   one.b.y   Tim   Mico   two   three	%RENDERLIST{"org"}% one one.a one.a.x one.b one.b.x continue one.b.y icon:person Tim icon:person Mico two three
%RENDERLIST{ "org" focus="one.b" }% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three	one   one.b   one.b.x   continue   one.b.y   Tim   Mico	%RENDERLIST{ "org" focus="one.b" }% one one.a one.a.x one.b one.b.x continue one.b.y icon:person Tim icon:person Mico two three

RenderListPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write CGI CGI %<plugin>_<setting>%, i.e. CGI CGI %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 CGI data/debug.txt)
  • Set DEBUG = 0

• Themes are named CGI <SOMETHING>_THEME and contain a comma delimited list of render type with parameters:
  • Set THREAD_THEME = tree, 1
  • Set HOME_THEME = icon, 1, 16, 16, , , , ,
  • Set ORG_THEME = icon, 0, 16, 16, , , , ,
  • Set GROUP_THEME = icon, 0, 16, 16, , , , ,
  • Set EMAIL_THEME = icon, 0, 16, 16, , , , ,
  • Set TREND_THEME = icon, 0, 16, 16, , , , ,
  • Set FILE_THEME = icon, 0, 16, 16, , , , ,

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 TWiki server.

• Download the ZIP file from the Plugin Home (see below)
• Unzip CGI CGI RenderListPlugin.zip in your twiki installation directory. Content:

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

• TWiki 4.0 and up: Run the configure script to enable the Plugin
• Test if the installation was successful: See if above examples work

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, TWiki:Plugins/TreePlugin

-- TWiki:Main/PeterThoeny - 30 Sep 2007