Edgewall Software

Changes between Version 29 and Version 30 of TracPlugins


Ignore:
Timestamp:
Aug 28, 2006, 4:27:01 PM (18 years ago)
Author:
Christopher Lenz
Comment:

Minor corrections

Legend:

Unmodified
Added
Removed
Modified
  • TracPlugins

    v29 v30  
    22[[TracGuideToc]]
    33
    4 Since version 0.9, Trac supports plugins that extend the built-in functionality. The plugin functionality is based on the [wiki:TracDev/ComponentArchitecture component architecture].
     4Since version 0.9, Trac supports plugins that extend the built-in functionality. The plugin functionality is based on the [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture].
    55
    66== Requirements ==
     
    3131Note that the Python version that the egg is built with must
    3232match the Python version with which Trac is run.  If for
    33 instance you are running Trac under `mod_python2.3`, but have
     33instance you are running Trac under Python 2.3, but have
    3434upgraded your standalone Python to 2.4, the eggs won't be
    3535recognized.
     
    3939==== With an .egg file ====
    4040
    41 Some plugins (such as WebAdmin) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
     41Some plugins (such as [http://trac.edgewall.org/wiki/WebAdmin WebAdmin]) are downloadable as a `.egg` file which can be installed with the `easy_install` program:
    4242{{{
    4343easy_install TracWebAdmin-0.1.1dev_r2765-py2.3.egg
    4444}}}
    4545
    46 If `easy_install` is not on your system see the Requirements section above to install it.  Windows users will need to add "C:\Python23\Scripts" to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information).
     46If `easy_install` is not on your system see the Requirements section above to install it.  Windows users will need to add the `Scripts` directory of their Python installation (for example, `C:\Python23\Scripts`) to their `PATH` environment variable (see [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install Windows notes] for more information).
    4747
    4848If 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`:
     
    5252You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents.
    5353
    54 Trac also searches for globally installed plugins under `$share/trac/plugins` ''(since [milestone:0.10])''.
     54Trac also searches for globally installed plugins under `$prefix/share/trac/plugins` ''(since 0.10)''.
    5555
    5656==== From source ====
     
    100100}}}
    101101
    102 If your web server does not support the `SetEnv` directive, put this
    103 {{{
    104 os.environ['PYTHON_EGG_CACHE'] = '/path/to/dir'
    105 }}}
    106 into `CGIRequest.__init__()` inside `cgi_frontend.py`.
     102 ''Note: this requires the `mod_env` module''
    107103
    108104For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
     
    131127=== Is the plugin enabled? ===
    132128
    133 If you install a plugin globally (i.e. ''not'' inside the `plugins` directory of the Trac project environment) you will have to explicitly enable it in [wiki:TracIni trac.ini]. Make sure that:
     129If you install a plugin globally (i.e. ''not'' inside the `plugins` directory of the Trac project environment) you will have to explicitly enable it in [TracIni trac.ini]. Make sure that:
    134130 * you actually added the necessary line(s) to the `[components]` section
    135131 * the package/module names are correct
     
    143139=== Check the log files ===
    144140
    145 Enable [wiki:TracLogging logging] in Trac, set the log level to `DEBUG` and then watch the log file for messages about loading plugins.
     141Enable [TracLogging logging] in Trac, set the log level to `DEBUG` and then watch the log file for messages about loading plugins.
    146142
    147143----
    148 See also TracGuide, [wiki:PluginList plugin list], [wiki:TracDev/ComponentArchitecture component architecture]
     144See also TracGuide, [http://trac.edgewall.org/wiki/PluginList plugin list], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture]