International Virtual Observatory Alliance

Difference: RenderListPlugin (1 vs. 15)

Revision 152011-07-10 - TWikiContributor

Render List Plugin

<--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/RenderListPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/RenderListPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Page contents

Syntax Rules
- RENDERLIST Variable
- Bullets
Examples
RenderListPlugin Settings
Plugin Installation Instructions
Plugin Info

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`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

Changed:

<
<

Plugin Author:	TWiki:Main/PeterThoeny
Copyright:	© 2003-2010 Peter[at]Thoeny.org, Twiki, Inc. © 2003-2010 TWiki:TWiki/TWikiContributor

>
>

Plugin Author:	TWiki:Main.PeterThoeny
Copyright:	© 2003-2011 Peter[at]Thoeny.org, Twiki, Inc. © 2003-2011 TWiki:TWiki.TWikiContributor

License:

GPL (GNU General Public License)

Changed:

<
<

Plugin Version:

2010-05-16 (2.1)

>
>

Plugin Version:

2011-07-09

Change History:

<-- versions below in reverse order -->

Added:

>
>

2011-07-09:

TWikibug:Item6725: Change global package variables from "use vars" to "our"

2010-05-16:	2.1: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
15 Jan 2008:	2.0: Kenneth Lavrsen. No more reporting warnings in the error log when a render list starts at deeper level than 1
30 Sep 2007:	Added VarRENDERLIST to have it listed in TWikiVariables
23 Sep 2006:	Support for img tag and image URL after `icon:` (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as `%ICON{folder}%` instead of `icon:folder`; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)
25 Apr 2006:	SVN sync, Cairo + Dakar compatibility
14 Apr 2006:	TWikiRelease04x00 compatibility update
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

Changed:

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

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

Deleted:

<
< -- TWiki:Main/PeterThoeny - 30 Sep 2007

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="TWikiContributor" version="1.2"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="TWikiContributor" version="1"

Revision 142010-12-31 - TWikiContributor

Render List Plugin

<--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/RenderListPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/RenderListPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

Changed:

<
<

On this page:

Syntax Rules
- RENDERLIST Variable
- Bullets
Examples
RenderListPlugin Settings
Plugin Installation Instructions
Plugin Info

>
>

Page contents

Syntax Rules
- RENDERLIST Variable
- Bullets
Examples
RenderListPlugin Settings
Plugin Installation Instructions
Plugin Info

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`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

Plugin Author:	TWiki:Main/PeterThoeny
Copyright:	© 2003-2010 Peter[at]Thoeny.org, Twiki, Inc. © 2003-2010 TWiki:TWiki/TWikiContributor
License:	GPL (GNU General Public License)
Plugin Version:	2010-05-16 (2.1)
Change History:	<-- versions below in reverse order -->
2010-05-16:	2.1: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
15 Jan 2008:	2.0: Kenneth Lavrsen. No more reporting warnings in the error log when a render list starts at deeper level than 1
30 Sep 2007:	Added VarRENDERLIST to have it listed in TWikiVariables
23 Sep 2006:	Support for img tag and image URL after `icon:` (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as `%ICON{folder}%` instead of `icon:folder`; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)
25 Apr 2006:	SVN sync, Cairo + Dakar compatibility
14 Apr 2006:	TWikiRelease04x00 compatibility update
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

-- TWiki:Main/PeterThoeny - 30 Sep 2007

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="TWikiContributor" version="1.2"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="TWikiContributor" version="1"

Revision 132010-05-17 - TWikiContributor

Render List Plugin

Added:

>
>

<--
   Contributions to this TWiki plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/RenderListPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/RenderListPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.
-->

On this page:

Syntax Rules
- RENDERLIST Variable
- Bullets
Examples
RenderListPlugin Settings
Plugin Installation Instructions
Plugin Info

Render bullet lists in a variety of formats

Deleted:

<
< Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% before any bullet list

Changed:

<
<

- The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch

>
>

- The lists 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 one level at a time
  - 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
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

Changed:

<
<

- Any TWikiDocGraphics icon can be used as well:

>
>

