Keka
the Mac OS X file archiver
Download Changelog Forum Help Trac Project

Changes between Version 1 and Version 2 of TracPlugins


Ignore:
Timestamp:
03/03/12 13:16:24 (7 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v1 v2  
    22[[TracGuideToc]]
    33
    4 Trac 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.
     4Since 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].
    55
    6 == Plugin discovery ==
     6Plugins can be either installed globally, in a shared plugins directory  (see [TracIni#GlobalConfiguration Global Configuration]) or locally for specific TracEnvironment, in its `plugins` directory.
     7Except 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.
    78
    8 From 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  ==
     9== Requirements ==
    1110
    1211To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed.
     
    1918If 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.
    2019
    21 Plugins can also consist of a single `.py` file dropped directly into the root of environment's or into shared `plugins` directory.
     20Plugins can also consist of a single `.py` file dropped into either the environment or the shared plugins directory.
    2221
    2322== Installing a Trac Plugin ==
     
    6160If 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`:
    6261{{{
    63 easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg
     62easy_install --always-unzip TracSpamFilter-0.2.1dev_r5943-py2.4.egg
    6463}}}
    6564You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
     
    7170`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:
    7271{{{
    73 easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha
     72easy_install http://svn.edgewall.com/repos/trac/plugins/0.11/spam-filter
    7473}}}
    7574