Changes between Version 3 and Version 4 of TracPlugins


Ignore:
Timestamp:
01/06/25 10:28:02 (2 weeks ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • TracPlugins

    v3 v4  
    1 = Trac プラグイン = #Tracplugins
    2 [[TracGuideToc]]
    3 
    4 バージョン 0.9 以降の Trac は[trac:PluginList プラグイン機能] による機能拡張が可能です。プラグイン機能は、 [trac:TracDev/ComponentArchitecture コンポーネント設計] に基づき、 [trac:TracDev/PluginDevelopment プラグインの開発] ページに記載されているような特性を持っています。
    5 
    6 == プラグインを見つける == #Plugindiscovery
    7 
    8 ユーザの視点からいうと、プラグインはスタンドアロンの .py ファイルか .egg パッケージのどちらかです。 Trac は グローバルで共有するプラグインのディレクトリ ([TracIni#GlobalConfiguration グローバルな設定] 参照) とローカルの TracEnvironment の `plugins` ディレクトリに対して、プラグインを探します。グローバルにインストールされているプラグインを定義するコンポーネントは trac.ini ファイルの [[TracIni#components-section| [components] ]] セクションで明確に有効にするべきです。
    9 
    10 == Trac eggs ファイルにおける必要条件 == #RequirementsforTraceggs
    11 
    12 Trac で Python-egg ベースのプラグインを使用するためには、 [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (バージョン 0.6) をインストールしなければなりません。
    13 
    14 `setuptools` をインストールするために、ブートストラップモジュールである [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] をダウンロードし、以下に示すように実行して下さい:
    15 
    16 {{{
    17 $ python ez_setup.py
    18 }}}
    19 
    20 もし `ez_setup.py` スクリプトが setuptools のインストールに失敗したら、 [http://www.python.org/pypi/setuptools PyPI] をダウンロードして手動でインストールしてください。
    21 
    22 また、単一の `.py` ファイルで成り立つプラグインは、各プロジェクトの `plugins` ディレクトリか共有の `plugins` ディレクトリに配置します。
    23 
    24 == Trac プラグインのインストール == #InstallingaTracplugin
    25 
    26 === 単一のプロジェクト === #Forasingleproject
    27 
    28 プラグインは一般的に [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs] としてパッケージ化されています。つまり、拡張子が `.egg` となっている .zip アーカイブのファイルです。
    29 
    30 プラグインのディストリビューションをダウンロードして `.egg` ファイルをビルドしたい場合:
    31 
    32  * ソースをアンパックして下さい。それにより `setup.py` が提供されるでしょう
    33  * 以下のようにして実行してください:
    34 
    35 {{{
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= Trac plugins
     4
     5Trac is extensible with [trac:PluginList plugins]. Plugin functionality is based on the [trac:TracDev/ComponentArchitecture component architecture], described in the [trac:TracDev/PluginDevelopment plugin development] page.
     6
     7== Plugin discovery
     8
     9A plugin is either a single .py file or a package (.egg or .whl). Trac looks for plugins in Python's `site-packages` directory, the [TracIni#GlobalConfiguration global shared] `plugins` directory and the [TracEnvironment project environment] `plugins` directory. Plugins installed to the project environment `plugins` directory are enabled, unless explicitly disabled in the `[components]` section of the `trac.ini` file. Plugins installed elsewhere must be explicitly enabled in the [TracIni#components-section "[components]"] section of the `trac.ini` file.
     10
     11== Installing a Trac plugin
     12
     13The instructions below are applicable to plugins installed as packages. Plugins implemented as a single `py` file should be downloaded and copied to the [TracEnvironment project environment] `plugins` directory or the [TracIni#GlobalConfiguration global shared] plugins directory.
     14
     15=== For a single project
     16
     17Packages built for a single project must use the egg format, as the wheel format (described below) is not supported by the setuptools loading mechanism. Build the `egg` file from the plugin source:
     18
     19* Checkout or download and unpack the source.
     20* Change to the directory containing `setup.py` and run:
     21 {{{#!sh
    3622$ python setup.py bdist_egg
    3723}}}
    38 
    39 *.egg ファイルが出力されるはずです。実行した python の出力を調べて .egg ファイルがどこに作成されたか見つけてください。
    40 
    41 一度、プラグインアーカイブを作成したら、 [wiki:TracEnvironment TracEnvironment] の `plugins` ディレクトリにコピーする必要があります。また、 Web サーバーが egg プラグインを読み取るのに必要なパーミッションを持っているか確認してください。そして Web サーバを再起動してください。 [wiki:TracStandalone "tracd" というスタンドアロンサーバー] を使用している方は、tracd を再起動してください。
    42 
    43 この方法でインストールしたプラグインをアンインストールする場合、 `plugins` ディレクトリから egg を削除し、 Web サーバを再起動してください。
    44 
    45 Note: Python egg をビルドするための Python のバージョンと Trac を動かしている Python のバージョンが一致しなければなりません。例えば、 Trac を Python のバージョン 2.5 以前で動かしていて、 2.6 にアップグレードしたときに、Python egg は認識されなくなるでしょう。
    46 
    47 Note: マルチプロジェクトを設定している場合、 Python インタプリタインスタンスのプールはプロジェクトの必要に応じて動的にアロケートされ、プラグインは Pyhton のモジュールシステムの一定の位置を占有しますので、最初にロードされたバージョンのプラグインが、他のすべてのプロジェクトでも使用されます。言い換えれば、マルチプロジェクトセットアップされたプロジェクト間では、あるプラグインの異なるバージョンを使用することはできません。プラグインは (下記の方法で) すべてのプロジェクト向けにインストールし、個々のプロジェクトで有効/無効を設定する方が安全でしょう。
    48 
    49 === すべてのプロジェクト === #Forallprojects
    50 
    51 ==== 単一の .egg ファイル ==== #Withan.eggfile
    52 
    53 いくつかのプラグイン (例えば [trac:SpamFilter SpamFilter]) は `.egg` ファイルとしてダウンロードし、 `easy_install` プログラムでインストールすることができます:
    54 {{{
    55 easy_install TracSpamFilter
    56 }}}
    57 
    58 システムに `easy_install` がない場合、インストールするために上記の必要なセクションを見てください。 Windows ユーザは Python をインストールした `Scripts` ディレクトリ (例えば、 `C:\Python24\Scripts`) を環境変数 `PATH` に加えなければなりません。 (より詳しい情報は、 [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install の Windows Notes] を参照してください。)
    59 
    60 zip で固められた Python egg をインストールした後で Trac がパーミッションエラーを出し、 web サーバによって書き込み可能な Python egg のキャッシュディレクトリを提供したくないときは、 Python egg を解凍することで問題を回避できます。`easy_install` に `--always-unzip` オプションを付けるだけです:
    61 {{{
    62 easy_install --always-unzip TracSpamFilter-0.4.1_r10106-py2.6.egg
    63 }}}
    64 zip で固められた Python egg ファイルと同じ名前のディレクトリ (拡張子が `.egg` で終わっているもの) ができ、そのなかに解凍した中身が入っているでしょう。
    65 
    66 Trac は共有の plugins ディレクトリにインストールされたプラグインも検索します ''(0.10 以降)''。 TracIni#GlobalConfiguration を参照してください。この方法は複数の (しかし全てではない) Environment にまたがってプラグインをインストールする最も簡単な方法になります。
    67 
    68 ==== ソースから ==== #Fromsource
    69 
    70 `easy_install` を使ってソースからインストールすることができます。Subversion のリポジトリ又は ソースの tarball/zip を引数に与えてください。
    71 {{{
    72 easy_install http://svn.edgewall.com/repos/trac/plugins/0.12/spam-filter-captcha
    73 }}}
    74 
    75 ==== プラグインを有効にする ==== #Enablingtheplugin
    76 
    77 個別の TracEnvironment にプラグインをインストールする場合と異なり、システム全体にインストールしたプラグインを有効にするためには、 [wiki:TracIni trac.ini] ファイルで明示的に指定しなければいけません。設定ファイルの `[inherit] plugins_dir` オプションに指定した共有の plugins ディレクトリにプラグインをインストールする場合も同じく、明示的に指定する必要があります。
    78 
    79 設定ファイルの `[components]` セクションに次のような記述を加えれば完了です:
    80 {{{
     24 The egg file will be created in the `dist` subdirectory.
     25* Copy the egg file to the `plugins` directory of the [TracEnvironment project environment].
     26
     27Make sure the web server has sufficient permissions to read the plugin egg and restart the web server. If you are running as a [TracStandalone "tracd" standalone server], restart tracd, i.e. kill the process and run again.
     28
     29Trac also searches for plugins installed in the [TracIni#GlobalConfiguration global shared] plugins directory. This is a convenient way to share the installation of plugins across several, but not all, environments.
     30
     31'''Note''': The minor version number of the Python used to build the egg ''must'' match the minor version number of the Python running Trac. For example, if you are running Trac with Python 2.6, but build the egg with Python 2.7, the egg won't be recognized.
     32
     33'''Note''': In a multi-project setup, a pool of Python interpreters will be dynamically allocated to projects based on need. Since plugins occupy a place in Python's module system, the first version of any given plugin to be loaded will be used for all projects. In other words, you cannot use different versions of a plugin in different projects of a multi-project setup. Install plugins for all projects (see below) and enable them as needed for each project.
     34
     35==== Uninstalling #UninstallEgg
     36
     37Remove the egg from the `plugins` directory and restart the web server.
     38
     39=== For all projects
     40
     41==== Using pip
     42
     43The modern Python package manager, `pip`, is included in Python 2.7.9 and later. In earlier versions of Python it can be installed through the package manager of your OS (e.g. `apt-get install python-pip`) or using [https://pip.pypa.io/en/latest/installing.html#install-pip get_pip.py].
     44
     45Using `pip`, the plugin will be installed in the [https://pythonwheels.com/ wheel format], which is the modern standard for Python and a replacement for the egg format.
     46
     47==== From PyPI
     48
     49Some plugins, such as [https://trac-hacks.org/wiki/TagsPlugin TracTags], can be installed directly from [https://pypi.org PyPI] using `pip`:
     50{{{#!sh
     51$ pip install TracTags
     52}}}
     53
     54The version can be specified, which can be useful if you don't want to install the latest:
     55{{{#!sh
     56$ pip install TracTags==1.2
     57}}}
     58
     59==== From source
     60
     61You can install directly from a source repository:
     62{{{#!sh
     63$ pip install svn+https://trac-hacks.org/svn/tagsplugin/trunk
     64}}}
     65
     66Replace the `svn+` prefix with `git+` if installing from a Git repository.
     67
     68Or from the path or URL of a tar.gz or zip archive:
     69{{{#!sh
     70$ pip install https://trac-hacks.org/browser/tagsplugin/trunk?format=zip
     71}}}
     72
     73Or checkout the source and provide `pip` a path to the source directory:
     74{{{#!sh
     75$ svn co https://trac-hacks.org/svn/tagsplugin/trunk tractags
     76$ pip install tractags
     77}}}
     78
     79==== Enabling the plugin
     80
     81Unlike plugins installed per environment, you have to explicitly enable globally installed plugins. This also applies to plugins installed in the shared plugins directory.
     82
     83This is done in the `[components]` section of the configuration file `trac.ini`. For example:
     84{{{#!ini
    8185[components]
    82 tracspamfilter.* = enabled
    83 }}}
    84 
    85 オプションの名前はプラグインの Python パッケージ名です。これはプラグインのドキュメンテーションに指定されていなければいけませんが、ソースを見れば簡単に見つけることが出来ます。 (最上位のディレクトリにあるファイル `__init__.py` を探してください。)
    86 
    87 Note: プラグインのインストール後、 Web サーバを再起動する必要があります。
    88 
    89 ==== アンインストール ==== #Uninstalling
    90 
    91 `easy_install` や `python setup.py` ではアンインストール機能は提供されていません。しかし、グローバルにインストールされた egg や参照を削除するための簡単な方法があります:
    92 
    93  1. setuptools でインストールした場合、 `easy_install -m [plugin name]` を実行し、 `$PYTHONLIB/site-packages/easy-install.pth` から参照を削除します
    94  1. `/usr/bin`, `/usr/local/bin`, `C:\\Python*\\Scripts` などから実行可能ファイルを削除します。実行可能ファイルが分からない場合、 `setup.py` の `[console-script]` を参照してください
    95  1. インストールされた場所 (通常 `$PYTHONLIB/site-packages/` 配下) の .egg ファイルやディレクトリを削除します
    96  1. Web サーバを再起動します
    97 
    98 egg の場所が分らない場合、探すためには以下の方法を使います (この方法は、どのようなパッケージでも使えます)。`myplugin` の箇所は、プラグインのネームスペースで置き換えてください。ネームスペースはプラグインの有効化の時に使用した名前と同じになります:
    99 {{{
    100 >>> import myplugin
    101 >>> print myplugin.__file__
    102 /opt/local/python24/lib/site-packages/myplugin-0.4.2-py2.4.egg/myplugin/__init__.pyc
    103 }}}
    104 
    105 == プラグインのキャッシュの設定 == #Settinguptheplugincache
    106 
    107 いくつかのプラグインは、 その内容がファイルシステム上に存在するように、Python eggs のランタイム (`pkg_resources`) によって解凍する必要があります。通常は現在のユーザのホームディレクトリの `.python-eggs` に解凍されますが、それにより問題が発生するかもしれません。その場合、環境変数 `PYTHON_EGG_CACHE` を設定してデフォルトのロケーションを上書きすることができます。
    108 
    109 `PYTHON_EGG_CACHE` を `SetEnv` ディレクティブを使用して Apache に設定する方法:
    110 {{{
     86tractags.* = enabled
     87}}}
     88
     89The name of the option is the plugin package name. This should be specified in the documentation of the plugin, but can also be discovered by looking at the source: it is usually the top-level directory name containing a file named `__init__.py`.
     90
     91Plugins can also be enabled from the [#Web-basedpluginadministration administration] page.
     92
     93After installing the plugin, you must restart your web server.
     94
     95==== Upgrading the environment
     96
     97Some plugins require an environment upgrade. This will typically be necessary for plugins that implement `IEnvironmentSetupParticipant`. Common reasons for requiring an environment upgrade are to add tables to the database or add configuration parameters to `trac.ini`. A notification will be displayed when accessing Trac for the first time after installing a plugin and restarting the web server. To upgrade the environment, run the command:
     98
     99{{{#!sh
     100$ trac-admin /path/to/env upgrade
     101}}}
     102
     103A database backup will be made before upgrading the environment, unless the `--no-backup` option is specified. For more information, refer to the documentation output by `trac-admin /path/to/env help upgrade`.
     104
     105==== Redeploying static resources
     106
     107If you [TracInstall#MappingStaticResources mapped static resources] so they are served by the web server, and the plugin contains static resources, such as stylesheets, !JavaScript and image files, the resources will need to be deployed to the location on the filesystem that is served by the web server.
     108
     109Execute the `deploy` command, as is done during install and [TracUpgrade#a5.Refreshstaticresources upgrade]:
     110
     111{{{#!sh
     112$ trac-admin /path/to/env deploy /deploy/path
     113}}}
     114
     115After executing the command, you must restart your web server.
     116
     117{{{#!div style="border: 1pt dotted; margin: 1em"
     118**Note:** Some web browsers (IE, Opera) cache CSS and Javascript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be enough.
     119{{{#!comment
     120Remove above note once #9936 is fixed.
     121}}}
     122}}}
     123
     124==== Uninstalling #UninstallWithPip
     125
     126Get a list of installed plugins:
     127{{{#!sh
     128$ pip list
     129Package    Version
     130---------- -------
     131Jinja2     2.10.1
     132MarkupSafe 1.1.1
     133pip        19.2.2
     134setuptools 41.2.0
     135Trac       1.4
     136TracTags   0.10
     137wheel      0.33.6
     138}}}
     139
     140Uninstall a plugin by specifying the package name:
     141{{{#!sh
     142$ pip uninstall TracTags
     143}}}
     144
     145== Web-based plugin administration
     146
     147The admin page offers limited support for plugin configuration to users with `TRAC_ADMIN` permission:
     148
     149* en/dis-abling installed plugins
     150* installing plugins by uploading them as eggs
     151
     152If you wish to disable the second function for security reasons, add the following to your `trac.ini` file:
     153{{{#!ini
     154[components]
     155trac.admin.web_ui.PluginAdminPanel = disabled
     156}}}
     157This disables the whole panel, so the first function will no longer be available.
     158
     159== Setting up the plugin cache
     160
     161Some plugins installed as eggs will need to be extracted by the Python egg's runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory to which they are extracted defaults to `.python-eggs` in the home directory of the current user, which may or may not be a problem. You can, however, override the default location using the `PYTHON_EGG_CACHE` environment variable.
     162
     163To do this from the Apache configuration, use the `SetEnv` directive:
     164{{{#!apache
    111165SetEnv PYTHON_EGG_CACHE /path/to/dir
    112166}}}
    113167
    114 これは [wiki:TracCgi CGI] と [wiki:TracModPython mod_python] のどちらをフロントエンドにしようと動作します。このディレクティブに [wiki:TracEnvironment Trac Environment] へのパスに設定し、例えば同じ `<Location>` ブロックにおいてください。
    115 
    116 例 (CGI用):
    117 {{{
     168This works whether you're using the [TracCgi CGI] or the [TracModPython mod_python] front-end. Put this directive next to where you set the path to the [TracEnvironment Trac environment], i.e. in the same `<Location>` block.
     169
     170For example for CGI:
     171{{{#!apache
    118172 <Location /trac>
    119173   SetEnv TRAC_ENV /path/to/projenv
    … …  
    122176}}}
    123177
    124 例 (mod_python用):
    125 {{{
     178Or for mod_python:
     179{{{#!apache
    126180 <Location /trac>
    127181   SetHandler mod_python
    … …  
    131185}}}
    132186
    133  ''Note: !SetEnv を使用するためには、 Apache で `mod_env` モジュールが有効になっている必要があります。 `mod_python` が設定される Location ブロックでは !SetEnv ディレクティブも使用できます。''
    134 
    135 [wiki:TracFastCgi FastCGI] で、 Web サーバに設定するためには、 `-initial-env` オプションやサーバーが指定している方法で、環境変数を設定する必要があります。
    136 
    137  ''Note: プロジェクトディレクトリを設定するために、既に -initial-env を使用している場合は、 [wiki:TracFastCgi TracFastCgi] に例示されるように、必要に応じて -initial-env ディレクティブを !FastCgiConfig ディレクティブに加えてください。''
    138 
    139 {{{
     187'''Note''': !SetEnv requires the `mod_env` module, which needs to be activated for Apache. In this case the !SetEnv directive can also be used in the `mod_python` Location block.
     188
     189For [TracFastCgi FastCGI], you will need to `-initial-env` option, or whatever is provided by your web server for setting environment variables.
     190
     191'''Note''': if you already use -initial-env to set the project directory for either a single project or parent, you will need to add an additional -initial-env directive to the !FastCgiConfig directive:
     192
     193{{{#!apache
    140194FastCgiConfig -initial-env TRAC_ENV=/var/lib/trac -initial-env PYTHON_EGG_CACHE=/var/lib/trac/plugin-cache
    141195}}}
    142196
    143 === Subversion の フックスクリプトについて === #Abouthookscripts
    144 
    145 もし、 Trac エンジンを呼び出すような Subversion の フックスクリプト (Trac の配布物の `/contrib` ディレクトリで提供されている post-commit フックスクリプトなど) を設定していたら、プラグインと同様にスクリプトの中で環境変数 `PYTHON_EGG_CACHE` を定義してください。
    146 
    147 == トラブルシューティング == #Troubleshooting
    148 
    149 === setuptools は正しくインストールされていますか？ === #Issetuptoolsproperlyinstalled
    150 
    151 以下のコマンドを実行してみてください:
    152 {{{
    153 $ python -c "import pkg_resources"
    154 }}}
    155 
    156 もし、コマンドラインから '''何も''' かえって来なければ、 setuptools はインストール '''されています'''。そうでなければ、 Trac を動かす前に setuptools をインストールする必要があります。
    157 
    158 === Python egg は正しいバージョンですか？ === #DidyougetthecorrectversionofthePythonegg
    159 
    160 Python egg はファイル名の中で Python のバージョンをエンコードします。例えば、 `MyPlugin-1.0-py2.5.egg` は Python 2.5 用の Python egg であり、異なる Python のバージョン (2.4 や 2.6) で動かそうとしても '''動かない''' でしょう。
    161 
    162 また、ダウンロードした Python egg ファイル が本当に .zip アーカイブであるかどうかを確認して下さい。もし Trac サイトからダウンロードしたとしたら、 HTML プレビューページを代わりにダウンロードしているかもしれません。
    163 
    164 === プラグインは有効になっていますか？ === #Isthepluginenabled
    165 
    166 グローバル領域にプラグインをインストールした場合 (Environment の `plugins` ディレクトリ内 ''ではなく'') 、 [TracIni trac.ini] に明確に有効にする設定をしなければなりません。以下の事項を確認して下さい:
    167 
    168  * ...`[components]` セクションに必要な行数を追加したか
    169  * ...パッケージ / モジュール名は正しいか
    170  * ..."enable" や "Enable" ではなく、正しい値 "enabled" になっているかどうか
    171 
    172 === Python egg ファイルのパーミッションのチェック === #Checkthepermissionsonthe.eggfile
    173 
    174 Trac は Python egg ファイルを読み込み可能でなければなりません。
    175 
    176 === ログファイルのチェック === #Checkthelogfiles
    177 
    178 Trac で [wiki:TracLogging logging] を有効にし、ログレベルを `DEBUG` に設定し、プラグインがロードされるときのログメッセージを見て下さい。
    179 
    180 === 必要な権限を持っていることを確認してください === #Verifyyouhaveproperpermissions
    181 
    182 いくつかのプラグインでは、その機能を使用するために特別な権限を要求します。たとえば [trac:WebAdmin WebAdmin] では、ナビゲーションバーに表示するためには TRAC_ADMIN 権限が必要になります。
    183 
    184 === 読み込むプラグインのバージョンを間違えていませんか ? === #Isthewrongversionofthepluginloading
    185 
    186 複数のプロジェクトがある場合に plugins ディレクトリにプラグインを置くなら、確実に正しいバージョンのプラグインがロードされていることを確認する必要があります。ここにいくつかの基本的なルールがあります:
    187 
    188  * 実行中の Trac サーバ (すなわち各々の Python プロセス) にはプラグインの 1 バージョンだけがロードできます。 Python の名前空間とモジュールリストは (プラグインが`有効 (enabled)` になっているか `無効 (disabled)` になっているかに関わらず) 全プロジェクトで共有されるでしょう。そしてそれは複製をハンドルすることができません
    189  * グローバルにインストールされたプラグイン (通常は `setup.py install`) は共有 plugins ディレクトリあるいはプロジェクト毎の plugins ディレクトリ内のどんなバージョンも無視するでしょう。グローバルにインストールされたプラグインは、他のどのプラグインよりも''先に''動作するでしょう
    190  * Trac サーバが (`TRAC_ENV_PARENT_DIR` セットアップのように) 複数のプロジェクトをホスティングした場合、異なったプロジェクトで異なるバージョンのプラグインを使用していると、どのバージョンのプラグインが使用されるかは不明です。異なるバージョンのプラグインのうちいずれか一つがロードされるでしょう。そしてロードされたプラグインは全てのプロジェクトで共有されます。 Trac は通常一番最初にリクエストを受けたプロジェクトからプラグインをロードします
    191  * Python の site-packages 内に複数のバージョンをリストしておく (すなわち `setup.py install` を使用してインストールする) のは素晴らしいことです。 - setuptools は最も新しいバージョンを確実にインストールします。しかし、複数バージョンのプラグインを共有 plugins ディレクトリや、プロジェクト毎の plugins ディレクトリに格納しないでください。 - Trac はプラグインを探すときに バージョン番号、格納された日付などを気にしません。この場合 Trac がどのプラグインを最初に見つけ出すかを確実に指定する方法はありません
    192 
    193 === 上記のすべてに失敗した場合 === #Ifalloftheabovefailed
    194 
    195 plugins に対するログが出力されず、 egg が読み込み可能であり、 Python のバージョンが正しく、 ''その上で'' egg がグローバルにインストールされて (そして trac.ini で使用可能に設定されて) ''いても''、なぜかプラグインが動かず、なんのエラーメッセージも表示されない場合は、 [trac:IrcChannel IrcChannel] で質問してください。
    196 
    197 == web ベースのプラグイン管理 == #Web-basedpluginadministration
    198 
    199 !WebAdmin プラグイン (0.11 から標準付属) を導入することで、 `TRAC_ADMIN` 権限を持ったユーザは web 上でプラグインの設定が行えるようになります:
    200 
    201 * インストールされたプラグインの有効/無効を設定する
    202 * Python egg をアップロードすることでプラグインをインストールする
    203 
    204 セキュリティ上の理由から 2 番目の機能を無効にしたいときには、`trac.ini` の `[components]` セクションに以下の一行を追記してください。
    205 {{{
    206 trac.admin.web_ui.PluginAdminPanel = disabled
    207 }}}
    208 この設定はパネル全体を無効にしてしまうため、1 番目の機能も使用できなくなります。
     197=== About hook scripts
     198
     199If you have Subversion hook scripts that invoke Trac, such as the post-commit hook script provided in the `/contrib` directory, make sure you define the `PYTHON_EGG_CACHE` environment variable within these scripts.
     200
     201== Writing Trac Plugins
     202
     203You can write your own Trac plugin using the following resources:
     204* [trac:TracDev Developer documentation]
     205* [https://trac-hacks.org Examples on trac-hacks.org]
     206* [trac:browser:branches/1.4-stable/sample-plugins sample-plugins]
     207
     208== Troubleshooting
     209
     210=== Did you get the correct version of the Python egg?
     211
     212Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.5.egg` is an egg for Python 2.5, and will '''not''' be loaded if you're running a different Python version, such as 2.4 or 2.6.
     213
     214Also, verify that the egg file you downloaded is indeed a .zip archive. If you downloaded it from a Trac site, you may have downloaded the HTML preview page instead.
     215
     216=== Is the plugin enabled?
     217
     218If you install a plugin globally, i.e. ''not'' inside the `plugins` directory of the Trac project environment, you must explicitly enable it in [TracIni trac.ini]. Make sure that:
     219
     220 * you added the necessary line(s) to the `[components]` section.
     221 * the package/module names are correct and do not contain typos.
     222 * the value is `enabled`, not `enable` or `Enable`.
     223 * the section name is `components`, not `component`.
     224
     225=== Check the permissions
     226
     227Trac must be able to read the .py file or package (.egg or .whl).
     228
     229=== Check the log files
     230
     231See [trac:TracTroubleshooting#ChecktheLogs].
     232
     233=== Verify you have the proper permissions
     234
     235Some plugins require you have special permissions. !TracTags, for example, requires `TAGS_VIEW` permissions for the //Tags// navigation item to be added.
     236
     237=== Is the wrong version of the plugin loading?
     238
     239If you put your plugins in one of the `plugins` directories, and certainly if you have more than one project, you need to make sure that the correct version of the plugin is loading. Here are some basic rules:
     240
     241* Only one version of the plugin can be loaded for each running Trac server, i.e. each Python process. The Python namespaces and module list will be shared, and it cannot handle duplicates. Whether a plugin is `enabled` or `disabled` makes no difference.
     242* A globally installed plugin will override any version in the global or project plugins directories. A plugin from the global plugins directory will be discovered ''before'' any project plugins directory.
     243* If your Trac server hosts more than one project (as with `TRAC_ENV_PARENT_DIR` setups), having two versions of a plugin in two different projects will give unpredictable results. Only one of them will load, and the one loaded will be shared by both projects. Trac will load the first plugin found, usually from the project that receives the first request.
     244* Having more than one version listed inside Python site-packages is fine, because setuptools will make sure you get the version installed most recently. However, don't store more than one version inside a global or project plugins directory: neither the version number nor the installed date will matter at all. There is no way to determine which one will be located first when Trac searches the directory for plugins.
     245
     246=== If all of the above failed
     247
     248See TracSupport.
    209249
    210250----
    211 See also TracGuide, [trac:PluginList プラグイン一覧], [trac:TracDev/ComponentArchitecture コンポーネント設計]
     251See also TracGuide, TracIni.