From: <Cra...@nt...> - 2004-12-09 12:28:25
|
Author: CrawfordCurrie Date: 2004-12-09 04:23:56 -0800 (Thu, 09 Dec 2004) New Revision: 3389 Modified: twiki/branches/DEVELOP/data/TWiki/CommentPlugin.txt twiki/branches/DEVELOP/data/TWiki/CommentsTmpl.txt twiki/branches/DEVELOP/data/TWiki/RenderListPlugin.txt twiki/branches/DEVELOP/data/TWiki/SlideShowPlugin.txt twiki/branches/DEVELOP/data/TWiki/TWikiPreferences.txt Log: TWikiDocumentation: correcting inconsistent line endings Modified: twiki/branches/DEVELOP/data/TWiki/CommentPlugin.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/CommentPlugin.txt 2004-12-09 11:32:47 UTC (rev 3388) +++ twiki/branches/DEVELOP/data/TWiki/CommentPlugin.txt 2004-12-09 12:23:56 UTC (rev 3389) @@ -1,4 +1,3 @@ -%META:TOPICINFO{author="PeterThoeny" date="1091934049" format="1.0" version="1.1"}% ---+!! Comment Plugin This plugin allows users to quickly post comments to a page without an edit/preview/save cycle. @@ -21,11 +20,12 @@ #StandardAttrs The following attributes are [[#MoreAttrs][recognised]] | *Name* | *Description* | - | =type= | (Required) This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see [[#TemPlates][Customisation]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. By default this is 'below'. | + | =type= | This is the name of the template to use for this comment. Comment templates are defined in a TWiki template - see [[#TemPlates][Customisation]], below. If this attribute is not defined, the type is whatever is defined by COMMENTPLUGIN_DEFAULT_TYPE, either in this topic or in your WebPreferences. By default this is 'below'. | | =target= | Name of the topic to add the comment to. Defaults to the current topic. | | =location= | Regular expression specifying the comment location in the target topic. Read _carefully_ below! | | =mode= | For compatability with older versions only, synonymous with =type= | | =nonotify= | Set to "on" to disable change notification for target topics | + | =noform= | Set to "on" to disable the automatic form that encloses your comment block - _remember_ to insert =<FORM>= tags yourself! | ---++ Positioning the comment =%COMMENT= supports several ways to specify _where_ a comment should be inserted in the target topic. This is referred to as the _location_ of the comment. @@ -53,15 +53,20 @@ *Warning* of course, if a user's comment contains the string "Flights of Fancy" they may and up _changing the location_ for the next comment! Also, if you use a tag in the location, then you've just inserted another tag in the page that contains the =%COMMENT=! So be very careful how you specify the RE for =location=. Note that the RE is matched using perl "multiple line" mode, so ^ and $ match the start of a line and the end of a line respectively. +I look forward to someone leveraging this feature to create - for example - threaded conversations using =%COMMENT=. + If you specify an anchor _and_ a =location=, the anchor will be ignored. ---++ Default templates +Templates are used to define the "comment style" i.e. how comments appear in the page. The default is to add comments in "Blog like" style using bulleted lists, with the most recent comment at the top, but many other styles are available such as tables or Wiki thread mode comments. It is easy to define your own customer styles as well. + A set of default comment templates are shipped with the plugin. These are: | *Template type* | *Description* | | =top= | Comments, signed and dated, added at top of the topic (the anchor is ignored) | | =bottom= | Comments, signed and dated, added at end of the target topic (the anchor is ignored) | | =above= | Comments, signed and dated, added immediately before the target anchor, or the =%COMMENT= if no anchor is specified | | =below= | Comments, signed and dated, added immediately below the target anchor, or the =%COMMENT= if no anchor is specified | +| =threadmode= | Wiki thread mode comment, signed and dated | | =tableprepend= | Comments, signed and dated, formatted as an HTML table row, added below the anchor (which must be in an HTML <table>) | | =tableappend= | Comments, signed and dated, formatted as an HTML table row, added above the anchor (which must be in an HTML <table>) | @@ -80,7 +85,7 @@ ---++ The =PROMPT= template The =PROMPT= template defines the contents of an HTML form that is used to capture the comment. This form invokes the comment generator when submitted. Parameters to the comment generator are defined using standard HTML input fields, such as =input=, =textarea= and =select=. The user enters values for these parameters, and these are then available when the =OUTPUT= template is expanded, in the form of <code>%<nop>URLPARAM%</code>s. -Only the input fields of the form need be defined. The plugin automatically generates the <code>>form<</code> and <code>>:/form<</code> tags. *Note* that you must define a "submit" button if you want the form to work! +Only the input fields of the form need be defined. The plugin automatically generates the <code>>form<</code> and <code>>:/form<</code> tags, unless you specify =noform="on"=, in which case you have to provide them yourself. *Note* that you must define a "submit" button if you want the form to work! #MoreAttrs If an attribute is given to the =%COMMENT= tag that is not one of the [[#StandardAttrs][standard attributes]], then that attribute is taken as the name of a parameter to be expanded in the =PROMPT= template. Expressions in the template of the form <code>%</code><i>param</i><code>|</code><i>default</i><code>%</code> (e.g. <code>%rows|3%</code>, <code>%button|Push me%</code>) are expanded to the values given in the <code>%COMMENT</code>. For example, if the =PROMPT= template 'example' contains: @@ -89,11 +94,11 @@ </pre> and the %COMMENT tag is: <pre> -%<nop>COMMENT{type="example" rows="5" cols="20"}% +%<nop>COMMENT{type="example" cols="75"}% </pre> then the template will be expanded as <pre> -<textarea rows=5 cols="20" value="Rubbish"> +<textarea rows="3" cols="75" value="Rubbish"> </pre> As well as support for all the usual TWiki variables in templates, the following special variables are supported in the =PROMPT= definition: @@ -126,13 +131,12 @@ ---+ Settings * Description: * Set SHORTDESCRIPTION = Allows users to quickly post comments to a page without an edit/preview/save cycle. - * templates; includes user templates from TWiki.CommentsTmpl + * Name of file in the 'templates' directory that contains the comment templates. The default 'comments.tmpl' automatically includes user templates from TWiki.CommentsTmpl * Set TEMPLATES = comments * default template type (if not present, defaults to "below") - * Set DEFAULT_TYPE = above + * Set DEFAULT_TYPE = below ---+ Plugin Installation Instructions - * Make sure you have the TWiki:Plugins/SharedCode module installed. Among other things, TWiki:Plugins/SharedCode includes a compatibility module that enables plugins to use new TWiki features with earlier TWiki releases. If you don't already have it, install it now. * Download the ZIP file from the Plugin web (see below) * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content: | *File:* | *Description:* | @@ -141,10 +145,13 @@ | ==templates/comments.tmpl== | Master comment templates | | ==lib/TWiki/Plugins/CommentPlugin.pm== | Plugin Perl module | | ==lib/TWiki/Plugins/CommentPlugin/Comment.pm== | Plugin Perl module | - | ==lib/TWiki/Plugins/CommentPlugin/Templates.pm== | Plugin Perl module | | ==lib/TWiki/Plugins/CommentPlugin/test.zip== | Tests | | ==lib/TWiki/Plugins/CommentPlugin/build.pl== | Build file | + | ==CommentPlugin_installer.pl== | Install script | + * Optionally, run ==%TOPIC%_installer== to automatically check and install other TWiki modules that this module depends on. You can also do this step manually. + * Alternatively, manually make sure the dependencies listed in the table below are resolved. + <table border=1><tr><th align="left">Name</th><th align="left">Version</th><th align="left">Description</th></tr><tr><td align="left">TWiki::Contrib::Attrs</td><td align="left">>=1.000</td><td align="left">Required. Download from TWiki:Plugins/AttrsContrib and install.</td></tr><tr><td align="left">TWiki::Plugins::CairoContrib</td><td align="left"> >=1.000</td><td align="left">Optional, only required if the plugin is to be run with versions of TWiki before Cairo. Available from the TWiki:Plugins/CairoContrib repository.</td></tr></table> * The Plugin depends on the =viewauth= script to authenticate the user. As described in %TWIKIWEB%.TWikiAccessControl, copy the =view= script to =viewauth= (or better, create a symbolic link) and add =viewauth= to the list of authenticated scripts in the =.htaccess= file. If installed correctly, you should see a =%COMMENT= edit box below here. @@ -153,20 +160,25 @@ ---+ Plugin Info -| Plugin Author: | v1.0 TWiki:Main/DavidWeller v2.0 TWiki:Main/PeterMasiar v3.0 TWiki:Main/CrawfordCurrie | -| Plugin Version: | 3.0 | -| Change History: | <!-- Most recent first --> 3.003 11 Apr 2004: Minor line termination problem fixed, and "security" hyphen on standard comment removed and replaced with a bulleted list. | -| | 3.002 6 April 2004: Applied patches (thanks Peter Thoeny) for multiple comment adding, BOTTOM and TOP inside meta-data, and moved example to Sandbox. | -| | 3.001 13 March 2004: Modified to use viewauth save technique (safer), add nonotify parameter, move templates fully into topics, with a hook for site-specifics, support %<nop>COMMENT%, internationalisation fixes | -| | 3.000 18 Feb 2004: TWiki:Main/CrawfordCurrie rewrote for standard templates and other user requests. Recognition to Patrice Fournier and Sam Abrams for terrific testing and patch support. | -| | 7 Feb 2004: TWiki:Main/CrawfordCurrie rewrote this page and CommentTemplates in an effort to make the plugin more user friendly. Added {TIME} variable. Also updated CVS. | -| | 23 Sep 2003 TWiki:Main/PeterMasiar: 80% rewrite/refactor, adding templates | -| | 15 July 2003: TWiki:Main/PeterMasiar added "reminder" parameter and feature to pass comments to oopslockedcomments.tmpl template to copy-paste later | -| | 5 March 2002 Bug fixes, TWiki:Main/JonLambert created oopslockedcomments.tmpl template | -| | 24 Feb 2002 added a few more user requests, made "English" text configurable | -| | 4 Dec 2001: 1.01 release, changed name to CommentPlugin, added $button var, changed textarea WRAP setting to "soft" | -| | 30 Nov 2001: Initial version | -| Dependencies: | | +| Plugin Author: | v1.0 TWiki:Main.DavidWeller v2.0 TWiki:Main.PeterMasiar v3.0 TWiki:Main.CrawfordCurrie http://www.c-dot.co.uk | +| Plugin Version: | 3.008 | +| Change History: <!-- Most recent first --> || +| 16 Oct 2004 | 3.008 Added the =noform= attribute to Comment - TWiki:Main.MartinCleaver | +| 12 Oct 2004 | 3.007 Disabled comment boxes in rdiff pane. | +| 6 Oct 2004 | 3.006 Fixed action template, which was expanded incorrectly. Upped default comment box to 70 chars default width. | +| 16 Aug 2004 | 3.005 Cairo readiness; dependency checking; added =threadmode= template. | +| 11 Apr 2004 | 3.004 Minor line termination problem fixed, and "security" hyphen on standard comment removed and replaced with a bulleted list. | +| 6 April 2004 | 3.003 Applied patches (thanks Peter Thoeny) for multiple comment adding, BOTTOM and TOP inside meta-data, and moved example to Sandbox. | +| 13 March 2004 | 3.002 Modified to use viewauth save technique (safer), add nonotify parameter, move templates fully into topics, with a hook for site-specifics, support %<nop>COMMENT%, internationalisation fixes | +| 18 Feb 2004 | 3.001 TWiki:Main/CrawfordCurrie rewrote for standard templates and other user requests. Recognition to Patrice Fournier and Sam Abrams for terrific testing and patch support. | +| 7 Feb 2004 | TWiki:Main/CrawfordCurrie rewrote this page and CommentTemplates in an effort to make the plugin more user friendly. Added {TIME} variable. Also updated CVS. | +| 23 Sep 2003 | 2.000 TWiki:Main/PeterMasiar: 80% rewrite/refactor, adding templates | +| 15 July 2003 | TWiki:Main/PeterMasiar added "reminder" parameter and feature to pass comments to oopslockedcomments.tmpl template to copy-paste later | +| 5 March 2002 | Bug fixes, TWiki:Main/JonLambert created oopslockedcomments.tmpl template | +| 24 Feb 2002 | added a few more user requests, made "English" text configurable | +| 4 Dec 2001 | 1.010 release, changed name to CommentPlugin, added $button var, changed textarea WRAP setting to "soft" | +| 30 Nov 2001 | 1.000 Initial version | +| Dependencies: | <table border=1><tr><th align="left">Name</th><th align="left">Version</th><th align="left">Description</th></tr><tr><td align="left">TWiki::Contrib::Attrs</td><td align="left">>=1.000</td><td align="left">Required. Download from TWiki:Plugins/AttrsContrib and install.</td></tr><tr><td align="left">TWiki::Plugins::CairoContrib</td><td align="left"> >=1.000</td><td align="left">Optional, only required if the plugin is to be run with versions of TWiki before Cairo. Available from the TWiki:Plugins/CairoContrib repository.</td></tr></table> | | Perl Version: | 5.0 | | Plugin Home: | TWiki:Plugins/%TOPIC% | | Feedback: | TWiki:Plugins/%TOPIC%Dev | @@ -175,5 +187,5 @@ -- TWiki:Main/DavidWeller - 05 Mar 2002 <br> -- TWiki:Main/PeterMasiar - 15 Jul 2003, 23 Sep 2003<br> --- TWiki:Main/CrawfordCurrie - 21 May 2004 - +-- TWiki:Main/CrawfordCurrie - 17:48:16 01 December 2004 +<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. --> Modified: twiki/branches/DEVELOP/data/TWiki/CommentsTmpl.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/CommentsTmpl.txt 2004-12-09 11:32:47 UTC (rev 3388) +++ twiki/branches/DEVELOP/data/TWiki/CommentsTmpl.txt 2004-12-09 12:23:56 UTC (rev 3389) @@ -1,5 +1,3 @@ -%META:TOPICINFO{author="PeterThoeny" date="1091934169" format="1.0" version="1.1"}% -%META:TOPICPARENT{name="CommentPlugin"}% Templates for CommentPlugin - See %TWIKIWEB%.CommentPlugin#Customisation for help *WARNING: THIS FILE WILL BE OVERWRITTEN WHEN YOU UPGRADE THE COMMENT PLUGIN* @@ -14,18 +12,9 @@ Generic prompt box used by other templates <verbatim> %TMPL:DEF{promptbox}% -<table><tr valign="middle"><td><textarea %DISABLED% rows="%rows|3%" cols="%cols|50%" name="comment" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea></td><td><input %DISABLED% type="submit" value="%button|Add comment%" /></td></tr></table> +<table><tr valign="middle"><td><textarea %DISABLED% rows="%rows|3%" cols="%cols|70%" name="comment" wrap="soft" onfocus="if(this.value=='%MESSAGE%')this.value=''" onblur="if(this.value=='')this.value='%MESSAGE%'">%MESSAGE%</textarea></td><td><input %DISABLED% type="submit" value="%button|Add comment%" /></td></tr></table> %TMPL:END% </verbatim> -Standard comment, preserving formatting, signed and dated -<verbatim> -%TMPL:DEF{outputstandard}% - -%URLPARAM{"comment"}% - --- %WIKIUSERNAME% - %DATE% -%TMPL:END% -</verbatim> Short comment, signed and dated <verbatim> %TMPL:DEF{outputoneliner}% * %URLPARAM{"comment"}% -- %WIKIUSERNAME% - %DATE% %TIME%%TMPL:END% @@ -58,17 +47,31 @@ %TMPL:DEF{PROMPT:above}%%TMPL:P{promptbox}%%TMPL:END% </verbatim> <verbatim> -%TMPL:DEF{OUTPUT:above}%%POS:BEFORE%%TMPL:P{outputstandard}% +%TMPL:DEF{OUTPUT:above}%%POS:BEFORE%%TMPL:P{outputoneliner}% %TMPL:END% </verbatim> --------------------------------------------------------------------------- +---+++ threadmode +Wiki thread mode comment, signed and dated +<verbatim> +%TMPL:DEF{PROMPT:threadmode}%%TMPL:P{promptbox}%%TMPL:END% +</verbatim> +<verbatim> +%TMPL:DEF{OUTPUT:threadmode}%%POS:BEFORE% + +%URLPARAM{"comment"}% + +-- %WIKIUSERNAME% - %DATE% +%TMPL:END% +</verbatim> +--------------------------------------------------------------------------- ---+++ below Comments, signed and dated, added immediately below anchor <verbatim> %TMPL:DEF{PROMPT:below}%%TMPL:P{promptbox}%%TMPL:END% </verbatim> <verbatim> -%TMPL:DEF{OUTPUT:below}%%POS:AFTER%%TMPL:P{outputstandard}% +%TMPL:DEF{OUTPUT:below}%%POS:AFTER%%TMPL:P{outputoneliner}% %TMPL:END% </verbatim> --------------------------------------------------------------------------- @@ -93,12 +96,13 @@ %TMPL:END% </verbatim> --------------------------------------------------------------------------- ----+++ after: Add before the comment box +---+++ after: Add before the comment box, after the last comment <verbatim> %TMPL:DEF{PROMPT:after}%%TMPL:P{promptbox}%%TMPL:END% </verbatim> <verbatim> -%TMPL:DEF{OUTPUT:after}%%TMPL:P{outputoneliner}% %POS:BEFORE%%TMPL:END% +%TMPL:DEF{OUTPUT:after}%%NOP% +%TMPL:P{outputoneliner}% %POS:BEFORE%%TMPL:END% </verbatim> ---------------------------------------------------------------------------- ---+++ action @@ -132,42 +136,6 @@ %TMPL:END% </verbatim> ---------------------------------------------------------------------------- ----+++ poll -TWiki table that collects results from a poll on plugin usage -<verbatim> -%TMPL:DEF{PROMPT:poll}% -<table valign="middle"> - <tr> - <td align=right>Number of sites?</td> - <td align=left><input %DISABLED% type="text" name="sites" size="3" value="1"></td> - <td align=right>Plugin hacked?</td> - <td align=left> - <select %DISABLED% name="pluginhacked"> - <option>no</option> - <option>yes</option> - </select> - </td> - <td align=right>TWiki hacked?</td> - <td align=left> - <select %DISABLED% name="twikihacked"> - <option>no</option> - <option>yes</option> - </select> - </td> - <td align=right>Remarks</td> - <td align=left><input %DISABLED% type="text" name="remarks" size="30" value=""></td> - <td> - <input %DISABLED% type="submit" value="Yes, I use it" /> - </td> - </tr> -</table> -%TMPL:END% -</verbatim> -<verbatim> -%TMPL:DEF{OUTPUT:poll}%%POS:BEFORE%| %WIKIUSERNAME% | %URLPARAM{"sites"}% | %URLPARAM{"pluginhacked"}% | %URLPARAM{"twikihacked"}% | %URLPARAM{"remarks"}% | -%TMPL:END% -</verbatim> ---------------------------------------------------------------------------- ---+++ table Tablerows adding on end - TWiki:Main/FranzJosefSilli <verbatim> @@ -209,6 +177,5 @@ %TMPL:END% </verbatim> - -%TMPL:INCLUDE{"TWiki.UserTemplates"}% - +%TMPL:INCLUDE{"TWiki.UserTemplates"}% +<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. --> Modified: twiki/branches/DEVELOP/data/TWiki/RenderListPlugin.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/RenderListPlugin.txt 2004-12-09 11:32:47 UTC (rev 3388) +++ twiki/branches/DEVELOP/data/TWiki/RenderListPlugin.txt 2004-12-09 12:23:56 UTC (rev 3389) @@ -1,376 +1,376 @@ %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 =%<nop>RENDERLIST{ <parameters> }%= before any bullet list - * The lists can be handcrafted, generated by another Plugin, a =%<nop>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 =[<nop>[][]]= 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 - -<table border="0" cellspacing="5" cellpadding="3"><tr><th valign="top" bgcolor="#CCCCC"> -__You type:__ -</th><th valign="top" bgcolor="#CCCCC"> -__You get: (simulated)__ -</th><th valign="top" bgcolor="#CCCCC"> -__You get: (if installed)__ -</th></tr> -<tr><td valign="top" bgcolor="#EEEEEE"> -<pre> -%<nop>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 -</pre> -</td><td valign="top" bgcolor="#EEEEEE"> - -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.a </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.a.x </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b.x </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> continue </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b.y </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> Tim </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> Mico </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> two </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> three </nobr></td> -</tr></table> - -</td><td valign="top" bgcolor="#EEEEEE"> - -%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 - -</td></tr> -<tr><td valign="top" bgcolor="#EEEEEE"> -<pre> -%<nop>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 -</pre> -</td><td valign="top" bgcolor="#EEEEEE"> - -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.a </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.a.x </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b.x </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> continue </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b.y </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> Tim </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> Mico </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> two </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> three </nobr></td> -</tr></table> - -</td><td valign="top" bgcolor="#EEEEEE"> - -%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 - -</td></tr> -<tr><td valign="top" bgcolor="#EEEEEE"> -<pre> -%<nop>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 -</pre> -</td><td valign="top" bgcolor="#EEEEEE"> - -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> <b> one.b </b> </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b.x </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> continue </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> one.b.y </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> Tim </nobr></td> -</tr></table> -<table border="0" cellspacing="0" cellpadding="0"><tr> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> -<td valign="top"><nobr> Mico </nobr></td> -</tr></table> - -</td><td valign="top" bgcolor="#EEEEEE"> - -%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 - -</td></tr></table> - ----++ <nop>%TOPIC% Settings - -Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>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: | <!-- 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/%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 +---+ Render List Plugin + +Render bullet lists in a variety of formats + +---++ Syntax Rules + +---+++ RENDERLIST Variable + + * Place a =%<nop>RENDERLIST{ <parameters> }%= before any bullet list + * The lists can be handcrafted, generated by another Plugin, a =%<nop>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 if =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 =[<nop>[][]]= 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 + +<table border="0" cellspacing="5" cellpadding="3"><tr><th valign="top" bgcolor="#CCCCC"> +__You type:__ +</th><th valign="top" bgcolor="#CCCCC"> +__You get: (simulated)__ +</th><th valign="top" bgcolor="#CCCCC"> +__You get: (if installed)__ +</th></tr> +<tr><td valign="top" bgcolor="#EEEEEE"> +<pre> +%<nop>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 +</pre> +</td><td valign="top" bgcolor="#EEEEEE"> + +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.a </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.a.x </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b.x </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> continue </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b.y </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> Tim </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> Mico </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> two </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> three </nobr></td> +</tr></table> + +</td><td valign="top" bgcolor="#EEEEEE"> + +%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 + +</td></tr> +<tr><td valign="top" bgcolor="#EEEEEE"> +<pre> +%<nop>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 +</pre> +</td><td valign="top" bgcolor="#EEEEEE"> + +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.a </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.a.x </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b.x </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> continue </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b.y </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> Tim </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> Mico </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> two </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> three </nobr></td> +</tr></table> + +</td><td valign="top" bgcolor="#EEEEEE"> + +%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 + +</td></tr> +<tr><td valign="top" bgcolor="#EEEEEE"> +<pre> +%<nop>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 +</pre> +</td><td valign="top" bgcolor="#EEEEEE"> + +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> <b> one.b </b> </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b.x </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ud.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> continue </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/home.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> one.b.y </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_udr.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> Tim </nobr></td> +</tr></table> +<table border="0" cellspacing="0" cellpadding="0"><tr> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/empty.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/dot_ur.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><img src="%ATTACHURL%/person.gif" width="16" height="16" alt="" border="0" /></td> +<td valign="top"><nobr> Mico </nobr></td> +</tr></table> + +</td><td valign="top" bgcolor="#EEEEEE"> + +%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 + +</td></tr></table> + +---++ <nop>%TOPIC% Settings + +Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>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: | <!-- 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/%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"}% Modified: twiki/branches/DEVELOP/data/TWiki/SlideShowPlugin.txt =================================================================== --- twiki/branches/DEVELOP/data/TWiki/SlideShowPlugin.txt 2004-12-09 11:32:47 UTC (rev 3388) +++ twiki/branches/DEVELOP/data/TWiki/SlideShowPlugin.txt 2004-12-09 12:23:56 UTC (rev 3389) @@ -1,167 +1,167 @@ %META:TOPICINFO{author="PeterThoeny" date="1079859586" format="1.0" version="1.2"}% ----+!! Slide Show Plugin - -This Plugin converts a topic with headings into a slide show. - -%TOC% - ----++ Introduction - -There is already a defacto standard for presentations, why this Plugin? This Plugin makes sense for organizations that do already have lots of content in TWiki: It is easy to create a web based presentation that contains many links to related content. The Plugin does not try to compete with the bells and whistles of the other presentation program, but the markup of TWiki and other Plugins like TWiki:Plugins/ChartPlugin, TWiki:Plugins/GaugePlugin, TWiki:Plugins/SpreadSheetPlugin, TWiki:Plugins/TWikiDrawPlugin can be used to create an appealing presentation. - -Any topic with headings can be converted into a slide show. Each slide starts with a ="---++"= heading. There are two modes to view a topic: - - * Normal topic view mode: Headings and text is shown in the usual TWiki rendering, representing the outline of the slide show. This mode is useful to print handouts. - * Presentation mode: Each heading with text is shown as a slide; the format is based on a slide template. Navigation buttons are added to go to the "First", "Previous", and "Next" slide. Slide navigation is quick because it is done with anchor jumps to the same page. - -You can start the presentation by clicking on the "Start presentation" button. - ---... [truncated message content] |