Render List Plugin

Render bullet lists in a variety of formats

Syntax Rules

RENDERLIST Macro

• Place a %RENDERLIST{ }% before any bullet list
  • The lists can be handcrafted, generated by another Plugin, a %TOC%, or the result of a FormattedSearch
• Supported parameters:

  "name" or theme="name"	Select a rendering theme
  focus="any text"	Focus list on a bullet with specified text
  depth="2"	Remove bullets with an indent greater then the depth. The depth is relative to the highlighted bullet in case focus is specified

• Rendering themes can be defined by _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 _THEME = tree, <0/1 flag to suppress/show lines of first level>
• Format of the icon render type:
  • Set _THEME = icon, <0/1 flag to suppress/show lines of first level>, , , , , , ,
  • To define new Icon themes, attach images to this Plugin topic and set the parameters accordingly
• Focus bullet list:
  • Search bullet list for text. If a bullet is found:
    1. Highlight text and remove [[][]] links on bullet where text is found
    2. Reduce bullet list to show only its parents and children
  • This is useful to maintain one large bullet list with links to team pages, representing the organization of a company. Each team page can INCLUDE the bullet list with focus set to itself.

Bullets

• Use regular * bullets
• Start with level one
  • Increase indentation only one level at a time
    • Like this
• Decreasing indentation many levels at a time is OK
• Wrap long text with continuation lines, the Plugin does not do that for you
  Align continuation lines with leading spaces like this
• You can specify an icon for a bullet of render type tree or icon:
  • Attach the icon to this Plugin topic, e.g. myicon.gif, or
  • Use one of the existing icons: globe.gif, home.gif, virtualhome.gif, group.gif, persons.gif, virtualpersons.gif, person.gif, virtualperson.gif, email.gif, trend.gif, folder.gif, folders.gif, file.gif, files.gif, doc.gif, image.gif, pdf.gif, ppt.gif, sound.gif, xls.gif, zip.gif, see.gif
  • Refer to an attached icon at the beginning of the bullet with:
    • icon:myicon Followed by normal bullet text
  • Any DocumentGraphics 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	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	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	one   one.b   one.b.x   continue   one.b.y   Tim   Mico

Themes

Themes are defined by setting a preference called RENDERLISTPLUGIN__THEME (for example, RENDERLISTPLUGIN_THREAD_THEME ) and contain a comma-delimited list of render type and parameters. The default themes are:

Theme	Render type
THREAD	tree, 1
HOME	icon, 1, 16, 16, , , , ,
ORG	icon, 0, 16, 16, , , , ,
GROUP	icon, 0, 16, 16, , , , ,
EMAIL	icon, 0, 16, 16, , , , ,
TREND	icon, 0, 16, 16, , , , ,
FILE	icon, 0, 16, 16, , , , ,

Plugin Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in configure, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.

• Test if the installation was successful: See if above examples work

Plugin Info

Related Topics: Plugins, DeveloperDocumentationCategory, AdminDocumentationCategory, DefaultPreferences, SitePreferences, Foswiki:Extensions/TreePlugin

I	Attachment	Action	Size	Date	Who	Comment
gif	doc.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	Doc icon 16x16
gif	dot_ud.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Dot I-graph 16x16
gif	dot_udr.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Dot T-graph 16x16
gif	dot_ur.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Dot L-graph 16x16
gif	email.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	E-mail icon 16x16
gif	empty.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Empty 16x16 spacer
gif	file.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	File icon 16x16
gif	files.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	Files icon 16x16
gif	folder.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	Folder icon 16x16
gif	folders.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	Folders icon 16x16
gif	globe.gif	manage	1.0 K	04 Oct 2010 - 17:13	AdminUser	Globe icon 16x16
gif	group.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	Group icon 16x16
gif	home.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	Home icon 16x16
gif	image.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	Image icon 16x16
gif	pdf.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	PDF icon 16x16
gif	person.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Person icon 16x16
gif	persons.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	Two persons icon 16x16
gif	ppt.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	PPT icon 16x16
gif	see.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	See icon 16x16
gif	sound.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	Sound icon 16x16
gif	trend.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Trend icon 16x16
gif	virtualhome.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	Virtual home icon 16x16
gif	virtualperson.gif	manage	0.1 K	04 Oct 2010 - 17:13	AdminUser	Virtual person icon 16x16
gif	virtualpersons.gif	manage	0.2 K	04 Oct 2010 - 17:13	AdminUser	Virtual persons icon 16x16
gif	xls.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	XLS icon 16x16
gif	zip.gif	manage	0.9 K	04 Oct 2010 - 17:13	AdminUser	ZIP icon 16x16