Feedback on TopicReadersPlugin

-- PatrickNomblot - 21 Nov 2003

Thanks for sharing this Plugin with the community!

Also here I reformatted the Plugin page and changed the form. See ToolTipPluginDev for related feedback.

Specifics:

• Put form in verbatim tags so that users can copy and paste
• Reformatted the form to be XHTML
• The READERSFORMAT setting should be <li>....</li>
• For ease of use, better to create TWiki.TWikiReaders topic and put it into the package
• Better to use lowercase variable parameter names

On the Plugin code:

• For compatibility with future TWiki versions, use only the documented API in TWikiFuncModule
  • Use TWiki::Func::getCgiQuery() for the cgi object. Don't assume that the Plugin is in a CGI env, it might run by a cron job, so check if the cgi object is set
  • Use TWiki::Func::getDataDir() for the data directory. Check if the Plugin is
• The logdir might be different from the data dir. You might need to check for log files in TWiki::Func::getDataDir() and $TWiki::logDir

Hope this helps.

-- PeterThoeny - 25 Nov 2003

Thanks Patrick. It be nice to have a demo for the plugin as well.

-- MartinCleaver - 25 Nov 2003

Thank's for your help. I'll fix these points and deliver a new plugin soon.

-- PatrickNomblot - 28 Nov 2003

To use this plugin with Cairo, replace formatGmTime with something like &TWiki::Func::formatTime($time, "http", gmtime); twice (note the third parameter, gmtime) in TopicReaderPlugin.pm. The formatTime procedure is deprecated in Cairo but still available.

-- SteffenPoulsen - 05 Sep 2004

I changed Steffen's suggestion to use the official Plugin API call. If you want to make this Plugin work on older and newer TWiki installations use conditional code. See example in SharedCodeDev, my comment on 22 May 2004.

• Thanks for pointing out the better solution, Peter -- SteffenPoulsen - 05 Sep 2004

-- PeterThoeny - 05 Sep 2004

checked .zip into CVS

-- WillNorris - 19 Jul 2005

I have uploaded a Dakar-compatible version (a local user would like to continue to use this in TWiki 4). I might get back to Cairo-compatibility, but I have kept the Cairo compatible version separately until then.

-- SteffenPoulsen - 18 Aug 2006