Changes between Version 2 and Version 3 of TracHacks/DeprecatingHacks


Ignore:
Timestamp:
May 2, 2015, 11:36:23 AM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes, typos

Legend:

Unmodified
Added
Removed
Modified

  • TracHacks/DeprecatingHacks

    v2 v3  
    11= Deprecating Hacks
    22
    3 Hacks may be deprecated if they are superceeded by another hack that is better maintained or provides additional functionality. Hacks may also be deprecated if the plugin is directly integrated to the Trac core, or the Trac core adds equivalent functionality. A list of deprecated hacks can be found [tagged:deprecated here].
     3Hacks may be deprecated if they are superceded by another hack that is better maintained or provides additional functionality. Hacks may also be deprecated if the plugin is directly integrated to the Trac core, or the Trac core adds equivalent functionality. A list of deprecated hacks can be found [tagged:deprecated here].
    44
    55Anyone is welcome to maintain a deprecated hack, and the deprecation of a hack is not meant to be an absolute ruling on the fate of a plugin in any official sense. Hack deprecation is usually done for the following reasons:
    66 * Two or more plugins have equivalent functionality and the maintainers agree to join efforts on a single plugin going forward.
    77 * The maintainer chooses to deprecate the plugin when there are better choices in the HackIndex.
    8  * The community managers make their best judgement about a plugin in the case that the maintaininer is no longer reachable, in order to guide users towards the most useful solutions available on the site.
     8 * The community managers make their best judgement about a plugin in the case that the maintainer is no longer reachable, in order to guide users towards the most useful solutions available on the site.
    99
    10 When a hack is deprecated the following notice should be added to the top of the page:
    11 {{{#!div class="system-message"
    12 **Notice:** This plugin is deprecated. <Message here about why the plugin is deprecated>.
    13 }}}
    14 
     10To deprecate a hack, add the following notice to the top of the page just below the title:
    1511{{{
    1612{{{#!div class="system-message"
    17 **Notice:** This plugin is deprecated. <Message here about why the plugin is deprecated>.
     13**Notice:** This plugin is deprecated. <Message here about why the plugin is deprecated and/or which plugin supercedes its behavior>.
    1814}}}
    1915}}}
    2016
     17This will then be displayed as:
     18{{{#!div class="system-message"
     19**Notice:** This plugin is deprecated. <Message here about why the plugin is deprecated and/or which plugin supercedes its behavior>.
     20}}}
     21
    2122The deprecated tag should also be added to the project page.