head 1.11; access; symbols; locks; strict; comment @# @; 1.11 date 2007.01.16.04.12.06; author TWikiContributor; state Exp; branches; next 1.10; 1.10 date 2006.06.25.16.26.31; author TWikiContributor; state Exp; branches; next 1.9; 1.9 date 2006.04.01.05.55.33; author TWikiContributor; state Exp; branches; next 1.8; 1.8 date 2006.02.01.12.01.23; author TWikiContributor; state Exp; branches; next 1.7; 1.7 date 2004.03.21.08.52.01; author PeterThoeny; state Exp; branches; next 1.6; 1.6 date 2004.03.02.03.39.00; author PeterThoeny; state Exp; branches; next 1.5; 1.5 date 2003.12.29.20.33.00; author PeterThoeny; state Exp; branches; next 1.4; 1.4 date 2003.12.17.00.17.00; author PeterThoeny; state Exp; branches; next 1.3; 1.3 date 2003.12.12.08.01.17; author PeterThoeny; state Exp; branches; next 1.2; 1.2 date 2003.12.05.21.19.00; author PeterThoeny; state Exp; branches; next 1.1; 1.1 date 2003.12.04.06.38.00; author PeterThoeny; state Exp; branches; next ; desc @none @ 1.11 log @buildrelease @ text @%META:TOPICINFO{author="TWikiContributor" date="1158991460" format="1.0" version="11"}% ---+ 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 %TWIKIWEB%.FormattedSearch * Supported parameters: | ="name"= or%BR% =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%BR% =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: %ATTACHURL%/globe.gif =globe.gif=, %ATTACHURL%/home.gif =home.gif=, %ATTACHURL%/virtualhome.gif =virtualhome.gif=, %ATTACHURL%/group.gif =group.gif=, %ATTACHURL%/persons.gif =persons.gif=, %ATTACHURL%/virtualpersons.gif =virtualpersons.gif=, %ATTACHURL%/person.gif =person.gif=, %ATTACHURL%/virtualperson.gif =virtualperson.gif=, %ATTACHURL%/email.gif =email.gif=, %ATTACHURL%/trend.gif =trend.gif=, %ATTACHURL%/folder.gif =folder.gif=, %ATTACHURL%/folders.gif =folders.gif=, %ATTACHURL%/file.gif =file.gif=, %ATTACHURL%/files.gif =files.gif=, %ATTACHURL%/doc.gif =doc.gif=, %ATTACHURL%/image.gif =image.gif=, %ATTACHURL%/pdf.gif =pdf.gif=, %ATTACHURL%/ppt.gif =ppt.gif=, %ATTACHURL%/sound.gif =sound.gif=, %ATTACHURL%/xls.gif =xls.gif=, %ATTACHURL%/zip.gif =zip.gif=, %ATTACHURL%/see.gif =see.gif= * Refer to an attached icon at the beginning of the bullet with: * =icon:myicon Followed by normal bullet text= * Any %TWIKIWEB%.TWikiDocGraphics icon can be used as well: * =%ICON{name}% Followed by normal bullet text= ---++ Examples
__You type:__ __You get: (simulated)__ __You get: (if installed)__
%RENDERLIST{"thread"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
one
one.a
one.a.x
one.b
one.b.x
continue
one.b.y
Tim
Mico
two
three
%RENDERLIST{"thread"}% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{"org"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.a
  one.a.x
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
  two
  three
%RENDERLIST{"org"}% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{ "org" focus="one.b" }%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
%RENDERLIST{ "org" focus="one.b" }% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
---++ %TOPIC% 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 %TWIKIWEB%.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, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set ORG_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set GROUP_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/group.gif * Set EMAIL_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/email.gif * Set TREND_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/trend.gif * Set FILE_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/file.gif ---++ 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 ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | Plugin topic | | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | | ==pub/TWiki/%TOPIC%/*.gif== | Image files for themes | * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][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: | © 2006, [[http://www.structuredwikis.com/peter.html][Peter Thoeny]] | | License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) | | Plugin Version: | 23 Sep 2006 (V1.034) | | Change History: |   | | 23 Sep 2006: | Support for img tag and image URL after =icon:= (suggested by TWiki:Main.JanFilipsky); support for %TWIKIWEB%.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: | [[http://TWiki.org/cgi-bin/view/Codev/TWikiRelease04x00][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: | %TWIKIWEB%.GoodStyle 97%, %TWIKIWEB%.FormattedSearch 98%, RenderListPlugin 93% | | Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% | | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | | Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal | __Related Topics:__ %TWIKIWEB%.TWikiPlugins, %TWIKIWEB%.DeveloperDocumentationCategory, %TWIKIWEB%.AdminDocumentationCategory, %TWIKIWEB%.TWikiPreferences, TWiki:Plugins/TreePlugin -- TWiki:Main/PeterThoeny - 23 Sep 2006 %META:FILEATTACHMENT{name="empty.gif" attr="h" comment="Empty 16x16 spacer" date="1070383918" path="empty.gif" size="100" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="email.gif" attr="h" comment="E-mail icon 16x16" date="1070614932" path="email.gif" size="183" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="xls.gif" attr="h" comment="XLS icon 16x16" date="1078162404" path="xls.gif" size="918" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="file.gif" attr="h" comment="File icon 16x16" date="1078160664" path="file.gif" size="151" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="person.gif" attr="h" comment="Person icon 16x16" date="1071565646" path="person.gif" size="153" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="doc.gif" attr="h" comment="Doc icon 16x16" date="1078160958" path="doc.gif" size="922" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualpersons.gif" attr="h" comment="Virtual persons icon 16x16" date="1072693460" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualperson.gif" attr="h" comment="Virtual person icon 16x16" date="1072693450" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="group.gif" attr="h" comment="Group icon 16x16" date="1071565632" path="group.gif" size="162" user="PeterThoeny" version="1.2"}% %META:FILEATTACHMENT{name="dot_ur.gif" attr="h" comment="Dot L-graph 16x16" date="1070383984" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="ppt.gif" attr="h" comment="PPT icon 16x16" date="1078160706" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="pdf.gif" attr="h" comment="PDF icon 16x16" date="1078160694" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_udr.gif" attr="h" comment="Dot T-graph 16x16" date="1070384070" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="persons.gif" attr="h" comment="Two persons icon 16x16" date="1071565666" path="persons.gif" size="164" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="sound.gif" attr="h" comment="Sound icon 16x16" date="1078160718" path="sound.gif" size="166" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="home.gif" attr="h" comment="Home icon 16x16" date="1070383996" path="home.gif" size="172" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="folder.gif" attr="h" comment="Folder icon 16x16" date="1078160636" path="folder.gif" size="903" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="zip.gif" attr="h" comment="ZIP icon 16x16" date="1078160730" path="zip.gif" size="940" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="image.gif" attr="h" comment="Image icon 16x16" date="1078160678" path="image.gif" size="943" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="see.gif" attr="h" comment="See icon 16x16" date="1078161392" path="see.gif" size="81" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="trend.gif" attr="h" comment="Trend icon 16x16" date="1072172998" path="trend.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_ud.gif" attr="h" comment="Dot I-graph 16x16" date="1070383970" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualhome.gif" attr="h" comment="Virtual home icon 16x16" date="1072693432" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="globe.gif" attr="h" comment="Globe icon 16x16" date="1075199580" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="folders.gif" attr="h" comment="Folders icon 16x16" date="1158991906" path="folders.gif" size="913" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="files.gif" attr="h" comment="Files icon 16x16" date="1158991940" path="files.gif" size="907" user="PeterThoeny" version="1.1"}% @ 1.10 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1145048254" format="1.0" version="10"}% d41 1 a41 1 * Use one of the existing icons: %ATTACHURL%/globe.gif =globe.gif=, %ATTACHURL%/home.gif =home.gif=, %ATTACHURL%/virtualhome.gif =virtualhome.gif=, %ATTACHURL%/group.gif =group.gif=, %ATTACHURL%/persons.gif =persons.gif=, %ATTACHURL%/virtualpersons.gif =virtualpersons.gif=, %ATTACHURL%/person.gif =person.gif=, %ATTACHURL%/virtualperson.gif =virtualperson.gif=, %ATTACHURL%/email.gif =email.gif=, %ATTACHURL%/trend.gif =trend.gif=, %ATTACHURL%/folder.gif =folder.gif=, %ATTACHURL%/file.gif =file.gif=, %ATTACHURL%/doc.gif =doc.gif=, %ATTACHURL%/image.gif =image.gif=, %ATTACHURL%/pdf.gif =pdf.gif=, %ATTACHURL%/ppt.gif =ppt.gif=, %ATTACHURL%/sound.gif =sound.gif=, %ATTACHURL%/xls.gif =xls.gif=, %ATTACHURL%/zip.gif =zip.gif=, %ATTACHURL%/see.gif =see.gif= d44 2 d343 1 a343 1 __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. d352 2 a353 2 * Test if the installation was successful: * See if the above example works d358 3 a360 1 | Plugin Version: | 25 Apr 2006 (V1.033) | d362 1 d381 1 a381 1 __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, TWiki:Plugins/TreePlugin d383 1 a383 1 -- TWiki:Main/PeterThoeny - 21 Nov 2004 d385 26 a410 24 %META:FILEATTACHMENT{name="empty.gif" attr="h" autoattached="1" comment="Empty 16x16 spacer" date="1070383918" path="empty.gif" size="100" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="email.gif" attr="h" autoattached="1" comment="E-mail icon 16x16" date="1070614932" path="email.gif" size="183" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="xls.gif" attr="h" autoattached="1" comment="XLS icon 16x16" date="1078162404" path="xls.gif" size="918" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="file.gif" attr="h" autoattached="1" comment="File icon 16x16" date="1078160664" path="file.gif" size="151" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="person.gif" attr="h" autoattached="1" comment="Person icon 16x16" date="1071565646" path="person.gif" size="153" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="doc.gif" attr="h" autoattached="1" comment="Doc icon 16x16" date="1078160958" path="doc.gif" size="922" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualpersons.gif" attr="h" autoattached="1" comment="Virtual persons icon 16x16" date="1072693460" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualperson.gif" attr="h" autoattached="1" comment="Virtual person icon 16x16" date="1072693450" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="group.gif" attr="h" autoattached="1" comment="Group icon 16x16" date="1071565632" path="group.gif" size="162" user="PeterThoeny" version="1.2"}% %META:FILEATTACHMENT{name="dot_ur.gif" attr="h" autoattached="1" comment="Dot L-graph 16x16" date="1070383984" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="ppt.gif" attr="h" autoattached="1" comment="PPT icon 16x16" date="1078160706" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="pdf.gif" attr="h" autoattached="1" comment="PDF icon 16x16" date="1078160694" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_udr.gif" attr="h" autoattached="1" comment="Dot T-graph 16x16" date="1070384070" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="persons.gif" attr="h" autoattached="1" comment="Two persons icon 16x16" date="1071565666" path="persons.gif" size="164" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="sound.gif" attr="h" autoattached="1" comment="Sound icon 16x16" date="1078160718" path="sound.gif" size="166" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="home.gif" attr="h" autoattached="1" comment="Home icon 16x16" date="1070383996" path="home.gif" size="172" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="folder.gif" attr="h" autoattached="1" comment="Folder icon 16x16" date="1078160636" path="folder.gif" size="903" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="zip.gif" attr="h" autoattached="1" comment="ZIP icon 16x16" date="1078160730" path="zip.gif" size="940" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="image.gif" attr="h" autoattached="1" comment="Image icon 16x16" date="1078160678" path="image.gif" size="943" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="see.gif" attr="h" autoattached="1" comment="See icon 16x16" date="1078161392" path="see.gif" size="81" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="trend.gif" attr="h" autoattached="1" comment="Trend icon 16x16" date="1072172998" path="trend.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_ud.gif" attr="h" autoattached="1" comment="Dot I-graph 16x16" date="1070383970" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualhome.gif" attr="h" autoattached="1" comment="Virtual home icon 16x16" date="1072693432" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="globe.gif" attr="h" autoattached="1" comment="Globe icon 16x16" date="1075199580" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"}% @ 1.9 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="TWikiContributor" date="1101032519" format="1.0" version="9"}% d38 1 a38 1 =Align continuation lines with leading spaces linke this= d356 1 a356 1 | Plugin Version: | 21 Nov 2004 (V1.032) | d358 2 d380 24 a403 24 %META:FILEATTACHMENT{name="empty.gif" attr="h" comment="Empty 16x16 spacer" date="1070419915" path="empty.gif" size="100" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_udr.gif" attr="h" comment="Dot T-graph 16x16" date="1070420069" path="dot_udr.gif" size="109" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_ud.gif" attr="h" comment="Dot I-graph 16x16" date="1070419969" path="dot_ud.gif" size="108" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_ur.gif" attr="h" comment="Dot L-graph 16x16" date="1070419981" path="dot_ur.gif" size="106" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="home.gif" attr="h" comment="Home icon 16x16" date="1070419995" path="home.gif" size="172" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="group.gif" attr="h" comment="Group icon 16x16" date="1071601631" path="group.gif" size="162" user="PeterThoeny" version="1.2"}% %META:FILEATTACHMENT{name="email.gif" attr="h" comment="E-mail icon 16x16" date="1070650932" path="email.gif" size="183" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="person.gif" attr="h" comment="Person icon 16x16" date="1071601645" path="person.gif" size="153" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="persons.gif" attr="h" comment="Two persons icon 16x16" date="1071601664" path="persons.gif" size="164" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="trend.gif" attr="h" comment="Trend icon 16x16" date="1072208997" path="trend.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualhome.gif" attr="h" comment="Virtual home icon 16x16" date="1072729431" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualperson.gif" attr="h" comment="Virtual person icon 16x16" date="1072729449" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualpersons.gif" attr="h" comment="Virtual persons icon 16x16" date="1072729460" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="globe.gif" attr="h" comment="Globe icon 16x16" date="1075235578" path="globe.gif" size="1024" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="folder.gif" attr="h" comment="Folder icon 16x16" date="1078196677" path="folder.gif" size="903" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="doc.gif" attr="h" comment="Doc icon 16x16" date="1078196779" path="doc.gif" size="922" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="file.gif" attr="h" comment="File icon 16x16" date="1078196548" path="file.gif" size="151" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="image.gif" attr="h" comment="Image icon 16x16" date="1078196562" path="image.gif" size="943" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="pdf.gif" attr="h" comment="PDF icon 16x16" date="1078196748" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="ppt.gif" attr="h" comment="PPT icon 16x16" date="1078196525" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="sound.gif" attr="h" comment="Sound icon 16x16" date="1078196538" path="sound.gif" size="166" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="xls.gif" attr="h" comment="XLS icon 16x16" date="1078198458" path="xls.gif" size="918" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="zip.gif" attr="h" comment="ZIP icon 16x16" date="1078196770" path="zip.gif" size="940" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="see.gif" attr="h" comment="See icon 16x16" date="1078197307" path="see.gif" size="81" user="PeterThoeny" version="1.1"}% @ 1.8 log @buildrelease @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1101032519" format="1.0" version="8"}% @ 1.7 log @none @ text @d1 401 a401 397 %META:TOPICINFO{author="PeterThoeny" date="1079859121" format="1.0" version="1.7"}% ---+ 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 %TWIKIWEB%.FormattedSearch * Supported parameters: | ="name"= or%BR% =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%BR% =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: %ATTACHURL%/globe.gif =globe.gif=, %ATTACHURL%/home.gif =home.gif=, %ATTACHURL%/virtualhome.gif =virtualhome.gif=, %ATTACHURL%/group.gif =group.gif=, %ATTACHURL%/persons.gif =persons.gif=, %ATTACHURL%/virtualpersons.gif =virtualpersons.gif=, %ATTACHURL%/person.gif =person.gif=, %ATTACHURL%/virtualperson.gif =virtualperson.gif=, %ATTACHURL%/email.gif =email.gif=, %ATTACHURL%/trend.gif =trend.gif=, %ATTACHURL%/folder.gif =folder.gif=, %ATTACHURL%/file.gif =file.gif=, %ATTACHURL%/doc.gif =doc.gif=, %ATTACHURL%/image.gif =image.gif=, %ATTACHURL%/pdf.gif =pdf.gif=, %ATTACHURL%/ppt.gif =ppt.gif=, %ATTACHURL%/sound.gif =sound.gif=, %ATTACHURL%/xls.gif =xls.gif=, %ATTACHURL%/zip.gif =zip.gif=, %ATTACHURL%/see.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 * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{"org"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.a
  one.a.x
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
  two
  three
%RENDERLIST{"org"}% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{ "org" focus="one.b" }%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
%RENDERLIST{ "org" focus="one.b" }% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
---++ %TOPIC% 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 %TWIKIWEB%.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, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set ORG_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set GROUP_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/group.gif * Set EMAIL_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/email.gif * Set TREND_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/trend.gif * Set FILE_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/file.gif ---++ 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 ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | Plugin topic | | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | | ==pub/TWiki/%TOPIC%/*.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: |   | | 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/%TOPIC% | | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, TWiki:Plugins/TreePlugin -- TWiki:Main/PeterThoeny - 21 Mar 2004 %META:FILEATTACHMENT{name="empty.gif" attr="h" comment="Empty 16x16 spacer" date="1070519327" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_udr.gif" attr="h" comment="Dot T-graph 16x16" date="1070519374" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_ud.gif" attr="h" comment="Dot I-graph 16x16" date="1070519385" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="dot_ur.gif" attr="h" comment="Dot L-graph 16x16" date="1070519398" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="home.gif" attr="h" comment="Home icon 16x16" date="1070519417" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="group.gif" attr="h" comment="Group icon 16x16" date="1071619807" path="group.gif" size="162" user="PeterThoeny" version="1.2"}% %META:FILEATTACHMENT{name="email.gif" attr="h" comment="E-mail icon 16x16" date="1070659089" path="email.gif" size="183" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="person.gif" attr="h" comment="Person icon 16x16" date="1071619819" path="person.gif" size="153" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="persons.gif" attr="h" comment="Two persons icon 16x16" date="1071619835" path="persons.gif" size="164" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="trend.gif" attr="h" comment="Trend icon 16x16" date="1072729767" path="trend.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualhome.gif" attr="h" comment="Virtual home icon 16x16" date="1072729802" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualperson.gif" attr="h" comment="Virtual person icon 16x16" date="1072729816" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="virtualpersons.gif" attr="h" comment="Virtual persons icon 16x16" date="1072729828" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="folder.gif" attr="h" comment="Folder icon 16x16" date="1078198167" path="folder.gif" size="903" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="doc.gif" attr="h" comment="Doc icon 16x16" date="1078198182" path="doc.gif" size="922" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="file.gif" attr="h" comment="File icon 16x16" date="1078197981" path="file.gif" size="151" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="image.gif" attr="h" comment="Image icon 16x16" date="1078198228" path="image.gif" size="943" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="pdf.gif" attr="h" comment="PDF icon 16x16" date="1078198007" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="ppt.gif" attr="h" comment="PPT icon 16x16" date="1078198239" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="sound.gif" attr="h" comment="Sound icon 16x16" date="1078198274" path="sound.gif" size="166" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="xls.gif" attr="h" comment="Xls icon 16x16" date="1078198301" path="xls.gif" size="918" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="zip.gif" attr="h" comment="ZIP icon 16x16" date="1078198079" path="zip.gif" size="940" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="see.gif" attr="h" comment="See icon 16x16" date="1078198098" path="see.gif" size="81" user="PeterThoeny" version="1.1"}% %META:FILEATTACHMENT{name="globe.gif" attr="h" comment="Globe icon 16x16" date="1078211622" path="C:\Data\Temp\globe.gif" size="1024" user="PeterThoeny" version="1.1"}% @ 1.6 log @none @ text @d1 373 a373 373 %META:TOPICINFO{author="PeterThoeny" date="1078198740" format="1.0" version="1.6"}% ---+ 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 %TWIKIWEB%.FormattedSearch * Supported parameters: | ="name"= or%BR% =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%BR% =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: %ATTACHURL%/globe.gif =globe.gif=, %ATTACHURL%/home.gif =home.gif=, %ATTACHURL%/virtualhome.gif =virtualhome.gif=, %ATTACHURL%/group.gif =group.gif=, %ATTACHURL%/persons.gif =persons.gif=, %ATTACHURL%/virtualpersons.gif =virtualpersons.gif=, %ATTACHURL%/person.gif =person.gif=, %ATTACHURL%/virtualperson.gif =virtualperson.gif=, %ATTACHURL%/email.gif =email.gif=, %ATTACHURL%/trend.gif =trend.gif=, %ATTACHURL%/folder.gif =folder.gif=, %ATTACHURL%/file.gif =file.gif=, %ATTACHURL%/doc.gif =doc.gif=, %ATTACHURL%/image.gif =image.gif=, %ATTACHURL%/pdf.gif =pdf.gif=, %ATTACHURL%/ppt.gif =ppt.gif=, %ATTACHURL%/sound.gif =sound.gif=, %ATTACHURL%/xls.gif =xls.gif=, %ATTACHURL%/zip.gif =zip.gif=, %ATTACHURL%/see.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 * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{"org"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.a
  one.a.x
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
  two
  three
%RENDERLIST{"org"}% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{ "org" focus="one.b" }%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
%RENDERLIST{ "org" focus="one.b" }% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
---++ %TOPIC% 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 %TWIKIWEB%.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, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set ORG_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set GROUP_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/group.gif * Set EMAIL_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/email.gif * Set TREND_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/trend.gif * Set FILE_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/file.gif ---++ 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 ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | Plugin topic | | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | | ==pub/TWiki/%TOPIC%/*.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: |   | | 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/%TOPIC% | | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, TWiki:Plugins/TreePlugin -- TWiki:Main/PeterThoeny - 01 Mar 2004 @ 1.5 log @none @ text @d1 373 a373 370 %META:TOPICINFO{author="PeterThoeny" date="1072729980" format="1.0" version="1.5"}% ---+ 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 %TWIKIWEB%.FormattedSearch * Supported parameters: | ="name"= or%BR% =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%BR% =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: %ATTACHURL%/home.gif =home.gif=, %ATTACHURL%/virtualhome.gif =virtualhome.gif=, %ATTACHURL%/group.gif =group.gif=, %ATTACHURL%/persons.gif =persons.gif=, %ATTACHURL%/virtualpersons.gif =virtualpersons.gif=, %ATTACHURL%/person.gif =person.gif=, %ATTACHURL%/virtualperson.gif =virtualperson.gif=, %ATTACHURL%/email.gif =email.gif=, %ATTACHURL%/trend.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 * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{"org"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.a
  one.a.x
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
  two
  three
%RENDERLIST{"org"}% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
%RENDERLIST{ "org" focus="one.b" }%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
				* icon:person Tim
				* icon:person Mico
	* two
	* three
  one
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico
%RENDERLIST{ "org" focus="one.b" }% * one * one.a * one.a.x * one.b * one.b.x continue * one.b.y * icon:person Tim * icon:person Mico * two * three
---++ %TOPIC% 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 %TWIKIWEB%.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, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set ORG_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/home.gif * Set GROUP_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/group.gif * Set EMAIL_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/email.gif * Set TREND_THEME = icon, 0, 16, 16, %ATTACHURL%/empty.gif, %ATTACHURL%/dot_udr.gif, %ATTACHURL%/dot_ud.gif, %ATTACHURL%/dot_ur.gif, %ATTACHURL%/trend.gif ---++ 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 ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | | ==data/TWiki/%TOPIC%.txt== | Plugin topic | | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository | | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module | | ==pub/TWiki/%TOPIC%/*.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: |   | | 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/%TOPIC% | | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev | __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins, TWiki:Plugins/TreePlugin -- TWiki:Main/PeterThoeny - 29 Dec 2003 d387 11 @ 1.4 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1071620220" format="1.0" version="1.4"}% d41 1 a41 1 * Use one of the existing icons: %ATTACHURL%/home.gif =home.gif=, %ATTACHURL%/group.gif =group.gif=, %ATTACHURL%/persons.gif =persons.gif=, %ATTACHURL%/person.gif =person.gif=, %ATTACHURL%/email.gif =email.gif= d336 1 d355 1 a355 1 | Plugin Version: | 16 Dec 2003 (V1.030) | d357 1 d360 1 a360 1 | 05 Dec 2003: | Fixed rendering issue with IE, added EMAIL_THEME | d370 1 a370 1 -- TWiki:Main/PeterThoeny - 16 Dec 2003 d380 4 @ 1.3 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1071216077" format="1.0" version="1.3"}% d8 2 d30 15 d64 2 a65 1 continue d113 11 a123 1 continue d144 2 a145 1 continue d160 2 a161 1 continue d208 5 d214 4 a217 1   continue d238 2 a239 1 continue d254 2 a255 1 continue d291 6 d298 3 a300 1   continue d313 2 a314 1 continue d354 1 a354 1 | Plugin Version: | 11 Dec 2003 (V1.020) | d356 1 d368 1 a368 1 -- TWiki:Main/PeterThoeny - 11 Dec 2003 d374 1 a374 1 %META:FILEATTACHMENT{name="group.gif" attr="h" comment="Group icon 16x16" date="1070519432" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"}% d376 2 @ 1.2 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1070659140" format="1.0" version="1.2"}% d8 1 a8 1 * Put a =%RENDERLIST{ theme="name" }%= or simply =%RENDERLIST{"name"}%= before any bullet list d10 4 d22 5 d53 1 a53 4 d55 9 a63 2 d66 4 a69 2 d71 4 a74 2 d77 4 a80 2 d83 4 a86 2 d89 4 a92 2 d95 10 a104 6
one
one.a
one.a.x
one.b
one.b.x
continue
one.b.y
continue
two
three
d137 6 a142 4 d144 4 a147 2 d150 4 a153 2 d155 4 a158 2 d161 4 a164 2 d167 4 a170 2 d173 3 a175 2 d178 11 a188 6
  one
  one.a
  one.a.x
  one.b
  one.b.x
  continue
  one.b.y
  continue
  two
  three
d204 65 d305 1 a305 1 | Plugin Version: | 05 Dec 2003 (V1.010) | d307 1 d318 1 a318 1 -- TWiki:Main/PeterThoeny - 05 Dec 2003 @ 1.1 log @none @ text @d1 1 a1 1 %META:TOPICINFO{author="PeterThoeny" date="1070519880" format="1.0" version="1.1"}% d176 1 d195 1 a195 1 | Plugin Version: | 02 Dec 2003 (V1.000) | d197 2 a198 1 | 02 Nov 2003: | Initial version | d207 1 a207 1 -- TWiki:Main/PeterThoeny - 02 Dec 2003 d214 1 @