- 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
    - 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

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
    - Tim
    - 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
    - Tim
    - Mico
two
three

RenderListPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %RENDERPLUGIN_SHORTDESCRIPTION%

Changed:

<
<

One line description, is shown in the TextFormattingRules topic:

>
>

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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`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

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

>
>

License:

GPL (GNU General Public License)

Changed:

<
<

Plugin Version:

15 Jan 2008 (2.0)

>
>

Plugin Version:

2010-05-16 (2.1)

Change History:

<-- versions below in reverse order -->

Added:

>
>

2010-05-16:

2.1: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB

15 Jan 2008:

2.0: Kenneth Lavrsen. No more reporting warnings in the error log when a render list starts at deeper level than 1

Changed:

<
<

30 Sep 2007:	Added VarRENDERLIST to have it listed in TWikiVariables
23 Sep 2006:	Support for img tag and image URL after `icon:` (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as `%ICON{folder}%` instead of `icon:folder`; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)

>
>

30 Sep 2007:	Added VarRENDERLIST to have it listed in TWikiVariables
23 Sep 2006:	Support for img tag and image URL after `icon:` (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as `%ICON{folder}%` instead of `icon:folder`; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)

25 Apr 2006:	SVN sync, Cairo + Dakar compatibility
14 Apr 2006:	TWikiRelease04x00 compatibility update
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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

Changed:

<
<

TWiki:Plugins/Benchmark:

GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%

>
>

TWiki:Plugins/Benchmark:

GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%

Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

Changed:

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

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

-- TWiki:Main/PeterThoeny - 30 Sep 2007

Changed:

<
<

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="PeterThoeny" version="1.1"

>
>

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="TWikiContributor" version="1.2"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="TWikiContributor" version="1"
META FILEATTACHMENT	attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="TWikiContributor" version="1"

Revision 122007-09-30 - TWikiContributor

Changed:

<
<

Render List Plugin

>
>

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Changed:

<
<

Place a %RENDERLIST{ <parameters> }% 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 `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.

>
>

Place a %RENDERLIST{ <parameters> }% 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 `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

Changed:

<
<

Use regular * bullets
Start with level one
- Increase indentation only one level at a time
  - 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
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

>
>

Use regular * bullets
Start with level one
- Increase indentation only one level at a time
  - 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
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"}%

Changed:

<
<

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

>
>

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

one

one.a

one.a.x

one.b

one.b.x

continue

one.b.y

Tim

Mico

two

three

%RENDERLIST{"thread"}%

Changed:

<
<

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

>
>

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

%RENDERLIST{"org"}%

Changed:

<
<

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

>
>

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

one

one.a

one.a.x

one.b

one.b.x

continue

one.b.y

Tim

Mico

two

three

%RENDERLIST{"org"}%

Changed:

<
<

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

>
>

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

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

Changed:

<
<

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

>
>

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

one

one.b

one.b.x

continue

one.b.y

Tim

Mico

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

Changed:

<
<

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

>
>

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

RenderListPlugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %RENDERPLUGIN_SHORTDESCRIPTION%

Changed:

<
<

One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Render bullet lists in a variety of formats

>
>

One line description, is shown in the TextFormattingRules topic:
- Set SHORTDESCRIPTION = Render bullet lists in a variety of formats

Changed:

<
<

Debug plugin: (See output in data/debug.txt)
- Set DEBUG = 0

>
>

Debug plugin: (See output in data/debug.txt)
- Set DEBUG = 0

Changed:

<
<

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, , , , ,

>
>

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: 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.

Changed:

<
<

Download the ZIP file from the Plugin web (see below)

Unzip RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`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

>
>

Download the ZIP file from the Plugin Home (see below)

