[[PageOutline(2-5,Contents,pullout)]]

= Ticket Create Buttons plugin

== Description

The !TicketCreateButtons plugin creates configurable buttons in the ticket header to create related tickets.  The new ticket can inherit field values from the current ticket.

== Bugs/Feature Requests

Existing '''[report:9?COMPONENT=TicketCreateButtonsPlugin bugs and feature requests]''' for !TicketCreateButtonsPlugin.

If you have any issues, create a '''[/newticket?component=TicketCreateButtonsPlugin&owner=ChrisNelson new ticket]''' (please review base before creating).

[[TicketQuery(component=TicketCreateButtonsPlugin&group=type,format=progress)]]

== Source and Download

You can [/svn/ticketcreatebuttonsplugin check out] !TicketCreateButtonsPlugin using Subversion, or [source:ticketcreatebuttonsplugin browse the source] with Trac, or [download:ticketcreatebuttonsplugin download] the zipped source.

== Installation

  1. '''Note''':
     1. Below instructions could be specific to some operating systems. Please help expanding these instructions.
     1. Generic installation guidelines are available at [http://trac.edgewall.org/wiki/TracPlugins TracPlugins].
     1. `[sudo]`, when used, is optional case you already have enough authority to modify your server.[[BR]][[BR]]
  1. '''Install''' plugin: 
     * with easy_install, globally:
       {{{#!sh
       [sudo] easy_install https://trac-hacks.org/svn/ticketcreatebuttonsplugin
       }}}
       * You might be required to select a specific `tag`, `branch`. Defaults to select from `trunk`[[BR]][[BR]]
  1. '''Enable''' this component as follows:
     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section:
     {{{#!ini
     [components]
     ...
     ticketcreatebuttons.* = enabled
     ...
     }}}
     * or accessing your Admin panel under selected Trac environment {{{ ..admin/general/plugins }}}.
     [[BR]][[BR]]
  1. '''Configure''' Trac environment as follows:
     * by updating [wiki:TracIni trac.ini] file under appropriate configuration section:
       i. case using this plugin with SubticketsPlugin
       {{{#!ini
       [ticket-create-buttons]
       parents.tag = .//td[@headers="h_parents"]
       parents.label = Create
       parents.title = Create a new sibling
       parents.inherit = type, milestone, parents
       }}}
     * or accessing your Admin panel (under selected Trac environment {{{ ..admin/general/plugins }}}).
     [[BR]][[BR]]
  1. '''Restart''' web server:
     * Apache on Ubuntu, example command line:
       {{{#!sh
       [sudo] /etc/init.d/apache2 restart
       }}}
       [[BR]][[BR]]
  1. '''Test''' if this component is working properly (main environment and secondary ones if also exists).
     1. If the plugin is installed correct, the configuration you have made should reflect on tickets.
     [[BR]][[BR]]

== Configuration and examples

  1. Under the appropriate section inside a TracIni file you can customize ticket properties as below:
     {{{#!ini
       [ticket-create-buttons]
       <field-name>.<argument> = value
     }}} 
     where `<field-name>.<argument> = value` can be one or many from below:
       * R - Required
       * O - Optional
||'''Argument''' ||'''Version''' ||'''R / O''' ||'''Description''' ||'''Default''' ||
||  `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  ||
||  `label`  || >= 0.1 ||  O  ||The label for the button.[[BR]]* Example:  {{{ blockedby.label = Create }}} ||  `<field-name>`  ||
||  `title`  || >= 0.1 ||  O  ||The HTML title element used as a tool tip for the button.[[BR]]* Example:  {{{ blockedby.title = Create predecessor }}} ||  None  ||
||  `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.  ||
||  `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  ||
||  `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  ||
  2. '''Example''': Using this plugin with MasterTicketsPlugin, the following configuration creates buttons to create predecessor and successor tickets:
     {{{#!ini
     [ticket-create-buttons]
     blockedby.tag = .//td[@headers="h_blockedby"]
     blockedby.label = Create
     blockedby.title = Create a new predecessor
     blockedby.inherit = type, milestone
     blockedby.link = blocking:id
     
     blocking.tag = .//td[@headers="h_blocking"]
     blocking.label = Create
     blocking.title = Create a new successor
     blocking.inherit = type, milestone
     blocking.link = blockedby:id
     }}}
  1. '''Example''': When used with SubticketsPlugin, new siblings can be created with:
     {{{#!ini
     [ticket-create-buttons]
     parents.tag = .//td[@headers="h_parents"]
     parents.label = Create
     parents.title = Create a new sibling
     parents.inherit = type, milestone, parents
     }}}

== Recent Changes

[[ChangeLog(ticketcreatebuttonsplugin, 3)]]

== Author/Contributors

'''Author:''' [wiki:ChrisNelson] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''