Edgewall Software

Changes between Version 3 and Version 4 of TracDev/PluginDevelopment/ExtensionPoints/trac.ticket.api.ITicketManipulator


Ignore:
Timestamp:
Apr 9, 2015, 1:39:30 PM (9 years ago)
Author:
figaro
Comment:

Updated link

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/PluginDevelopment/ExtensionPoints/trac.ticket.api.ITicketManipulator

    v3 v4  
    1 == Extension Point : ''ITicketManipulator'' ==
     1== Extension Point : ''ITicketManipulator''
    22
    33||'''Interface'''||''ITicketManipulator''||'''Since'''||0.10||
     
    66The ''ITicketManipulator'' can manipulate and validate tickets before saving.
    77
    8 == Purpose ==
     8== Purpose
    99
    1010The Trac ticketing system is extendable by plugins. These plugins might add additional fields or introduce new restrictions on existing fields.
    1111They might want to automatically manage some fields. Any such ticket manipulations or validations can be added by implementing the ITicketManipulator interface.
    1212
    13 == Usage ==
     13== Usage
    1414
    1515Implementing the interface follows the standard guidelines found in [wiki:TracDev/ComponentArchitecture] and of course [wiki:TracDev/PluginDevelopment].
     
    2727}}}
    2828
    29 == Examples ==
     29== Examples
    3030
    3131One might want to maintain a wiki page with the MostFrequentDuplicates. One could [TracDev/Proposals/NewTicketDuplicateCheck take this idea further] and implement a minimal example ITicketManipulator implementation that warns about tickets already listed there:
     
    6565* comment:1:ticket:10384 Contains an example that makes milestone a required field.
    6666
    67 == Available Implementations ==
     67== Available Implementations
    6868
    6969* SpamFilter: Reject ticket changes that contain spam
     
    7272
    7373* th:TracTicketValidatorPlugin: Rejects invalid (configurable) fields.
    74 * th:RestrictKeywordsPlugin: Rejects tickets with invalid (configurable) ''keywords''.
     74* th:KeywordSuggestPlugin: Rejects tickets with invalid (configurable) ''keywords''.
    7575* th:BlackMagicTicketTweaksPlugin: Rejects ticket changes to disabled or hidden fields.
    7676* th:SensitiveTicketsPlugin: Rejects anonymous sensitive tickets.
     
    9292* th:GeoTicketPlugin: Updates a ticket's geolocation fields.
    9393
    94 == Additional Information and References ==
     94== Additional Information and References
    9595
    9696 * [http://www.edgewall.org/docs/trac-trunk/epydoc/trac.ticket.api.ITicketManipulator-class.html epydoc]
     
    107107  * #6634 Discusses validation messages containing markup (e.g. links).
    108108 * Archived mailing list discussions:
    109   * [trac-dev:289 Example] illustrating the original idea for `prepare_ticket_for_render` (This would not work now.)
     109  * [trac-dev:289 Example] illustrating the original idea for `prepare_ticket_for_render`. This would not work now.