Navigation


Changes between Version 2 and Version 3 of TracPlugins


Ignore:
Timestamp:
Mar 4, 2011, 2:02:10 PM (13 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v2 v3  
    22[[TracGuideToc]]
    33
    4 Since version 0.9, Trac supports [trac:PluginList plugins] that extend the built-in functionality. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture].
     4Trac is extensible with [trac:PluginList plugins] since version 0.9. The plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture] with peculiarities described at [TracDev/PluginDevelopment plugin development] page.
    55
    6 Plugins can be either installed globally, in a shared plugins directory  (see [TracIni#GlobalConfiguration Global Configuration]) or locally for specific TracEnvironment, in its `plugins` directory.
    7 Except for the later case, the components defined in a plugin should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file.
     6== Plugin discovery ==
    87
    9 == Requirements ==
     8From the user point of view a Plugin is either standalone .py file or an .egg package. Trac looks for Plugins in a global shared plugins directory (see [TracIni#GlobalConfiguration Global Configuration]) and in `plugins` directory of local TracEnvironment. Components defined in globally installed plugins should be explicitly enabled in the [[TracIni#components-section| [components] ]] section of the trac.ini file.
     9
     10== Requirements for Trac eggs  ==
    1011
    1112To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed.
     
    1819If the `ez_setup.py` script fails to install the setuptools release, you can download it from [http://www.python.org/pypi/setuptools PyPI] and install it manually.
    1920
    20 Plugins can also consist of a single `.py` file dropped into either the environment or the shared plugins directory.
     21Plugins can also consist of a single `.py` file dropped directly into the root of environment's or into shared `plugins` directory.
    2122
    2223== Installing a Trac Plugin ==
     
    6061If Trac reports permission errors after installing a zipped egg and you would rather not bother providing a egg cache directory writable by the web server, you can get around it by simply unzipping the egg. Just pass `--always-unzip` to `easy_install`:
    6162{{{
    62 easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg
     63easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg
    6364}}}
    6465You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
     
    7071`easy_install` makes installing from source a snap. Just give it the URL to either a Subversion repository or a tarball/zip of the source:
    7172{{{
    72 easy_install http://svn.edgewall.com/repos/trac/plugins/0.11/spam-filter
     73easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha
    7374}}}
    7475