Changes between Version 24 and Version 25 of TracKeywordsPlugin


Ignore:
Timestamp:
Jan 30, 2021, 4:04:19 PM (3 years ago)
Author:
clemens
Comment:

installation notes

Legend:

Unmodified
Added
Removed
Modified
  • TracKeywordsPlugin

    v24 v25  
    55== Description
    66
    7 This plugin allows you to add entries to the Keywords entry field from a configured list of keywords by clicking on them. Allows you to set a description for every keyword, which is shown as a tip when you hover the mouse over the keyword from "Add keywords" section.
     7This plugin allows you to add entries to the Keywords entry field from a configured list of keywords by clicking on them.
     8Allows you to set a description for every keyword, which is shown as a tip when you hover the mouse over the keyword from "Add keywords" section.
    89
    910From the "Add keywords" section:
     
    1314You can also continue to manually add other keywords which weren't listed before.
    1415
    15 To maintain keywords, edit the `[keywords]` section in your `trac.ini` file.
     16To maintain keywords, edit the `[keywords]` section in your TracIni file `trac.ini`.
     17
     18With default TRAC only tickets can have keywords. However, if the TagsPlugin is loaded, then TracKeywordsPlugin will also supports its tags for wiki pages.
    1619
    1720[[Image(TracKeywordsPlugin-atTicket.png,width=800)]]
     
    4144General instructions on installing Trac plugins can be found on the [TracPlugins#InstallingaTracplugin TracPlugins] page.
    4245
     46 1. The easiest way to '''install''' is probably with PIP:
     47{{{#!sh
     48$ pip install svn+https://trac-hacks.org/svn/trackeywordsplugin/trunk/
     49}}}
     50 1. Do not forget to '''enable''' the plugin by updating your TracIni file with:
     51 {{{#!ini
     52[components]
     53trackeywords.* = enabled
     54}}}
     55 1. See below how to '''configure''' your keywords .
     56
    4357== Configuration
    4458
    45 Add keywords to the `[keywords]` section of trac.ini. The format is `<name> = <description>`, where description is shown as a tooltip.
     59Add keywords to the `[keywords]` section of TracIni.
     60The format is `<name> = <description>`, where description is shown as a tooltip.
    4661
    4762Example: