Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r6  >  r5  >  r4  >  r3  >  r2  >  r1
RenderListPlugin 6 - 02 Mar 2004 - Main.PeterThoeny
Line: 1 to 1
 

Render List Plugin

Render bullet lists in a variety of formats

Line: 38 to 38
  Align continuation lines with leading spaces linke this
  • You can specify an icon for a bullet of render type tree or icon:
    • Attach the icon to this Plugin topic, e.g. myicon.gif, or
Changed:
<
<
    • Use one of the existing icons: home.gif home.gif, virtualhome.gif virtualhome.gif, group.gif group.gif, persons.gif persons.gif, virtualpersons.gif virtualpersons.gif, person.gif person.gif, virtualperson.gif virtualperson.gif, email.gif email.gif, trend.gif trend.gif
>
>
    • Use one of the existing icons: globe.gif globe.gif, home.gif home.gif, virtualhome.gif virtualhome.gif, group.gif group.gif, persons.gif persons.gif, virtualpersons.gif virtualpersons.gif, person.gif person.gif, virtualperson.gif virtualperson.gif, email.gif email.gif, trend.gif trend.gif, folder.gif folder.gif, file.gif file.gif, doc.gif doc.gif, image.gif image.gif, pdf.gif pdf.gif, ppt.gif ppt.gif, sound.gif sound.gif, xls.gif xls.gif, zip.gif zip.gif, see.gif see.gif
 
    • Refer to an attached icon at the beginning of the bullet with:
      • icon:myicon Followed by normal bullet text
Line: 334 to 334
 
    • Set GROUP_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, group.gif
    • Set EMAIL_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, email.gif
    • Set TREND_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, trend.gif
Added:
>
>
    • Set FILE_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, file.gif
 

Plugin Installation Instructions

Line: 352 to 353
 

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Changed:
<
<
Plugin Version: 29 Dec 2003 (V1.030)
>
>
Plugin Version: 01 Mar 2004 (V1.031)
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
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
Line: 367 to 369
 Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TreePlugin
Changed:
<
<
-- TWiki:Main/PeterThoeny - 29 Dec 2003
>
>
-- TWiki:Main/PeterThoeny - 01 Mar 2004
 
META FILEATTACHMENT attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
Line: 381 to 384
 
META FILEATTACHMENT attr="h" comment="Virtual home icon 16x16" date="1072729802" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Virtual person icon 16x16" date="1072729816" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Virtual persons icon 16x16" date="1072729828" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"
Added:
>
>
META FILEATTACHMENT attr="h" comment="Folder icon 16x16" date="1078198167" name="folder.gif" path="folder.gif" size="903" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Doc icon 16x16" date="1078198182" name="doc.gif" path="doc.gif" size="922" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="File icon 16x16" date="1078197981" name="file.gif" path="file.gif" size="151" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Image icon 16x16" date="1078198228" name="image.gif" path="image.gif" size="943" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="PDF icon 16x16" date="1078198007" name="pdf.gif" path="pdf.gif" size="938" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="PPT icon 16x16" date="1078198239" name="ppt.gif" path="ppt.gif" size="921" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Sound icon 16x16" date="1078198274" name="sound.gif" path="sound.gif" size="166" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Xls icon 16x16" date="1078198301" name="xls.gif" path="xls.gif" size="918" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="ZIP icon 16x16" date="1078198079" name="zip.gif" path="zip.gif" size="940" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="See icon 16x16" date="1078198098" name="see.gif" path="see.gif" size="81" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Globe icon 16x16" date="1078211622" name="globe.gif" path="C:\Data\Temp\globe.gif" size="1024" user="PeterThoeny" version="1.1"

RenderListPlugin 5 - 29 Dec 2003 - Main.PeterThoeny
Line: 1 to 1
 

Render List Plugin

Render bullet lists in a variety of formats

Line: 38 to 38
  Align continuation lines with leading spaces linke this
  • You can specify an icon for a bullet of render type tree or icon:
    • Attach the icon to this Plugin topic, e.g. myicon.gif, or
Changed:
<
<
    • Use one of the existing icons: home.gif home.gif, group.gif group.gif, persons.gif persons.gif, person.gif person.gif, email.gif email.gif
>
>
    • Use one of the existing icons: home.gif home.gif, virtualhome.gif virtualhome.gif, group.gif group.gif, persons.gif persons.gif, virtualpersons.gif virtualpersons.gif, person.gif person.gif, virtualperson.gif virtualperson.gif, email.gif email.gif, trend.gif trend.gif
 
    • Refer to an attached icon at the beginning of the bullet with:
      • icon:myicon Followed by normal bullet text
Line: 333 to 333
 
    • Set ORG_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, home.gif
    • Set GROUP_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, group.gif
    • Set EMAIL_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, email.gif
