Difference: RenderListPlugin (17 vs. 18)

Revision 182013-01-29 - TWikiContributor

 

Render List Plugin

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

Syntax Rules

RENDERLIST Variable

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

Bullets

  • Use regular * bullets
  • Start with level one
    • Increase indentation only by one level at a time
      • Like this
  • It's OK to decrease more than one indentation levels at a time
  • Wrap long text, e.g. split it up into continuation lines - the plugin does not do that for you
    Align continuation lines with leading spaces like this
  • You can specify an icon for a bullet of render type tree or icon:
    • Attach the icon to this plugin topic, e.g. myicon.gif, or
    • Use one of the existing icons: globe.gif 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, folders.gif folders.gif, file.gif file.gif, files.gif files.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
    • Any TWikiDocGraphics icon can be used as well:
      • %ICON{name}% Followed by normal bullet text

Examples

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

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

%RENDERLIST{"thread"}%

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

%RENDERLIST{"org"}%
   * one
      * one.a
         * one.a.x
      * one.b
         * one.b.x
           continue
         * one.b.y
            * icon:person Tim
            * icon:person Mico
   * two
   * three

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

%RENDERLIST{"org"}%

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

%RENDERLIST{ "org" focus="one.b" }%
   * one
      * one.a
         * one.a.x
      * one.b
         * one.b.x
           continue
         * one.b.y
            * icon:person Tim
            * icon:person Mico
   * two
   * three

  one
  one.b
  one.b.x
  continue
  one.b.y
  Tim
  Mico

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

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

RenderListPlugin Settings

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

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

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

  • Themes are named <SOMETHING>_THEME and contain a comma delimited list of render type with parameters:
    • Set THREAD_THEME = tree, 1
    • Set HOME_THEME = icon, 1, 16, 16, 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
    • 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
    • Set FILE_THEME = icon, 0, 16, 16, empty.gif, dot_udr.gif, dot_ud.gif, dot_ur.gif, file.gif

Plugin Installation Instructions

