Update Info Plugin

UpdateInfoPlugin will add a "new" or "updated" icon after a WikiWord link if a %ISNEW% tag 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, but can be overridden pr. topic (or in WebPreferences pr. web), by setting variables UPDATEINFOVERSION and/or UPDATEINFODAYS.

Syntax Rules

The %ISNEW%-tag 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"}%

UpdateInfoPlugin supports these TWikiML link syntaxes:

  • WikiWord
  • (WikiWordAs)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% syntax).

Examples (Works if installed)

UpdateInfoPlugin Settings

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Add a %ISNEW% tag after a WikiWord to get a visual display of whether the linked topic was created or updated recently

  • Sitewide "version" default
    • Set UPDATEINFOVERSION = 1.1

  • Sitewide "days" default
    • Set UPDATEINFODAYS = 5

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

Plugin Installation Instructions

  • Just unzip the package as usual.

Plugin Info

Plugin Author: TWiki:Main.ChrisHuebsch & TWiki:Main.SteffenPoulsen
Plugin Version: v2.0
Change History:  
26 Jul 2006: (v2.0) - Updated to use default graphic icons from TWiki:TWiki.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
License: GPL (GNU General Public License)
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

-- TWiki:Main.ChrisHuebsch - 07 Apr 2005

Topic revision: r2 - 2006-07-26 - 18:57:50 - TWikiContributor
 

This site is powered by the TWiki collaboration platformCopyright © 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