Added:
>
>
    • Set TREND_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, trend.gif
 

Plugin Installation Instructions

Line: 351 to 352
 

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Changed:
<
<
Plugin Version: 16 Dec 2003 (V1.030)
>
>
Plugin Version: 29 Dec 2003 (V1.030)
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
29 Dec 2003: Fixed rendering issue if focus bullet contains icon:name; added TREND_THEME
 
16 Dec 2003: Specify icons with icon:name syntax
11 Dec 2003: Added focus and depth parameters
Changed:
<
<
05 Dec 2003: Fixed rendering issue with IE, added EMAIL_THEME
>
>
05 Dec 2003: Fixed rendering issue with IE; added EMAIL_THEME
 
02 Dec 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Line: 365 to 367
 Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TreePlugin
Changed:
<
<
-- TWiki:Main/PeterThoeny - 16 Dec 2003
>
>
-- TWiki:Main/PeterThoeny - 29 Dec 2003
 
META FILEATTACHMENT attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
Line: 375 to 377
 
META FILEATTACHMENT attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"
Added:
>
>
META FILEATTACHMENT attr="h" comment="Trend icon 16x16" date="1072729767" name="trend.gif" path="trend.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Virtual home icon 16x16" date="1072729802" name="virtualhome.gif" path="virtualhome.gif" size="162" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Virtual person icon 16x16" date="1072729816" name="virtualperson.gif" path="virtualperson.gif" size="149" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Virtual persons icon 16x16" date="1072729828" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="PeterThoeny" version="1.1"

RenderListPlugin 4 - 17 Dec 2003 - Main.PeterThoeny
Line: 1 to 1
 

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

Added:
>
>

RENDERLIST Variable

 
  • Place a %RENDERLIST{ <parameters> }% before any bullet list
    • The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch
  • Supported parameters:
Line: 25 to 27
 
      1. Reduce bullet list to show only its parents and children
    • This is useful to maintain one large bullet list with links to team pages, representing the organization of a company. Each team page can INCLUDE the bullet list with focus set to itself.
Added:
>
>

Bullets

  • Use regular * bullets
  • Start with level one
    • Increase indentation only one level at a time
      • Like this
  • Decreasing indentation many levels at a time is OK
  • Wrap long text with continuation lines, the Plugin does not do that for you
    Align continuation lines with leading spaces linke this
  • You can specify an icon for a bullet of render type tree or icon:
    • Attach the icon to this Plugin topic, e.g. myicon.gif, or
    • Use one of the existing icons: home.gif home.gif, group.gif group.gif, persons.gif persons.gif, person.gif person.gif, email.gif email.gif
    • Refer to an attached icon at the beginning of the bullet with:
      • icon:myicon Followed by normal bullet text
 

Examples

Line: 44 to 61
 
      • one.b.x continue
      • one.b.y
Changed:
<
<
continue
>
>
        • icon:person Tim
        • icon:person Mico
 
  • two
  • three
Line: 92 to 110
 
Changed:
<
<
continue
>
>
Tim
Mico
 
Line: 113 to 141
 
      • one.b.x continue
      • one.b.y
Changed:
<
<
continue
>
>
        • icon:person Tim
        • icon:person Mico
 
  • two
  • three
Line: 128 to 157
 
      • one.b.x continue
      • one.b.y
Changed:
<
<
continue
>
>
        • icon:person Tim
        • icon:person Mico
 
  • two
  • three
Line: 175 to 205
 
Added:
>
>
  Tim
 
Changed:
<
<
  continue
>
>
  Mico
 
Line: 197 to 235
 
      • one.b.x continue
      • one.b.y
Changed:
<
<
continue
>
>
        • icon:person Tim
        • icon:person Mico
 
  • two
  • three
Line: 212 to 251
 
      • one.b.x continue
      • one.b.y
Changed:
<
<
continue
>
>
        • icon:person Tim
        • icon:person Mico
 
  • two
  • three
Line: 248 to 288
 
Added:
>
>
  Tim
 
Changed:
<
<
  continue
>
>
  Mico
 

Line: 262 to 310
 
      • one.b.x continue
      • one.b.y
Changed:
<
<
continue
>
>
        • icon:person Tim
        • icon:person Mico
 
  • two
  • three
Line: 302 to 351
 

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Changed:
<
<
Plugin Version: 11 Dec 2003 (V1.020)
>
>
Plugin Version: 16 Dec 2003 (V1.030)
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
16 Dec 2003: Specify icons with icon:name syntax
 
11 Dec 2003: Added focus and depth parameters
05 Dec 2003: Fixed rendering issue with IE, added EMAIL_THEME
02 Dec 2003: Initial version
Line: 315 to 365
 Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TreePlugin
