Changes between Version 3 and Version 4 of TicketCreateButtonsPlugin


Ignore:
Timestamp:
Apr 19, 2012 3:58:16 PM (2 years ago)
Author:
AdrianFritz
Comment:

As in ticket/9978 ticket-name -> field-name. Cosmetics.

Legend:

Unmodified
Added
Removed
Modified
  • TicketCreateButtonsPlugin

    v3 v4  
    99== Usage == 
    1010 
    11   1. Inside a TracIni file you can customize ticket properties 
     11  1. Under the appropriate section inside a TracIni file you can customize ticket properties as below: 
    1212     {{{ 
    1313       [ticket-create-buttons] 
    14        <ticket-name>.<argument> = value 
     14       <field-name>.<argument> = value 
    1515     }}}  
    16      * Where `<ticket-name>.<argument> = value` can be one or many from: 
    17 ||'''Argument'''[[BR]]  ||'''Version'''[[BR]]  ||'''Required (R)[[BR]]Optional (O)''' ||'''Description'''[[BR]] ||'''Default'''[[BR]]  || 
    18 ||  `tag`  || ||  R  ||Argument to `genshi.filters.Transfomer` used to find the ticket form element to which the button will be prepended. Typically a custom field name.[[BR]]* Example:  {{{ blockedby.tag = .//td[@headers="h_blockedby"] }}} ||  None  || 
    19 ||  `label`  || ||  R  ||The label for the button.[[BR]]* Example:  {{{ blockedby.label = Create }}} ||  None  || 
    20 ||  `title`  || ||  R  ||The HTML title element used as a tool tip for the button.[[BR]]* Example:  {{{ blockedby.title = Create a new predecessor }}} ||  None  || 
    21 ||  `inherit`  || ||  O  ||Comma-separated list of fields whose values should be inherited from the current ticket. If present but blank, no fields are inherited.[[BR]]* Example:  {{{ blockedby.inherit = type, milestone }}} ||  None  || 
    22 ||  `link`  || ||  O  ||Comma-separated list of `newfield:currentfield` pairs used to link the two tickets. The `link` field override `inherit` field.[[BR]]* Example:  {{{ blockedby.link = blocking:id }}} sets the new ticket's blockedby field to the current tickets id. ||  None  || 
    23 ||  `set`  || ||  O  ||Comma-separated list of `field:value` pairs for setting values in the new ticket. The `set` field override `inherit` and `link` fields. [[BR]]* Example:  {{{ set = keywords:Foo }}} sets the new ticket's keywords field to Foo.||  None  || 
    24   2. Example - Using the plugin with MasterTicketsPlugin, the following configuration creates buttons to create predecessor and successor tickets: 
     16     * Where `<field-name>.<argument> = value` can be one or many from below: 
     17       * R - Required 
     18       * 0 - Optional 
     19||'''Argument'''[[BR]]  ||'''Version'''[[BR]]  ||'''R / O''' ||'''Description'''[[BR]]  ||'''Default'''[[BR]]  || 
     20||  `tag`  || >= 0.1 ||  R  ||Argument to `genshi.filters.Transfomer` used to find the ticket form element to which the button will be prepended. Typically a custom field name.[[BR]]* Example:  {{{ blockedby.tag = .//td[@headers="h_blockedby"] }}} ||  None  || 
     21||  `label`  || >= 0.1 ||  O  ||The label for the button.[[BR]]* Example:  {{{ blockedby.label = Create }}} ||  `<field-name>`  || 
     22||  `title`  || >= 0.1 ||  O  ||The HTML title element used as a tool tip for the button.[[BR]]* Example:  {{{ blockedby.title = Create predecessor }}} ||  None  || 
     23||  `inherit`  || >= 0.1 ||  O  ||Comma-separated list of fields whose values should be inherited from the current ticket. If present but blank, no fields are inherited.[[BR]]* Example:  {{{ blockedby.inherit = type, milestone }}} ||  No fields are inherited.  || 
     24||  `link`  || >= 0.1 ||  O  ||Comma-separated list of `newfield:currentfield` pairs used to link the two tickets. The `link` field override `inherit` field.[[BR]]* Example:  {{{ blockedby.link = blocking:id }}} sets the new ticket's blockedby field to the current tickets id. ||  None  || 
     25||  `set`  || >= 0.1 ||  O  ||Comma-separated list of `field:value` pairs for setting values in the new ticket. The `set` field override `inherit` and `link` fields. [[BR]]* Example:  {{{ set = keywords:Foo }}} sets the new ticket's keywords field to Foo.||  None  || 
     26  2. Example - Using this plugin with MasterTicketsPlugin, the following configuration creates buttons to create predecessor and successor tickets: 
    2527     {{{ 
    2628     [ticket-create-buttons] 
     
    3941  1. Example - When used with SubticketsPlugin, new siblings can be created with: 
    4042     {{{ 
     43     [ticket-create-buttons] 
    4144     parents.tag = .//td[@headers=&#34;h_parents&#34;] 
    4245     parents.label = Create 
     
    4750== Installation == 
    4851 
    49   1. '''Be noticed''' 
    50      1. below instructions should be specific for some O.S. Please, help improving them. 
    51      1. broader installation guidelines are made available on [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] 
     52  1. '''Be noticed''': 
     53     1. Below instructions should be specific for some O.S. Please, help expanding this instructions. 
     54     1. Broader installation guidelines are made available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins] 
     55     1. Sections not used, are suggested to be kept under comment. In future you might need it. For example: 
     56        {{{ 
     57        {{{ 
     58        #!comment 
     59        1. '''Check''' dependencies: 
     60           i. none required 
     61           * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]] 
     62        }}}         
     63        }}} 
     64     [[BR]][[BR]] 
    5265  {{{ 
    5366  #!comment 
     
    6578        * ,,`[sudo]` is optional case you already have enough authority to modify your server.,, 
    6679        * ,,You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`,,[[BR]][[BR]] 
    67   1. '''Enable''' this component by updating TracIni file as follows: 
     80  1. '''Enable''' this component as follows: 
     81     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 
    6882     {{{ 
    6983     [components] 
     84     ... 
    7085     ticketcreatebuttons.* = enabled 
     86     ... 
    7187     }}} 
    72   1. '''Configure''' this component in its own configuration section, by updating TracIni file as follows: 
    73      i. case using this plugin with SubticketsPlugin 
    74      {{{ 
    75      parents.tag = .//td[@headers=&#34;h_parents&#34;] 
    76      parents.label = Create 
    77      parents.title = Create a new sibling 
    78      parents.inherit = type, milestone, parents 
    79      }}} 
     88     * or accessing your Admin panel ({{{ ..admin/general/plugins }}}, case you have WebAdminPlugin enabled);[[BR]][[BR]] 
     89  1. '''Configure''' environment as follows: 
     90     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section; 
     91       i. case using this plugin with SubticketsPlugin 
     92       {{{ 
     93       [ticket-create-buttons] 
     94       parents.tag = .//td[@headers=&#34;h_parents&#34;] 
     95       parents.label = Create 
     96       parents.title = Create a new sibling 
     97       parents.inherit = type, milestone, parents 
     98       }}} 
    8099  1. '''Restart''' web server on command line: 
    81100     {{{ 
     
    85104       * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]] 
    86105  1. '''Test''' if this component is working properly.  
    87      1. If the plugin is installed correct, the example shown in the [#Usage] section on this page should reflect on tickets.[[BR]][[BR]] 
     106     1. If the plugin is installed correct, the configuration you have made should reflect on tickets.[[BR]][[BR]] 
    88107 
    89108== Bugs/Feature Requests ==