Render List Plugin

Syntax Rules

RENDERLIST Variable

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

  "name" or 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 <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:
  • Set <name>_THEME = tree, <0/1 flag to suppress/show lines of first level>
• Format of the icon render type:
  • 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 [[][]] 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 * bullets
• Start with level one
  • Increase indentation only by one level at a time
    • Like this
• It's OK to decrease more than one indentation levels at a time
• Wrap long text, e.g. split it up into continuation lines - the plugin does not do that for you
  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. myicon.gif, or
  • Use one of the existing icons: globe.gif, home.gif, virtualhome.gif, group.gif, persons.gif, virtualpersons.gif, person.gif, virtualperson.gif, email.gif, trend.gif, folder.gif, folders.gif, file.gif, files.gif, doc.gif, image.gif, pdf.gif, ppt.gif, sound.gif, xls.gif, zip.gif, see.gif
  • Refer to an attached icon at the beginning of the bullet with:
    • icon:myicon Followed by normal bullet text
  • Any TWikiDocGraphics icon can be used as well:
    • %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 %<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 <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: This plugin is pre-installed but not enabled by default. TWiki administrators can upgrade it as needed on the TWiki server.

• For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

• Or, follow these manual installation steps:
  • Download the ZIP file from the Plugins home (see below).
  • Unzip RenderListPlugin.zip in your twiki installation directory. Content:

    File:	Description:
    data/TWiki/RenderListPlugin.txt	Plugin topic
    data/TWiki/VarRENDERLIST.txt	Documentation of the RENDERLIST variable
    pub/TWiki/RenderListPlugin/*.gif	Image files for themes
    lib/TWiki/Plugins/RenderListPlugin.pm	Plugin Perl module

  • Set the ownership of the extracted directories and files to the webserver user.

• Plugin configuration and testing:
  • Run the configure script and enable the plugin in the Plugins section.
  • Test if the installation was successful: See example above.

Plugin Info

Related Topics: VarRENDERLIST, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, TWiki:Plugins.TreePlugin