Changes between Version 8 and Version 9 of HackProcedures


Ignore:
Timestamp:
Sep 12, 2016, 8:04:43 PM (8 years ago)
Author:
figaro
Comment:

Propagate better plugin naming, tagged with help

Legend:

Unmodified
Added
Removed
Modified

  • HackProcedures

    v8 v9  
    11[[PageOutline(2-5,Contents)]]
    22
    3 = Hack Procedures
     3= Plugin Procedures
    44
    5 This page lists some procedures around adding and maintaining Trac hacks. The TracHacks page contains more information, contact details, bug reports, enhancements, suggestions, etc.
     5This page lists some procedures around adding and maintaining Trac plugins. The TracHacks page contains more information, contact details, bug reports, enhancements, suggestions, etc.
    66
    7 == Contributing a hack
     7== Contributing a plugin
    88
    9 To contribute a hack, do the following:
     9To contribute a plugin, do the following:
    1010
    1111 1. [/register Register] a user name and [/login login] with that name (requires cookies).
    1212 1. Fill out the NewHack form.
    1313 1. Verify that all the details for your new page are correct.
    14  1. Commit your code to the provided Subversion URL. Alternatively, you can attach your hack to your Wiki page, but you can't delete or replace attachments.
     14 1. Commit your code to the provided Subversion URL. Alternatively, you can attach your plugin to your Wiki page, but you can't delete or replace attachments.
    1515 1. Consider subscribing to the [wiki:WikiStart#FeedbackandSuggestions trac-hacks mailing list].
    1616
    17 === List your own hack hosted elsewhere
     17=== List your own plugin hosted elsewhere
    1818
    19 Feel free to create a stub page here with a short description and links to your own hack. Please adhere to the page naming convention by appending the hack type, so that a plugin that creates Gantt charts is called '''!GanttPlugin''' and a generic !DoStuff macro is named '''DoStuffMacro'''.
     19Feel free to create a stub page here with a short description and links to your own plugin. Please adhere to the page naming convention by appending the plugin type, so that a plugin that creates Gantt charts is called '''!GanttPlugin''' and a generic !DoStuff macro is named '''DoStuffMacro'''.
    2020
    21 Once you have created your page, tag it with the hack type and it will appear on the HackIndex. Tag it with your [wiki:user TracHacks user ID], if you want it to show up on your user page.
     21Once you have created your page, tag it with the plugin type and it will appear on the HackIndex. Tag it with your [wiki:user TracHacks user ID], if you want it to show up on your user page.
    2222
    23 === Adopt Unmaintained Hacks
     23=== Adopt Unmaintained Plugins
    2424
    2525See AdoptingHacks.
    2626
    27 == Trac hacks tag guidelines
     27== Trac plugins tag guidelines
    2828
    29 Tags are keywords that can be added to your hack and provide a broad categorisation to your hack to indicate its type and scope. Tags can be added to your hack through the keywords field, which is present at the bottom of the hack's wiki page. Tags are entered as free format text and therefore need to be maintained manually.
     29Tags are keywords that can be added to your plugin and provide a broad categorisation to your plugin to indicate its type and scope. Tags can be added to your plugin through the keywords field, which is present at the bottom of the plugin's wiki page. Tags are entered as free format text and therefore need to be maintained manually.
    3030
    3131=== Finding tags and plugins using tags
    3232
    33  - The currently used tags can be found on the Trac hacks tag cloud: https://trac-hacks.org/tags
    34  - The hacks meeting a certain keyword, say `notification`, can be found as follows: https://trac-hacks.org/tags/notification?wiki=on
    35  - Hacks sharing the same tag can be found by adding the following macro to your wiki page: `[[ListTagged(notification)]]`
     33 - The currently used tags can be found on the tag cloud: https://trac-hacks.org/tags
     34 - The plugins meeting a certain keyword, say `notification`, can be found as follows: https://trac-hacks.org/tags/notification?wiki=on
     35 - Plugins sharing the same tag can be found by adding the following macro to your wiki page: `[[ListTagged(notification)]]`
     36 - When referring to plugins with similar functionality on your wiki page, use `[[ListTagged(realm:wiki notification)]]`
    3637
    3738=== Purpose
    3839
    39 Tags make your hack accessible to a wider audience in the following ways:
    40  1. gives an indication of how well tested and maintained your hack is
    41  1. makes other hacks that offer similar functionality easier to find
    42  1. gives an indication of the functional scope of your hack
     40Tags make your plugin accessible to a wider audience in the following ways:
     41 1. gives an indication of how well tested and maintained your plugin is
     42 1. makes other plugins that offer similar functionality easier to find
     43 1. gives an indication of the functional scope of your plugin
    4344
    4445=== Tag guidelines
    4546
    46 When authoring or maintaining hacks, always make sure the tags are up to date by providing at least these keywords:
     47When authoring or maintaining plugins, always make sure the tags are up to date by providing at least these keywords:
    4748 - Type: `plugin`, `script`, `macro`, `theme`, `patch`. See [wiki:type type].
    4849 - Trac release number for which the plugin has been tested: `0.12`, `1.0` etc. See [wiki:release release].
    … …  
    5657TracHacks uses the TagsPlugin to add basic categorisation to its Trac content.
    5758
    58 Additionally, TracHacks uses a couple of [wiki:metatag metatags] when creating new hacks: [wiki:release release] and [wiki:type type]. '''Please don't abuse this.''' If a tag page (eg [wiki:macro macro]) is itself tagged with one of the meta-tags, it will be included as an option in NewHack. To understand what this means, just take a look at page [wiki:type type] as an example.
     59Additionally, TracHacks uses a couple of [wiki:metatag metatags] when creating new plugins: [wiki:release release] and [wiki:type type]. '''Please don't abuse this.''' If a tag page (eg [wiki:macro macro]) is itself tagged with one of the meta-tags, it will be included as an option in NewHack. To understand what this means, just take a look at page [wiki:type type] as an example.
    5960
    6061== Site-specific TracLinks
    … …  
    6465Examples:
    6566 * [wiki:user Registered users] of TracHacks
    66  * Hacks for Trac [wiki:0.11], [wiki:0.12] and [wiki:1.0]
    67  * [wiki:example Example] hacks
     67 * Plugins for Trac [wiki:0.11], [wiki:0.12] and [wiki:1.0]
     68 * [wiki:example Example] plugins
    6869
    6970== Community and Site Evolution