Unzip RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`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

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

>
>

License:

GPL (GNU General Public License)

Changed:

<
<

Plugin Version:

23 Sep 2006 (V1.034)

>
>

Plugin Version:

15 Jan 2008 (2.0)

Change History:

<-- versions below in reverse order -->

Added:

>
>

15 Jan 2008:	2.0: Kenneth Lavrsen. No more reporting warnings in the error log when a render list starts at deeper level than 1
30 Sep 2007:	Added VarRENDERLIST to have it listed in TWikiVariables

23 Sep 2006:	Support for img tag and image URL after `icon:` (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as `%ICON{folder}%` instead of `icon:folder`; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)
25 Apr 2006:	SVN sync, Cairo + Dakar compatibility
14 Apr 2006:	TWikiRelease04x00 compatibility update
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

Changed:

<
< -- TWiki:Main/PeterThoeny - 23 Sep 2006

>
> -- TWiki:Main/PeterThoeny - 30 Sep 2007

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="PeterThoeny" version="1.1"

Revision 112006-09-23 - TWikiContributor

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
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

Changed:

<
<

- 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, file.gif, doc.gif, image.gif, pdf.gif, ppt.gif, sound.gif, xls.gif, zip.gif, see.gif

>
>

- 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

Added:

>
>

- 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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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

Changed:

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

>
> 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 web (see below)

Unzip RenderListPlugin.zip in your twiki installation directory. Content:

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

Changed:

<
<

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

>
>

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

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

Plugin Version:

25 Apr 2006 (V1.033)

>
>

Added:

>
>

License:	GPL (GNU General Public License)
Plugin Version:	23 Sep 2006 (V1.034)

Change History:

<-- versions below in reverse order -->

Added:

>
>

23 Sep 2006: Support for img tag and image URL after icon: (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as %ICON{folder}% instead of icon:folder; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)

25 Apr 2006:	SVN sync, Cairo + Dakar compatibility
14 Apr 2006:	TWikiRelease04x00 compatibility update
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

Changed:

<
< Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TreePlugin

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

Changed:

<
< -- TWiki:Main/PeterThoeny - 21 Nov 2004

>
> -- TWiki:Main/PeterThoeny - 23 Sep 2006

Changed:

<
<

META FILEATTACHMENT	attr="h" autoattached="1" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"

>
>

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"

Added:

>
>

META FILEATTACHMENT	attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="PeterThoeny" version="1.1"

Revision 102006-04-14 - TWikiContributor

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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

Changed:

<
< Align continuation lines with leading spaces linke this

>
> 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

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

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

Plugin Info

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

Plugin Version:

21 Nov 2004 (V1.032)

>
>

Plugin Version:

25 Apr 2006 (V1.033)

Change History:

<-- versions below in reverse order -->

Added:

>
>

25 Apr 2006:	SVN sync, Cairo + Dakar compatibility
14 Apr 2006:	TWikiRelease04x00 compatibility update

21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

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

-- TWiki:Main/PeterThoeny - 21 Nov 2004

Changed:

<
<

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070419915" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070420069" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070419969" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070419981" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070419995" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071601631" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070650932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071601645" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071601664" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072208997" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729431" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729449" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075235578" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078196677" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078196779" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078196548" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078196562" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078196748" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078196525" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078196538" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078198458" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078196770" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078197307" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"

>
>

META FILEATTACHMENT	attr="h" autoattached="1" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" autoattached="1" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"

Revision 92004-11-21 - TWikiContributor

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	21 Nov 2004 (V1.032)
Change History:	<-- versions below in reverse order -->
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

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

-- TWiki:Main/PeterThoeny - 21 Nov 2004

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070419915" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070420069" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070419969" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070419981" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070419995" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071601631" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070650932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071601645" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071601664" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072208997" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729431" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729449" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075235578" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078196677" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078196779" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078196548" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078196562" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078196748" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078196525" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078196538" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078198458" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078196770" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078197307" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"

Revision 82004-11-21 - PeterThoeny

Changed:

<
<

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	21 Mar 2004 (V1.031)
Change History:	<-- versions below in reverse order -->
21 Mar 2004:	Internal change: Fixed inofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

-- TWiki:Main/PeterThoeny - 21 Mar 2004

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071619807" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072729767" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729802" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729816" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729828" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078198167" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078198182" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078197981" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078198228" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078198007" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078198239" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078198274" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Xls icon 16x16" date="1078198301" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078198079" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078198098" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1078211622" name="globe.gif" path="C:\Data\Temp\globe.gif" size="1024" user="PeterThoeny" version="1.1"

>
>

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	21 Nov 2004 (V1.032)
Change History:	<-- versions below in reverse order -->
21 Nov 2004:	Added benchmarks (no code changes)
21 Mar 2004:	Internal change: Fixed unofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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
TWiki:Plugins/Benchmark:	GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

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

-- TWiki:Main/PeterThoeny - 21 Nov 2004

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070419915" name="empty.gif" path="empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070420069" name="dot_udr.gif" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070419969" name="dot_ud.gif" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070419981" name="dot_ur.gif" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070419995" name="home.gif" path="home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071601631" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070650932" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071601645" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071601664" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072208997" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729431" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729449" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1075235578" name="globe.gif" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078196677" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078196779" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078196548" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078196562" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078196748" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078196525" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"

Added:

>
>

META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078196538" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="XLS icon 16x16" date="1078198458" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078196770" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078197307" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"

Revision 72004-03-21 - PeterThoeny

Changed:

<
<

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	01 Mar 2004 (V1.031)
Change History:	<-- versions below in reverse order -->
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

-- TWiki:Main/PeterThoeny - 01 Mar 2004

>
>

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	21 Mar 2004 (V1.031)
Change History:	<-- versions below in reverse order -->
21 Mar 2004:	Internal change: Fixed inofficial function call
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

-- TWiki:Main/PeterThoeny - 21 Mar 2004

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071619807" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072729767" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729802" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729816" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729828" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078198167" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078198182" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078197981" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078198228" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078198007" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078198239" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078198274" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Xls icon 16x16" date="1078198301" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078198079" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078198098" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1078211622" name="globe.gif" path="C:\Data\Temp\globe.gif" size="1024" user="PeterThoeny" version="1.1"

Revision 62004-03-02 - PeterThoeny

Changed:

<
<

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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: home.gif, virtualhome.gif, group.gif, persons.gif, virtualpersons.gif, person.gif, virtualperson.gif, email.gif, trend.gif
- Refer to an attached icon at the beginning of the bullet with:
  - icon:myicon 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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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, , , , ,

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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	29 Dec 2003 (V1.030)
Change History:	<-- versions below in reverse order -->
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

-- TWiki:Main/PeterThoeny - 29 Dec 2003

>
>

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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, file.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

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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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: 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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	01 Mar 2004 (V1.031)
Change History:	<-- versions below in reverse order -->
01 Mar 2004:	Added FILE_THEME and folder/file icons
29 Dec 2003:	Fixed rendering issue if focus bullet contains `icon:name`; added TREND_THEME
16 Dec 2003:	Specify icons with `icon:name` syntax
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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

Added:

>
> -- TWiki:Main/PeterThoeny - 01 Mar 2004

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071619807" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072729767" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729802" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729816" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729828" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"

Added:

>
>

META FILEATTACHMENT	attr="h" comment="Folder icon 16x16" date="1078198167" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Doc icon 16x16" date="1078198182" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="File icon 16x16" date="1078197981" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Image icon 16x16" date="1078198228" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PDF icon 16x16" date="1078198007" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="PPT icon 16x16" date="1078198239" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Sound icon 16x16" date="1078198274" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Xls icon 16x16" date="1078198301" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="ZIP icon 16x16" date="1078198079" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="See icon 16x16" date="1078198098" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Globe icon 16x16" date="1078211622" name="globe.gif" path="C:\Data\Temp\globe.gif" size="1024" user="PeterThoeny" version="1.1"

Revision 52003-12-29 - PeterThoeny

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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 one level at a time
  - 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
Align continuation lines with leading spaces linke 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

Changed:

<
<

- Use one of the existing icons: home.gif, group.gif, persons.gif, person.gif, email.gif

>
>

- Use one of the existing icons: home.gif, virtualhome.gif, group.gif, persons.gif, virtualpersons.gif, person.gif, virtualperson.gif, email.gif, trend.gif

- Refer to an attached icon at the beginning of the bullet with:
  - icon:myicon 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
    - 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

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
    - Tim
    - 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
    - Tim
    - 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, , , , ,

Added:

>
>

- Set TREND_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 server where TWiki is running.

Download the ZIP file from the Plugin web (see below)

Unzip RenderListPlugin.zip in your twiki installation directory. Content:

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

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

Plugin Info

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

Plugin Version:

16 Dec 2003 (V1.030)

>
>

Plugin Version:

29 Dec 2003 (V1.030)

Change History:

<-- versions below in reverse order -->

Added:

>
>

29 Dec 2003: Fixed rendering issue if focus bullet contains icon:name; added TREND_THEME

16 Dec 2003:	Specify icons with `icon:name` syntax
11 Dec 2003:	Added `focus` and `depth` parameters

Changed:

<
<

05 Dec 2003:

Fixed rendering issue with IE, added EMAIL_THEME

>
>

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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

Changed:

<
< -- TWiki:Main/PeterThoeny - 16 Dec 2003

>
> -- TWiki:Main/PeterThoeny - 29 Dec 2003

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071619807" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"

Added:

>
>

META FILEATTACHMENT	attr="h" comment="Trend icon 16x16" date="1072729767" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual home icon 16x16" date="1072729802" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual person icon 16x16" date="1072729816" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Virtual persons icon 16x16" date="1072729828" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"

Revision 42003-12-17 - PeterThoeny

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

Added:

>
>

RENDERLIST Variable

Place a %RENDERLIST{ <parameters> }% 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 `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.

