SID-01692: Updat(e|ing) documentation for "Assign to Topic" usage

Status:	Answered	TWiki version:	5.1.4	Perl version:
Category:	ActionTrackerPlugin	Server OS:	Debian Linux	Last update:	12 years ago

The documentation that comes with this plug-in mentions: "Assign to Person" and "Assign to Group" but makes no mention of "Assign to Topic".

For our purposes at wiki.knetconnect.com, "Assign to Topic" will probably be the most heavily used feature. This site will be used to "Describe, Discuss and Destribute" our "product" <- Add-ons for the Kindle e-book.

Since these Action Items are for the internal maintenance of the Wiki, they are not normally displayed to surfers and 'bots at this site.

I have set-up a guest-viewable example page at: Working Example

A "raw view" will show that this system is implemented (for the maintenance end-user) as four TWiki variables (macros).

One is specific for use on the personal profile page. The other three may be used wherever they make sense for your wiki's organization.

The code that implements this system can be found at the pages listed at: Implemenation code and descriptions

Although not (yet) mentioned in those pages, the license is MIT - feel free to use and/or adapt.

-- TWiki Guest - 2013-05-02

Discussion and Answer

Thanks Mike for sharing this with the TWiki community! I recommend to add this to the ActionTrackerPluginDev topic so that users of that plugin can more easily discover this.

Consider also packaging this as a TWiki app, see AddOnPackageHowTo. (FYI, we are working on a new TWikiAppInstaller, so that packaging of apps will change.)

Could you please register with your real name, also WikiName? The TWiki.org community prefers to address each other by real name.

-- Peter Thoeny - 2013-05-02

The support request was for an update to the package documentation.

The addition of "Assign to Topic" description following the "Assign to Person" and "Assign to Group" sections.

I think the usage is well enough established at this point to make that request.

The current working examples depend on a rather flaky parsing of %<nop>CALCULATE{SUBSTITUTE ...}%

The examples would break if that parsing was ever fixed in another revision.

So I don't feel that this un-documented feature is ready to be packaged.

But as a suggested recipe, it is certainly Q.A.'d enough for that purpose now.

The current problems are displayed at the top of the Sandbox topic I am using for development testing: Development topic - which may be broke at any moment.

Thanks for the suggestion that this might be of general interest to the user community.

MikeZ

-- TWiki Guest - 2013-05-04

If you answer a question - or someone answered one of your questions - please remember to edit the page and set the status to answered. The status selector is below the edit box.