Tags:
navigation1Add my vote for this tag quality1Add my vote for this tag workflow1Add my vote for this tag create new tag
, view all tags

MakeCtrlTopicsListAddOn

The TWiki:Plugins.WorkflowPlugin (ex TWiki:Plugins.ApprovalPlugin) is a great tool for adding quality management (QM) to a Wiki web. However, there is no overview about the pages which are under QM approval control. Therefore, the quality manager cannot determine which pages have to be approved.

The MakeCtrlTopicsListAddOn Add-On provides this information.

The Add-On is a simple Perl script. It is a quick hack but is nevertheless pretty useful. wink

Usage

The following you have to do once:

  1. Create a topic which shall contain the controlled-topics-report in the future ("report topic").
  2. Enter the desired colour settings on the page:
    • Format: Three spaces, then * Set CTR_RED=UNDERREVISION
      The above configures UNDERREVISION entries to be red. You can assign multiple status strings to a colour. Separate them with a comma.
    • You can use all predefined colours of your Wiki.
    • You can use the status strings defined within the ApprovalPlugin setup.
    • You can assign as many colours as you want.
  3. Set up your cron (Linux) or planned tasks (Windows) to start the script regularely. The call must look like this:
    perl <addon_script_name_with_path> <report_page_file_name_with_path>
    IDEA! The Add-On scans the web where the report topic resides.
  4. If you prefer table 2 (see "Output") to be filled, new topics must be marked accordingly. The marker string ###MakeCtrlTopicsList:topicmustbechecked must be placed at the beginning of one line of new topics. To force the marker string into new pages, the text of the topic WebTopicEditTemplate must be modified. Since the "normal" user may be confused by this string and even attempt to delete it, the following format is advisable (requires TWiki:Plugins.HiddenTextPlugin):

Example


%STARTHIDDEN%
<!--
###MakeCtrlTopicsList:topicmustbechecked
   * Set ALLOWTOPICHIDDEN = ApproveControlledPagesGroup, TWikiAdminGroup
-->
|%ORANGE% *The QM department has not yet checked this topic for QM relevance.* %ENDCOLOR%|
%ENDHIDDEN%

IDEA! Replace ApproveControlledPagesGroup with the according QM user or QM group of your Wiki.

IDEA! The QM must remove the above header after the topic check (and may add the TWiki:Plugins.WorkflowPlugin header instead).

IDEA! Instead, the QM could simply check the TWiki changes page for new topics regularely. The drawback is that the change list doesn't show if some QM employee checked the according topic already. The above marking method is a lot more fail-safe and transparent and will satisfy auditors more easily.

Output

The report topic is filled with this information:

  • Time of validity.
  • Total amount of topics in the web.
  • Table 1: List of controlled pages and their current (see above) status.
  • Table 2: List of new pages which may have to be under approval control.
    Topics which contain a certain string are listed here (see "Usage").
  • Add-On settings (concentrated at one location, idenpendent on their original location).
  • Version of the Add-On.

Example report (with only four topics under approval control):
Example Screenshot

Add-On Installation Instructions

Note: You do not need to install anything on the browser to use this add-on. The following instructions are for the administrator who installs the add-on on the server where TWiki is running.

  • Download the ZIP file from the Add-on Home (see below)
  • Unzip MakeCtrlTopicsListAddOn.zip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/MakeCtrlTopicsListAddOn.txt Add-on topic
    data/TWiki/MakeCtrlTopicsListAddOn.txt,v Add-on topic repository
    bin/makectrltopicslist.pl Add-on script
    pub/TWiki/MakeCtrlTopicsListAddOn/MCTLscreenshot.gif Example output
    pub/TWiki/MakeCtrlTopicsListAddOn/MCTLscreenshot.gif,v Example output repository
  • Test if the installation was successful:
    1. Install and configure TWiki:Plugins.WorkflowPlugin.
    2. Configure MakeCtrlTopicsListAddOn as described under "Usage".
    3. Verify that the report topic gets changed by the script.

Add-On Info

  • Set SHORTDESCRIPTION = List topics under QM approval control; extension for WorkflowPlugin

Add-on Author: TWiki:Main/DetlefMarxsen
Add-on Version: 12 Jul 2007 (v1.03)
Change History:  
07 Jun 2005: Initial version
10 Jun 2005: Bug fix (incorrect handling of topics "with dash").
Marker string must now be placed at the beginning of the line (this removes doc topic from list).
Forces link at non-WikiWord-Topics now.
10 Jun 2007: Adapted to requirements of WorkflowPlugin which replaced the ApprovalPlugin. Changed settings format as suggested in Dev-Discussion.
CPAN Dependencies: none
Other Dependencies: Useless without installed TWiki:Plugins.WorkflowPlugin
Perl Version: 5.85 (all 5.x versions should work)
License: GPL
Add-on Home: http://TWiki.org/cgi-bin/view/Plugins/MakeCtrlTopicsListAddOn
Feedback: http://TWiki.org/cgi-bin/view/Plugins/MakeCtrlTopicsListAddOnDev
Appraisal: http://TWiki.org/cgi-bin/view/Plugins/MakeCtrlTopicsListAddOnAppraisal

Related Topic: TWikiAddOns, ApprovalPlugin

-- TWiki:Main/DetlefMarxsen - 16 Jul 2007

Topic attachments
I Attachment History Action Size Date Who Comment
GIFgif MCTLscreenshot.gif r2 r1 manage 19.5 K 2007-07-16 - 14:59 DetlefMarxsen Example Screenshot
Compressed Zip archivezip MakeCtrlTopicsListAddOn.zip r3 r2 r1 manage 89.5 K 2007-07-16 - 14:54 DetlefMarxsen AddOn Package Version 1.03 (works with TWiki 4.1.2 and WorkflowPlugin)
Texttxt makectrltopicslist.pl.txt r1 manage 6.0 K 2007-03-02 - 01:19 ScottDitter (Obsolete as V 1.03 is available:) Modified V. 1.02 script to work with WorkflowPlugin
Edit | Attach | Watch | Print version | History: r9 < r8 < r7 < r6 < r5 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r9 - 2007-09-28 - DetlefMarxsen
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.