Added:

>
>

Bullets

Use regular * bullets
Start with level one
- Increase indentation only one level at a time
  - 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
Align continuation lines with leading spaces linke 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: home.gif, group.gif, persons.gif, person.gif, email.gif
- Refer to an attached icon at the beginning of the bullet with:
  - icon:myicon 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

Changed:

<
< continue

>
>

- - - Tim

Added:

>
>

- - - Mico

two
three

one

one.a

one.a.x

one.b

one.b.x

continue

one.b.y

Changed:

<
<

continue

>
>

Added:

>
>

Tim

Added:
> >							Mico

two

three

%RENDERLIST{"thread"}%

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

Changed:

<
<

continue

>
>

- - - Tim

Added:

>
>

- - - Mico

two
three

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

Changed:

<
<

continue

>
>

- - - Tim

Added:

>
>

- - - Mico

two
three

one

one.a

one.a.x

one.b

one.b.x

continue

one.b.y

Added:

>
>

Tim

Changed:

<
<

continue

>
>

Added:

>
>

Mico

two

three

%RENDERLIST{"org"}%

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

Changed:

<
<

continue

>
>

- - - Tim

Added:

>
>

- - - Mico

two
three

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

Changed:

<
<

continue

>
>

- - - Tim

Added:

>
>

- - - Mico

