(r2) UpdateInfoPlugin < System

You are here: Foswiki>System Web>UpdateInfoPlugin (revision 2) (raw view)~~EditAttach~~
---+ Update Info Plugin

<nop>UpdateInfoPlugin will add a "new" or "updated" icon after a %SYSTEMWEB%.WikiWord link if a =%<nop>ISNEW%= tag is used after the link, and the linked topic was recently touched.

=<nop>WikiWord %<nop>ISNEW%= will be expanded to:

	* <nop>WikiWord - if the topic is neither new nor updated
	* <nop>WikiWord %N% - if the topic is younger than five days and is revision 1.1
	* <nop>WikiWord %U% - 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 %TOPIC%#PluginSettings, but can be overridden pr. topic (or in !WebPreferences pr. web), by setting variables =UPDATEINFOVERSION= and/or =UPDATEINFODAYS=.

---++ Syntax Rules

The %<nop>ISNEW%-tag must be written after a <nop>WikiWord separated by _exactly one space_.

Full %<nop>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

	* =<nop>MyTopic %<nop>ISNEW%=
	* =<nop>Web.ToPic %<nop>ISNEW%=
	* =<nop>TopIc %<nop>ISNEW{days="15"}%=
	* =<nop>TopiC %<nop>ISNEW{days="20" version="1.4"}%=

%TOPIC% supports these TML link syntaxes:

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

(All followed by the %<nop>ISNEW% syntax).

---++ Examples (Works if installed)

	* UpdateInfoPlugin %ISNEW%
	* %USERSWEB%.WebHome %ISNEW%
	* %SYSTEMWEB%.WebHome %ISNEW{days="15"}%
	* %SYSTEMWEB%.DefaultPreferences %ISNEW{days="20" version="1.4"}%
	* Sandbox.UpdateInfoPluginTest %ISNEW% (Edit and save the <nop>Sandbox.UpdateInfoPluginTest topic, and it should be highlighted with a %N% icon)

#PluginSettings
---+++ <nop>%TOPIC% Settings

	* One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
		* Set SHORTDESCRIPTION = Add a %<nop>ISNEW% tag after a %SYSTEMWEB%.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

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.

---+++ Plugin Info

|  Plugin Author: | Chris Huebsch & Foswiki:Main.SteffenPoulsen |
|  Version: | 14950 (2012-06-05) |
|  Release: | 3.1 |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  5 Jun 2012: | (3.1) - fixed crash when adding an %ISNEW tag to an url (Foswiki:Main.MichaelDaum) |
|  20 Jan 2010: | (3.0) - converted to Foswiki (Foswiki:Main.MichaelDaum) |
|  26 Jul 2006: | (2.0) - Updated to use default graphic icons from %SYSTEMWEB%.DocumentGraphics. |
|  20 Apr 2006: | (1.9) - Cairo+Dakar compatibility (Foswiki:Main.SteffenPoulsen) |
|  10 Jan 2006: | (1.8) - Dakar compatibility |
|  7 Apr 2005: | (1.7) - New variable name in plugin settings |
|  6 Apr 2005: | (1.6) - Fetch default "days" and "version" variables from variables |
|  4 Apr 2005: | (1.5) - Support for non-WikiWord topics in TML link syntaxes |
|  2 Apr 2005: | (1.4) - Support for more TML link syntaxes |
|  1 Apr 2005: | (1.3) - Plugin is now I18N-aware |
|  30 Mar 2005: | (1.2) - implemented changes/fixes from Foswiki:Extensions.UpdateInfoPluginDev |
|  15 Apr 2002: | Initial version |
|  CPAN Dependencies: | none |
|  Other Dependencies: | none |
|  Perl Version: | 5.005 |
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
|  Plugin Home: | Foswiki:Extensions/%TOPIC% |
|  Support: | Foswiki:Support/%TOPIC% |
Topic revision: r2 - 30 Nov 2012, AdminUser
System
Copyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback