Update Info Plugin

Visually indicate if a topic behind a WikiWord was created or updated recently


UpdateInfoPlugin will add a "new" or "updated" icon after a WikiWord link if a %ISNEW% variable is used after the link, and the linked topic was recently touched.

WikiWord %ISNEW% will be expanded to:

  • WikiWord - if the topic is neither new nor updated
  • WikiWord NEW - if the topic is younger than five days and is revision 1.1
  • WikiWord UPDATED - if the topic revision is higher than 1.1 and the topic was updated during the last five days

Default values for the "version" and "days" parameters are set sitewide here in UpdateInfoPlugin#PluginSettings, but can be overridden per topic (or in WebPreferences per web), by setting variables UPDATEINFOVERSION and/or UPDATEINFODAYS.

Syntax Rules

The %ISNEW% variable must be written after a WikiWord separated by exactly one space.

Full %ISNEW% syntax takes one or two options:

  • days: Changes the number of days a Topic is marked as new or updated
  • version: Specifies which revision is still considered to be new

Full syntax overrides site/topic defaults.

Syntax Examples

  • MyTopic %ISNEW%
  • Web.ToPic %ISNEW%
  • GrødWeb.BlåBærGrød %ISNEW% (I18N characters in WikiWords and WebNames are matched)
  • TopIc %ISNEW{days="15"}%
  • TopiC %ISNEW{days="20" version="1.4"}%

The UpdateInfoPlugin supports these TWikiML link syntaxes:

  • WikiWord
  • WikiWord as WebName.WikiWord
  • [[WikiWord][link text]]
  • [[WebName.WikiWord][link text]]
  • [[link text]]
  • [[link-text]] (links to non-WikiWord topics, i.e. topic names containing special chars like "-")
  • [[singleword]]
  • WIK IWO RDS (abbreviations / acronyms)

(All followed by the %ISNEW% variable).

Examples (Work if Installed)

UpdateInfoPlugin Settings

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Visually indicate if a topic behind a WikiWord was created or updated recently

  • Sitewide "version" default

  • Sitewide "days" default

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

Installation Instructions

  • 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 UpdateInfoPlugin.zip in your twiki installation directory. Content:
      File: Description:
      data/TWiki/UpdateInfoPlugin.txt Plugin topic
      lib/TWiki/Plugins/UpdateInfoPlugin.pm Plugin Perl module
    • Set the ownership of the extracted directories and files to the webserver user.
    • Install the dependencies (if any).

  • Plugin configuration and testing:
    • Run the configure script and enable the plugin in the Plugins section.
    • Configure additional plugin settings in the Extensions section if needed.
    • Test if the installation was successful: See example above.

Plugin Info

Plugin Author: TWiki:Main.ChrisHuebsch, TWiki:Main.SteffenPoulsen
Copyright: © 2002 TWiki:Main.ChrisHuebsch
© 2005-2006 TWiki:Main.SteffenPoulsen
© 2008-2011 TWiki:TWiki.TWikiContributor
License: GPL (GNU General Public License)
Plugin Version: 2011-04-07
Change History:  
2011-04-06: TWikibug:Item6638: Doc improvements -- TWiki:Main.PeterThoeny
26 Jul 2006: (v2.0) - Updated to use default graphic icons from TWikiDocGraphics.
20 Apr 2006: (v1.9) - Cairo+Dakar compatibility (TWiki:Main.SteffenPoulsen)
10 Jan 2006: (v1.8) - Dakar compatibility
7 Apr 2005: (v1.7) - New variable name in plugin settings
6 Apr 2005: (v1.6) - Fetch default "days" and "version" variables from TWiki variables
4 Apr 2005: (v1.5) - Support for non-WikiWord topics in TWikiML link syntaxes
2 Apr 2005: (v1.4) - Support for more TWikiML link syntaxes
1 Apr 2005: (v1.3) - Plugin is now I18N-aware
30 Mar 2005: (v1.2) - implemented changes/fixes from TWiki:Plugins.UpdateInfoPluginDev
15 Apr 2002: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
TWiki:Plugins/Benchmark: GoodStyle 99%, FormattedSearch 99%, UpdateInfoPlugin 99%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/UpdateInfoPlugin
Feedback: http://TWiki.org/cgi-bin/view/Plugins/UpdateInfoPluginDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/UpdateInfoPluginAppraisal

Related Topics: TWikiPreferences, UserDocumentationCategory, TWikiPlugins

Topic revision: r1 - 2011-04-07 - TWikiContributor
This site is powered by the TWiki collaboration platform Powered by Perl This site is powered by the TWiki collaboration platformCopyright © 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.UpdateInfoPlugin.