Changed:
<
<
-- TWiki:Main/PeterThoeny - 11 Dec 2003
>
>
-- TWiki:Main/PeterThoeny - 16 Dec 2003
 
META FILEATTACHMENT attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
Changed:
<
<
META FILEATTACHMENT attr="h" comment="Group icon 16x16" date="1070519432" name="group.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"
>
>
META FILEATTACHMENT attr="h" comment="Group icon 16x16" date="1071619807" name="group.gif" path="group.gif" size="162" user="PeterThoeny" version="1.2"
 
META FILEATTACHMENT attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"
Added:
>
>
META FILEATTACHMENT attr="h" comment="Person icon 16x16" date="1071619819" name="person.gif" path="person.gif" size="153" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Two persons icon 16x16" date="1071619835" name="persons.gif" path="persons.gif" size="164" user="PeterThoeny" version="1.1"

RenderListPlugin 3 - 12 Dec 2003 - Main.PeterThoeny
Line: 1 to 1
 

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

Changed:
<
<
  • Put a %RENDERLIST{ theme="name" }% or simply %RENDERLIST{"name"}% before any bullet list
>
>
  • Place a %RENDERLIST{ <parameters> }% before any bullet list
 
    • The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch
Added:
>
>
  • Supported parameters:
    "name" or
    theme="name"
    Select a rendering theme
    focus="any text" Focus list on a bullet with specified text
    depth="2" Remove bullets with an indent greater then the depth. The depth is relative to the highlighted bullet in case focus is specified
 
  • Rendering themes can be defined by <name>_THEME Plugin settings
    • Each theme is defined by a comma separated list containing the render type and parameters required by that render type
    • There are different render types; this initial Plugin version has tree and icon render types
Line: 15 to 19
 
  • Format of the icon render type:
    • Set <name>_THEME = icon, <0/1 flag to suppress/show lines of first level>, <icon width>, <icon height>, <spacer graph>, <T-line graph>, <I-line graph>, <L-line graph>, <icon image>
    • To define new Icon themes, attach images to this Plugin topic and set the parameters accordingly
Added:
>
>
  • Focus bullet list:
    • Search bullet list for text. If a bullet is found:
      1. Highlight text and remove [[][]] links on bullet where text is found
      2. Reduce bullet list to show only its parents and children
    • This is useful to maintain one large bullet list with links to team pages, representing the organization of a company. Each team page can INCLUDE the bullet list with focus set to itself.
 

Examples

Line: 41 to 50
 
Changed:
<
<
one
>
>
 
Changed:
<
<
one.a
>
>
one
one.a
 
Changed:
<
<
one.a.x
>
>
one.a.x
 
Changed:
<
<
one.b
>
>
one.b
 
Changed:
<
<
one.b.x
>
>
one.b.x
 
Changed:
<
<
continue
>
>
continue
 
Changed:
<
<
one.b.y
>
>
one.b.y
 
Changed:
<
<
continue
two
three
>
>
continue
two
three
 
Line: 107 to 134
 
Changed:
<
<
  one
>
>
  one
 
Changed:
<
<
  one.a
>
>
  one.a
 
Changed:
<
<
  one.a.x
>
>
  one.a.x
 
Changed:
<
<
  one.b
>
>
  one.b
 
Changed:
<
<
  one.b.x
>
>
  one.b.x
 
Changed:
<
<
  continue
>
>
  continue
 
Changed:
<
<
  one.b.y
>
>
  one.b.y
 
Changed:
<
<
  continue
  two
  three
>
>
  continue
  two
  three
 
Line: 156 to 201
 
  • two
  • three
Added:
>
>
%RENDERLIST{ "org" focus="one.b" }%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
			  continue
	* two
	* three

  one
  one.b
  one.b.x
  continue
  one.b.y
  continue

  one
  one.b
  one.b.x
  continue
  one.b.y
  continue

 

RenderListPlugin Settings

Line: 192 to 302
 

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Changed:
<
<
Plugin Version: 05 Dec 2003 (V1.010)
>
>
Plugin Version: 11 Dec 2003 (V1.020)
 
Change History:
<-- versions below in reverse order -->
 
Added:
>
>
11 Dec 2003: Added focus and depth parameters
 
05 Dec 2003: Fixed rendering issue with IE, added EMAIL_THEME
02 Dec 2003: Initial version
CPAN Dependencies: none
Line: 204 to 315
 Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TreePlugin
Changed:
<
<
-- TWiki:Main/PeterThoeny - 05 Dec 2003
>
>
-- TWiki:Main/PeterThoeny - 11 Dec 2003
 
META FILEATTACHMENT attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"

RenderListPlugin 2 - 05 Dec 2003 - Main.PeterThoeny
Line: 1 to 1
 