two
three

one

one.b

one.b.x

continue

one.b.y

Added:

>
>

Tim

Changed:

<
<

continue

>
>

Added:

>
>

Mico

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

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

Changed:

<
< continue

>
>

- - - Tim

Added:

>
>

- - - 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, , , , ,

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 RenderListPlugin.zip in your twiki installation directory. Content:

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

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

Plugin Info

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

Plugin Version:

11 Dec 2003 (V1.020)

>
>

Plugin Version:

16 Dec 2003 (V1.030)

Change History:

<-- versions below in reverse order -->

Added:

>
>

16 Dec 2003: Specify icons with icon:name syntax

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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

Changed:

<
< -- TWiki:Main/PeterThoeny - 11 Dec 2003

>
> -- TWiki:Main/PeterThoeny - 16 Dec 2003

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"

Changed:

<
<

META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1070519432" name="group.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"

>
>

META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1071619807" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"

META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"

Added:

>
>

META FILEATTACHMENT	attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"

Revision 32003-12-12 - PeterThoeny

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

Changed:

<
<

Put a %RENDERLIST{ theme="name" }% or simply %RENDERLIST{"name"}% before any bullet list

>
>

Place a %RENDERLIST{ <parameters> }% before any bullet list

- The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch

Added:

>
>

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

Added:

>
>

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

Changed:

<
<

>
>

Deleted:

<
<

	one

Changed:

