Changes between Version 1 and Version 2 of KeepInterfaceSimplePlugin


Ignore:
Timestamp:
Dec 1, 2015, 8:28:42 PM (8 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified
  • KeepInterfaceSimplePlugin

    v1 v2  
    55== Description
    66
    7 This plugin helps support complex workflows that contain lots of fields or have lots of rules about what is and isn't permitted. It can dynamically control what fields appear in the user interface depending on quite complex conditions that are nonetheless easy to define and configure. It can also block commits if necessary, such as when certain information hasn't been provided.
     7This plugin supports complex workflows that contain lots of fields or have lots of rules about what is and isn't permitted. It can dynamically control what fields appear in the user interface depending on complex conditions that are nonetheless easy to define and configure. It can also block commits if necessary, such as when certain information hasn't been provided.
    88
    99There are two main components, named 'assistant' and 'warden'.
    1010
    1111The Assistant uses expressions to define what fields are presented to the user in different circumstances. For example, take the rules:
    12 {{{
     12{{{#!ini
    1313[kis_assistant]
    1414approval.visible = !status in 'new', 'closed'
     
    1818approval.available.full_set = authname has_role 'approver' || _approval == 'Approved'
    1919}}}
     20
    2021This requires that a custom field named 'approval' is defined (either a Select or a Radio field) with options 'Not assessed', 'Denied' and 'Approved'. The first rule states that the field only appears when the ticket status is other than 'new' or 'closed'. The basic set of options 'Not assessed' or 'Denied' are always available, but the full set of options including 'Approved' is only available if the user is a member of the 'approver' group or if the field already had the value 'Approved' when the page was loaded.
    2122
    2223The Warden prevents commits from being made if certain conditions aren't met. For example, take the rules:
    23 {{{
     24{{{#!ini
    2425[kis_warden]
    2526approval required to close = status == 'closed' && approval != 'Approved'
    2627only designated approver can approve = !authname has_role 'approver' && approval != _approval && approval == 'Approved'
    2728}}}
     29
    2830The first rule means that the ticket cannot be closed if the 'approval' field has not been set to the value 'Approved'. The second rule means that only a user who is a member of the group 'approver' can change the 'approval' field to that value.
    29 
    3031
    3132== !Bugs/Feature Requests
     
    4546== Source
    4647
    47 You can check out KeepInterfaceSimplePlugin from [http://trac-hacks.org/svn/keepinterfacesimpleplugin here] using Subversion, or [source:keepinterfacesimpleplugin browse the source] with Trac.
     48You can check out KeepInterfaceSimplePlugin from [/svn/keepinterfacesimpleplugin here] using Subversion, or [source:keepinterfacesimpleplugin browse the source] with Trac.
    4849
    4950== Installation