|
<
< | Render List Plugin |
>
> | 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:
- Highlight text and remove
[[][]] links on bullet where text is found
- 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:
- Highlight text and remove
[[][]] links on bullet where text is found
- 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
- 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
- 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.b |
|
two |
|
three |
|
%RENDERLIST{"thread"}% |
|
<
< | |
>
> | |
| | |
|
<
< | |
>
> | |
| |
|
|
one |
|
|
one.a |
|
|
one.b |
|
two |
|
three |
|
%RENDERLIST{"org"}% |
|
<
< | |
>
> | |
| |
%RENDERLIST{ "org" focus="one.b" }%
| |
|
<
< | |
>
> | |
| |
|
|
one |
|
|
one.b |
|
%RENDERLIST{ "org" focus="one.b" }% |
|
<
< | |
>
> | |
| |
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
|
>
> |
- 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)
|
>
> |
- Debug plugin: (See output in
data/debug.txt)
|
| | |
|
<
< |
- 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. |
|
<
< |
- 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 Version: |
23 Sep 2006 (V1.034) |
|
>
> |
| Plugin Version: |
15 Jan 2008 (2.0) |
|
| |
| Change History: |
<-- versions below in reverse order --> |
|
|
>
> |
| 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 |
|
| |
Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences, TWiki:Plugins/TreePlugin |
|
<
< | -- 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" |
|
"
}%
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.