Changed:
<
<
Note: This plugin is pre-installed but not enabled by default. TWiki administrators can upgrade it as needed on the TWiki server.
>
>
This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.
Added:
>
>
<--/twistyPlugin twikiMakeVisibleInline-->
 
  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the Plugins home (see below).
    • Unzip RenderListPlugin.zip in your twiki installation directory. Content:
      File: Description:
      data/TWiki/RenderListPlugin.txt Plugin topic
      data/TWiki/VarRENDERLIST.txt Documentation of the RENDERLIST variable
      pub/TWiki/RenderListPlugin/*.gif Image files for themes
      lib/TWiki/Plugins/RenderListPlugin.pm Plugin Perl module
    • Set the ownership of the extracted directories and files to the webserver user.

  • Plugin configuration and testing:
    • Run the configure script and enable the plugin in the Plugins section.
    • Test if the installation was successful: See example above.
Added:
>
>
<--/twistyPlugin-->
 

Plugin Info

Added:
>
>
 
Plugin Author: TWiki:Main.PeterThoeny
Changed:
<
<
Copyright: © 2003-2012 Peter[at]Thoeny.org, TWiki.org
© 2003-2012 TWiki:TWiki.TWikiContributor
>
>
Copyright: © 2003-2013 Peter[at]Thoeny.org, TWiki.org
© 2003-2013 TWiki:TWiki.TWikiContributor
 
License: GPL (GNU General Public License)
Changed:
<
<
Plugin Version: 2012-12-14
Change History:
<-- versions below in reverse order -->
 
>
>
Plugin Version: 2013-01-28
%TWISTY{
Added:
>
>
mode="div" showlink="Show Change History http://twiki.oats.inaf.it/twiki/pub/TWiki/TWikiDocGraphics/toggleopen.gif" hidelink="Hide Change History toggleclose.gif " }%
2013-01-28: TWikibug:Item7091: Use TWISTY in installation instructions and change history
 
2012-11-14: TWikibug:Item7020: Categorize TWiki Variable RENDERLIST
2012-09-05: TWikibug:Item6837: Doc fixes
2011-07-09: TWikibug:Item6725: Change global package variables from "use vars" to "our"
2010-05-16: 2.1: TWikibug:Item6433 - doc improvements; replacing TWIKIWEB with SYSTEMWEB
15 Jan 2008: 2.0: Kenneth Lavrsen. No more reporting warnings in the error log when a render list starts at deeper level than 1
30 Sep 2007: Added VarRENDERLIST to have it listed in TWikiVariables
23 Sep 2006: Support for img tag and image URL after icon: (suggested by TWiki:Main.JanFilipsky); support for TWikiDocGraphics icons, such as %ICON{folder}% instead of icon:folder; added files.gif and folders.gif (contributed by TWiki:Main.SteveHobbs)
25 Apr 2006: SVN sync, Cairo + Dakar compatibility
14 Apr 2006: TWikiRelease04x00 compatibility update
21 Nov 2004: Added benchmarks (no code changes)
21 Mar 2004: Internal change: Fixed unofficial function call
01 Mar 2004: Added FILE_THEME and folder/file icons
29 Dec 2003: Fixed rendering issue if focus bullet contains icon:name; added TREND_THEME
16 Dec 2003: Specify icons with icon:name syntax
11 Dec 2003: Added focus and depth parameters
05 Dec 2003: Fixed rendering issue with IE; added EMAIL_THEME
02 Dec 2003: Initial version
Added:
>
>
</>
<--/twistyPlugin-->
 
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
TWiki:Plugins/Benchmark: GoodStyle 97%, FormattedSearch 98%, RenderListPlugin 93%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/RenderListPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/RenderListPluginAppraisal

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

META FILEATTACHMENT attr="h" comment="Empty 16x16 spacer" date="1070383918" name="empty.gif" path="empty.gif" size="100" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="E-mail icon 16x16" date="1070614932" name="email.gif" path="email.gif" size="183" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="XLS icon 16x16" date="1078162404" name="xls.gif" path="xls.gif" size="918" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="File icon 16x16" date="1078160664" name="file.gif" path="file.gif" size="151" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Person icon 16x16" date="1071565646" name="person.gif" path="person.gif" size="153" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Doc icon 16x16" date="1078160958" name="doc.gif" path="doc.gif" size="922" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Virtual persons icon 16x16" date="1072693460" name="virtualpersons.gif" path="virtualpersons.gif" size="160" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Virtual person icon 16x16" date="1072693450" name="virtualperson.gif" path="virtualperson.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Group icon 16x16" date="1071565632" name="group.gif" path="group.gif" size="162" user="TWikiContributor" version="1.2"
META FILEATTACHMENT attr="h" comment="Dot L-graph 16x16" date="1070383984" name="dot_ur.gif" path="dot_ur.gif" size="106" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="PPT icon 16x16" date="1078160706" name="ppt.gif" path="ppt.gif" size="921" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="PDF icon 16x16" date="1078160694" name="pdf.gif" path="pdf.gif" size="938" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Dot T-graph 16x16" date="1070384070" name="dot_udr.gif" path="dot_udr.gif" size="109" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Two persons icon 16x16" date="1071565666" name="persons.gif" path="persons.gif" size="164" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Sound icon 16x16" date="1078160718" name="sound.gif" path="sound.gif" size="166" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Home icon 16x16" date="1070383996" name="home.gif" path="home.gif" size="172" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Folder icon 16x16" date="1078160636" name="folder.gif" path="folder.gif" size="903" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="ZIP icon 16x16" date="1078160730" name="zip.gif" path="zip.gif" size="940" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Image icon 16x16" date="1078160678" name="image.gif" path="image.gif" size="943" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="See icon 16x16" date="1078161392" name="see.gif" path="see.gif" size="81" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Trend icon 16x16" date="1072172998" name="trend.gif" path="trend.gif" size="149" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Dot I-graph 16x16" date="1070383970" name="dot_ud.gif" path="dot_ud.gif" size="108" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Virtual home icon 16x16" date="1072693432" name="virtualhome.gif" path="virtualhome.gif" size="162" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Globe icon 16x16" date="1075199580" name="globe.gif" path="globe.gif" size="1024" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Folders icon 16x16" date="1158991906" name="folders.gif" path="folders.gif" size="913" user="TWikiContributor" version="1"
META FILEATTACHMENT attr="h" comment="Files icon 16x16" date="1158991940" name="files.gif" path="files.gif" size="907" user="TWikiContributor" version="1"
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.RenderListPlugin.