Changes between Version 24 and Version 25 of AdvancedTicketWorkflowPlugin


Ignore:
Timestamp:
Aug 24, 2014, 3:11:54 AM (8 months ago)
Author:
rjollos
Comment:

New-style markup.

Legend:

Unmodified
Added
Removed
Modified
  • AdvancedTicketWorkflowPlugin

    v24 v25  
    11[[PageOutline(2-5,Contents,pullout)]]
    2 = Advanced Ticket Workflow Plugin =
     2= Advanced Ticket Workflow Plugin
    33
    4 == Description ==
     4== Description
    55
    66AdvancedTicketWorkflowPlugin provides a number of advanced operations for customizable
     
    2020(File requests for additional operations as enhancement tickets.)
    2121
    22 == Bugs/Feature Requests ==
     22== Bugs/Feature Requests
    2323
    2424Existing bugs and feature requests for AdvancedTicketWorkflowPlugin are [query:status!=closed&component=AdvancedTicketWorkflowPlugin&order=priority here].
     
    2727[/newticket?component=AdvancedTicketWorkflowPlugin&owner=retracile new ticket].
    2828
    29 == Download and Source ==
     29== Download and Source
    3030
    3131Download the [download:advancedticketworkflowplugin zipped source], check out [/svn/advancedticketworkflowplugin using Subversion], or [source:advancedticketworkflowplugin browse the source] with Trac.
    3232
    33 == Installation ==
     33== Installation
    3434
    3535The plugin can be installed in the same way as other plugins.  The simplest is generally to create an egg with
    36 {{{
     36{{{#!sh
    3737$ python setup.py bdist_egg
    3838}}}
    3939and copy the `.egg` file from the `dist` directory to your Trac environment's `plugins` directory.
    4040
    41 == Example ==
     41== Example
    4242Enable the plugin with:
    43 {{{
    44 #!ini
     43{{{#!ini
    4544[components]
    4645advancedworkflow.* = enabled
     
    4948
    5049Add the individual controller to the workflow controller list:
    51 {{{
    52 #!ini
     50{{{#!ini
    5351[ticket]
    5452workflow = ConfigurableTicketWorkflow,TicketWorkflowOpOwnerReporter
     
    5755
    5856And use the operation in your custom workflow:
    59 {{{
    60 #!ini
     57{{{#!ini
    6158[ticket-workflow]
    6259needinfo = * -> needinfo
     
    6562}}}
    6663
    67 == Documentation ==
     64== Documentation
    6865
    6966 * set_owner_to_reporter  (!TicketWorkflowOpOwnerReporter)
    7067    Sets the owner to the ticket reporter.
    71 {{{
    72 #!ini
     68{{{#!ini
    7369<someaction>.operations = set_owner_to_reporter
    7470}}}
    7571 * set_owner_to_component_owner  (!TicketWorkflowOpOwnerComponent)
    7672    Sets the owner to the ticket's component owner.
    77 {{{
    78 #!ini
     73{{{#!ini
    7974<someaction>.operations = set_owner_to_component_owner
    8075}}}
    8176 * set_owner_to_field  (!TicketWorkflowOpOwnerField)
    8277    Sets the owner to the value of a ticket field.
    83 {{{
    84 #!ini
     78{{{#!ini
    8579<someaction>.operations = set_owner_to_field
    8680<someaction>.set_owner_to_field = mycustomfield
     
    8882 * set_owner_to_previous  (!TicketWorkflowOpOwnerPrevious)
    8983    Sets the owner to the previous owner.  If there is no previous owner, the owner will be deleted.
    90 {{{
    91 #!ini
     84{{{#!ini
    9285<someaction>.operations = set_owner_to_previous
    9386}}}
    9487 * set_status_to_previous  (!TicketWorkflowOpStatusPrevious)
    9588    Sets the status to the previous status.  If there is no previous status, this is a no-op.
    96 {{{
    97 #!ini
     89{{{#!ini
    9890<someaction>.operations = set_status_to_previous
    9991}}}
    10092 * reset_milestone (!TicketWorkflowOpResetMilestone)
    10193    Will reset the milestone of a ticket if the milestone has been completed.  This is useful for "reopen" actions.
    102 {{{
    103 #!ini
     94{{{#!ini
    10495<someaction>.operations = reset_milestone
    10596}}}
    10697 * run_external (!TicketWorkflowOpRunExternal)
    10798    Runs an external script `<tracenv>/hooks/<someaction>` passing the ticket number and the username as parameters.  '''Security warning: If you have account registration available, your hook script ''must'' treat the username as user input.'''
    108 {{{
    109 #!ini
     99{{{#!ini
    110100<someaction>.operations = run_external
    111101<someaction>.run_external = Hint to tell the user.
     
    113103 * triage (!TicketWorkflowOpTriage)
    114104    Sets the next status based on mapping the value of a field to a status value.  For example, this can be used for a "triage" action that splits a workflow based on the ticket type.
    115 {{{
    116 #!ini
     105{{{#!ini
    117106<someaction> = somestatus -> *
    118107<someaction>.operations = triage
     
    122111
    123112    The most common request is to use a different workflow based on the ticket type.  Let's simplify that case slightly for the sake of this example and assume that there are only two ticket types, `defect` and `enhancement`.  We'll say that `defect`s require a `qa` step, but `enhancement`s do not.
    124 {{{
    125 #!ini
     113{{{#!ini
    126114accept = new -> *
    127115accept.name = Accept ticket into workflow
     
    148136
    149137    Note that the implementation of this operation is not robust.
    150 {{{
    151 #!ini
     138{{{#!ini
    152139;displays as "close as duplicate [_________]"
    153140dup = * -> closed
     
    159146}}}
    160147
    161 == Recent Changes ==
     148== Recent Changes
    162149
    163150[[ChangeLog(advancedticketworkflowplugin, 3)]]
    164151
    165 == Author/Contributors ==
     152== Author/Contributors
    166153
    167154'''Author:''' [wiki:retracile] [[BR]]