Changes between Version 27 and Version 28 of AdvancedTicketWorkflowPlugin


Ignore:
Timestamp:
Sep 17, 2015, 8:17:03 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • AdvancedTicketWorkflowPlugin

    v27 v28  
    11[[PageOutline(2-5,Contents,pullout)]]
     2
    23= Advanced Ticket Workflow Plugin
    34
    45== Description
    56
    6 AdvancedTicketWorkflowPlugin provides a number of advanced operations for customizable workflows that are similar to the operations provided in the customizeable workflow of the core system.
     7This plugin provides a number of advanced operations for customizable workflows that are similar to the operations as part of the customizeable workflow of the core system.
    78
    89Currently provided operations are:
    … …  
    1718 * xref
    1819
    19 File requests for additional operations as enhancement tickets.
    20 
    2120== Bugs/Feature Requests
    2221
    … …  
    2423
    2524If you have any issues, create a
    26 [/newticket?component=AdvancedTicketWorkflowPlugin&owner=retracile new ticket].
     25[/newticket?component=AdvancedTicketWorkflowPlugin&owner=retracile new ticket]. File requests for additional operations as enhancement tickets.
    2726
    2827[[TicketQuery(component=AdvancedTicketWorkflowPlugin&group=type,format=progress)]]
    2928
    30 == Download and Source
     29== Download
    3130
    32 Download the [download:advancedticketworkflowplugin zipped source], check out [/svn/advancedticketworkflowplugin using Subversion], or [source:advancedticketworkflowplugin browse the source] with Trac.
     31Download the [download:advancedticketworkflowplugin zipped source].
     32
     33== Source
     34
     35Check out [/svn/advancedticketworkflowplugin using Subversion], or [source:advancedticketworkflowplugin browse the source] with Trac.
    3336
    3437== Installation
    … …  
    4043and copy the `.egg` file from the `dist` directory to your Trac environment's `plugins` directory.
    4144
    42 Then enable the plugin with:
     45Then enable the plugin in your `trac.ini` file with:
    4346{{{#!ini
    4447[components]
    … …  
    6467== Configuration
    6568
    66  * set_owner_to_reporter  (!TicketWorkflowOpOwnerReporter)
     69 * set_owner_to_reporter (!TicketWorkflowOpOwnerReporter)
    6770    Sets the owner to the ticket reporter.
    6871{{{#!ini
    6972<someaction>.operations = set_owner_to_reporter
    7073}}}
    71  * set_owner_to_component_owner  (!TicketWorkflowOpOwnerComponent)
     74 * set_owner_to_component_owner (!TicketWorkflowOpOwnerComponent)
    7275    Sets the owner to the ticket's component owner.
    7376{{{#!ini
    7477<someaction>.operations = set_owner_to_component_owner
    7578}}}
    76  * set_owner_to_field  (!TicketWorkflowOpOwnerField)
     79 * set_owner_to_field (!TicketWorkflowOpOwnerField)
    7780    Sets the owner to the value of a ticket field.
    7881{{{#!ini
    … …  
    8083<someaction>.set_owner_to_field = mycustomfield
    8184}}}
    82  * set_owner_to_previous  (!TicketWorkflowOpOwnerPrevious)
    83     Sets the owner to the previous owner.  If there is no previous owner, the owner will be deleted.
     85 * set_owner_to_previous (!TicketWorkflowOpOwnerPrevious)
     86    Sets the owner to the previous owner. If there is no previous owner, the owner will be deleted.
    8487{{{#!ini
    8588<someaction>.operations = set_owner_to_previous
    8689}}}
    87  * set_status_to_previous  (!TicketWorkflowOpStatusPrevious)
    88     Sets the status to the previous status.  If there is no previous status, this is a no-op.
     90 * set_status_to_previous (!TicketWorkflowOpStatusPrevious)
     91    Sets the status to the previous status. If there is no previous status, this is a no-op.
    8992{{{#!ini
    9093<someaction>.operations = set_status_to_previous
    9194}}}
    9295 * reset_milestone (!TicketWorkflowOpResetMilestone)
    93     Will reset the milestone of a ticket if the milestone has been completed.  This is useful for "reopen" actions.
     96    Will reset the milestone of a ticket if the milestone has been completed. This is useful for "reopen" actions.
    9497{{{#!ini
    9598<someaction>.operations = reset_milestone
    9699}}}
    97100 * run_external (!TicketWorkflowOpRunExternal)
    98     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.'''
     101    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.'''
    99102{{{#!ini
    100103<someaction>.operations = run_external
    … …  
    102105}}}
    103106 * triage (!TicketWorkflowOpTriage)
    104     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.
     107    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:
    105108{{{#!ini
    106109<someaction> = somestatus -> *
    … …  
    110113}}}
    111114
    112     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.
     115    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:
    113116{{{#!ini
    114117accept = new -> *
    … …  
    131134
    132135 * xref (TicketWorkflowOpXRef)
    133     Adds a comment to the ticket specified in the text field.  Enter either the bare ticket number or '#' + ticket number.  The format of the comment to be added to the other ticket is given as a python string with a single `%s` in it. That format string defaults to `'Ticket %s is related to this ticket'`.
     136    Adds a comment to the ticket specified in the text field. Enter either the bare ticket number or '#' + ticket number. The format of the comment to be added to the other ticket is given as a Python string with a single `%s` in it. That format string defaults to `'Ticket %s is related to this ticket'`.
    134137
    135     Also adds a comment to the local ticket.  The format of the comment for the local ticket can be specified with `.xref_local`; it defaults to `'Ticket %s was marked as related to this ticket'`. This functionality can be disabled by setting `.xref_local` to an empty value.
     138    Also adds a comment to the local ticket. The format of the comment for the local ticket can be specified with `.xref_local`; it defaults to `'Ticket %s was marked as related to this ticket'`. This functionality can be disabled by setting `.xref_local` to an empty value.
    136139
    137140    Note that the implementation of this operation is not robust.