<
<

one.a

>
>

one

Added:

>
>

Added:

>
> one.a

Changed:

<
<

one.a.x

>
>

one.a.x

Added:

>
>

Changed:

<
<

one.b

>
>

one.b

Added:

>
>

Changed:

<
<

one.b.x

>
>

one.b.x

Added:

>
>

Changed:

<
<

continue

>
>

continue

Added:

>
>

Changed:

<
<

one.b.y

>
>

one.b.y

Added:

>
>

Changed:

<
<

continue
	two
	three

>
>

continue

two

Added:

>
>

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

Changed:

<
<

>
>

Deleted:

<
<

	one

Changed:

<
<

one.a

>
>

one

Added:

>
>

one.a

Changed:

<
<

one.a.x

>
>

one.a.x

Added:

>
>

Changed:

<
<

one.b

>
>

one.b

Added:

>
>

Changed:

<
<

one.b.x

>
>

one.b.x

Added:

>
>

Changed:

<
<

continue

>
>

continue

Added:

>
>

Changed:

<
<

one.b.y

>
>

one.b.y

Added:

>
>

Changed:

<
<

continue
	two
	three

>
>

continue

two

Added:

>
>

three

%RENDERLIST{"org"}%

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

Added:

>
>

%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

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, , , , ,

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 RenderListPlugin.zip in your twiki installation directory. Content:

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

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

Plugin Info

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

Plugin Version:

05 Dec 2003 (V1.010)

>
>

Plugin Version:

11 Dec 2003 (V1.020)

Change History:

<-- versions below in reverse order -->

Added:

>
>

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/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

Changed:

<
< -- TWiki:Main/PeterThoeny - 05 Dec 2003

>
> -- TWiki:Main/PeterThoeny - 11 Dec 2003

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1070519432" name="group.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"

Revision 22003-12-05 - PeterThoeny

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

Put a %RENDERLIST{ theme="name" }% or simply %RENDERLIST{"name"}% before any bullet list
- The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch
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

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

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, , , , ,

Added:

>
>

- Set EMAIL_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 server where TWiki is running.

Download the ZIP file from the Plugin web (see below)

Unzip RenderListPlugin.zip in your twiki installation directory. Content:

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

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

Plugin Info

Plugin Author:

TWiki:Main/PeterThoeny

Changed:

<
<

Plugin Version:

02 Dec 2003 (V1.000)

>
>

Plugin Version:

05 Dec 2003 (V1.010)

Change History:

<-- versions below in reverse order -->

Changed:

<
<

02 Nov 2003:

Initial version

>
>

05 Dec 2003:

Fixed rendering issue with IE, added EMAIL_THEME

Added:

>
>

02 Dec 2003:

Initial version

CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

Changed:

<
< -- TWiki:Main/PeterThoeny - 02 Dec 2003

>
> -- TWiki:Main/PeterThoeny - 05 Dec 2003

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1070519432" name="group.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"

Added:

>
>

META FILEATTACHMENT	attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"

Revision 12003-12-04 - PeterThoeny

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

Put a %RENDERLIST{ theme="name" }% or simply %RENDERLIST{"name"}% before any bullet list
- The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch
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

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

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, , , , ,

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 RenderListPlugin.zip in your twiki installation directory. Content:

File:	Description:
`data/TWiki/RenderListPlugin.txt`	Plugin topic
`data/TWiki/RenderListPlugin.txt,v`	Plugin topic repository
`lib/TWiki/Plugins/RenderListPlugin.pm`	Plugin Perl module
`pub/TWiki/RenderListPlugin/*.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:	02 Dec 2003 (V1.000)
Change History:	<-- versions below in reverse order -->
02 Nov 2003:	Initial version
CPAN Dependencies:	none
Other Dependencies:	none
Perl Version:	5.005
Plugin Home:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

-- TWiki:Main/PeterThoeny - 02 Dec 2003

META FILEATTACHMENT	attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT	attr="h" comment="Group icon 16x16" date="1070519432" name="group.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"

View topic | History: r15 < r14 < r13 < r12 | More topic actions...

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.RenderListPlugin.