ExtTopicList TWiki Plugin

An extended version of the TWikiVariable TOPICLIST which allow you to exclude topics.

Syntax Rules

• List of all topics in a web, optionally excluding some of them. The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name, $qname to double quoted name, $marker to marker parameter where topic matches selection, and $web to the name of the web.
• Syntax: %EXTTOPICLIST{"format" ...}%
• Supported parameters:

  Parameter:	Description:	Default:
  "format"	Format of one line, may include $web (name of web), $name (name of the topic), $qname (name of topic in double quotes), $marker (which expands to marker for the item matching selection only)	"$name"
  format="format"	(Alternative to above)	"$name"
  separator=", "	line separator	"$n" (new line)
  marker="selected"	Text for $marker if the item matches selection	"selected"
  selection="TopicA, TopicB"	Current value to be selected in list	(none)
  web="Name"	Name of web	Current web
  excludetopic="Web*" excludetopic="WebHome, WebChanges"	Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma.	None

• Example: %EXTTOPICLIST{"   * $web.$name"}% creates a bullet list of all topics
• Example: %EXTTOPICLIST{separator=", "}% creates a comma separated list of all topics
• Example: %EXTTOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
• Example: <select>%TOPICLIST{" <option $marker value='$name'>$name</option>" separator=" " selection="%TOPIC%"}%</select> creates an option list of web topics with the current topic selected
• Related: SEARCH, TOPICLIST, WEBLIST

Plugin Settings

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

• One line description, is shown in the Text Formatting Rules topic:
  • Set SHORTDESCRIPTION = Extends TOPICLIST by adding excludetopic

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

Plugin Installation Instructions

Plugin Info

Related Topics: T Wiki Plugins, Developer Documentation Category, Admin Documentation Category, T Wiki Preferences

-- T Wiki Contributor - 01 Feb 2006