Changeset 3998

Show
Ignore:
Timestamp:
07/09/08 14:20:38 (5 months ago)
Author:
k0s
Message:

update README

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • ticketsubmitpolicyplugin/0.11/README.txt

    r3835 r3998  
    44 
    55The TicketSubmitPolicyPlugin allows control of ticket submission based on fields and their values.  Actions are configurable via an extension point, ITicketSubmitPolicy.  Javascript is used to enforce the policy without leaving the page. 
     6 
     7Each policy has a condition, which controls when the policy is 
     8applied, and actions that are applied when the condition is met. 
     9 
     10The condition is in the form of "field" "comparitor" "field value". 
     11The field is a field of the ticket (e.g. 'type'),  
     12the field value is its value (e.g. 'defect'), 
     13the comparitor is some 
     14rule that is applied to the field and its value (e.g. 'is not'). 
     15 
     16The following comparitors have been implemented: 
     17 
     18 * is  
     19 * is not 
     20 * is in : the field is one of a list 
     21 * is not in 
     22 
     23This should probably become an extension point so that these are 
     24easily pluggable. 
     25 
     26''"is in" and 'is not in' have NOT been tested are PROBABLY CONTAIN 
     27BUGS!  only use these if you want to test them or can contribute 
     28debugging data regarding them'' 
     29 
     30Policy actions are an ExtensionPoint of components fulfilling the 
     31ITicketSubmitPolicy interface.  Bundled with the 
     32TicketSubmitPolicyPlugin are two such actions: 
     33 
     34* requires : require fields before allowing form submission 
     35 
     36* excludes : exclude fields from form display and submission 
     37 
     38Each of these, and currently actions in general, take multiple 
     39arguments in the form of ticket fields. 
    640 
    741== Example ==