Render List Plugin

Render bullet lists in a variety of formats

Line: 173 to 173
 
    • Set HOME_THEME = icon, 1, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, home.gif
    • Set ORG_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, home.gif
    • Set GROUP_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, group.gif
Added:
>
>
    • Set EMAIL_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, email.gif
 

Plugin Installation Instructions

Line: 191 to 192
 

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Changed:
<
<
Plugin Version: 02 Dec 2003 (V1.000)
>
>
Plugin Version: 05 Dec 2003 (V1.010)
 
Change History:
<-- versions below in reverse order -->
 
Changed:
<
<
02 Nov 2003: Initial version
>
>
05 Dec 2003: Fixed rendering issue with IE, added EMAIL_THEME
02 Dec 2003: Initial version
 
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Line: 202 to 204
 Related Topics: TWikiPreferences, TWikiPlugins, TWiki:Plugins/TreePlugin
Changed:
<
<
-- TWiki:Main/PeterThoeny - 02 Dec 2003
>
>
-- TWiki:Main/PeterThoeny - 05 Dec 2003
 
META FILEATTACHMENT attr="h" comment="Empty 16x16 spacer" date="1070519327" name="empty.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\empty.gif" size="100" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot T-graph 16x16" date="1070519374" name="dot_udr.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_udr.gif" size="109" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot I-graph 16x16" date="1070519385" name="dot_ud.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ud.gif" size="108" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Dot L-graph 16x16" date="1070519398" name="dot_ur.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\dot_ur.gif" size="106" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Home icon 16x16" date="1070519417" name="home.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\home.gif" size="172" user="PeterThoeny" version="1.1"
META FILEATTACHMENT attr="h" comment="Group icon 16x16" date="1070519432" name="group.gif" path="C:\Data\MyTWiki\Plugins\RenderListPlugin\pub\TWiki\RenderListPlugin\group.gif" size="160" user="PeterThoeny" version="1.1"
Added:
>
>
META FILEATTACHMENT attr="h" comment="E-mail icon 16x16" date="1070659089" name="email.gif" path="email.gif" size="183" user="PeterThoeny" version="1.1"

RenderListPlugin 1 - 04 Dec 2003 - Main.PeterThoeny
Line: 1 to 1
Added:
>
>

Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

  • Put a %RENDERLIST{ theme="name" }% or simply %RENDERLIST{"name"}% before any bullet list
    • The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch
  • Rendering themes can be defined by <name>_THEME Plugin settings
    • Each theme is defined by a comma separated list containing the render type and parameters required by that render type
    • There are different render types; this initial Plugin version has tree and icon render types
  • Format of the tree render type:
    • Set <name>_THEME = tree, <0/1 flag to suppress/show lines of first level>
  • Format of the icon render type:
    • Set <name>_THEME = icon, <0/1 flag to suppress/show lines of first level>, <icon width>, <icon height>, <spacer graph>, <T-line graph>, <I-line graph>, <L-line graph>, <icon image>
    • To define new Icon themes, attach images to this Plugin topic and set the parameters accordingly

Examples

You type: You get: (simulated) You get: (if installed)
%RENDERLIST{"thread"}%
	* one
		* one.a
			* one.a.x
		* one.b
			* one.b.x
			  continue
			* one.b.y
			  continue
	* two
	* three

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

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

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

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

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

RenderListPlugin Settings

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

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

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

  • Themes are named <SOMETHING>_THEME and contain a comma delimited list of render type with parameters:
    • Set THREAD_THEME = tree, 1
    • Set HOME_THEME = icon, 1, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, home.gif
    • Set ORG_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, home.gif
    • Set GROUP_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, group.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 RenderListPlugin.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/RenderListPlugin.txt Plugin topic
    data/TWiki/RenderListPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/RenderListPlugin.pm Plugin Perl module
    pub/TWiki/RenderListPlugin/*.gif Image files for themes
  • Test if the installation was successful:
    • See if the above example works

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Plugin Version: 02 Dec 2003 (V1.000)
Change History:
<-- versions below in reverse order -->
 
02 Nov 2003: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev

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

-- TWiki:Main/PeterThoeny - 02 Dec 2003

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

Revision 6r6 - 02 Mar 2004 - 03:39:00 - PeterThoeny?
Revision 5r5 - 29 Dec 2003 - 20:33:00 - PeterThoeny?
Revision 4r4 - 17 Dec 2003 - 00:17:00 - PeterThoeny?
Revision 3r3 - 12 Dec 2003 - 08:01:17 - PeterThoeny?
Revision 2r2 - 05 Dec 2003 - 21:19:00 - PeterThoeny?
Revision 1r1 - 04 Dec 2003 - 06:38:00 - PeterThoeny?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM