Changes between Version 1 and Version 2 of TracPlugins
- Timestamp:
- Jun 21, 2008, 6:11:58 PM (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracPlugins
v1 v2 1 = Trac プラグイン=1 = Trac Plugins = 2 2 [[TracGuideToc]] 3 3 4 バージョン 0.9 以降、 Trac はプラグイン機能に対応し、組み込み機能を拡張できるようになりました。プラグインの機能は [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture コンポーネント設計] に基づいています。 4 Since 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]. 5 5 6 == 必要条件==6 == Requirements == 7 7 8 Python egg が基になっている Trac のプラグインを使用するためには、 [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (バージョン 0.6) をインストールしなければなりません。 8 To use egg based plugins in Trac, you need to have [http://peak.telecommunity.com/DevCenter/setuptools setuptools] (version 0.6) installed. 9 9 10 プラグインは単一の `.py` ファイルから成り立っていて、各 TracEnvironment かグローバルの `plugin` ディレクトリに配置します。 ''([http://trac.edgewall.org/milestone/0.10 milestone:0.10] 以降)'' 10 Plugins can also consist of a single `.py` file dropped into either the environment or global `plugins` directory ''(since [milestone:0.10])''. 11 11 12 `setuptools` をインストールするために、ブートストラップモジュールである [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] をダウンロードし、以下に示すように実行して下さい:12 To install `setuptools`, download the bootstrap module [http://peak.telecommunity.com/dist/ez_setup.py ez_setup.py] and execute it as follows: 13 13 {{{ 14 14 $ python ez_setup.py 15 15 }}} 16 16 17 もし `ez_setup.py` スクリプトが setuptools のインストールに失敗したら、 [http://www.python.org/pypi/setuptools PyPI] をダウンロードして手動でインストールしてください。 17 If 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. 18 18 19 == Trac プラグインのインストール==19 == Installing a Trac Plugin == 20 20 21 === 単一のプロジェクト===21 === For a Single Project === 22 22 23 プラグインは [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs] としてパッケージ化されています。つまり、拡張子が `.egg` となっている ZIP アーカイブのファイルです。プラグインのソースコードディストリビューションをダウンロードした場合は、以下のコマンドを実行して下さい:23 Plugins are packaged as [http://peak.telecommunity.com/DevCenter/PythonEggs Python eggs]. That means they are ZIP archives with the file extension `.egg`. If you have downloaded a source distribution of a plugin, you can run: 24 24 {{{ 25 25 $ python setup.py bdist_egg 26 26 }}} 27 `.egg` ファイルをビルドできます。 27 to build the `.egg` file. 28 28 29 一度、プラグインアーカイブを作成したら、 [wiki:TracEnvironment TracEnvironment] の `plugins` ディレクトリにコピーする必要があります。また、 Web サーバーが egg プラグインを読み取るのに必要なパーミッションをつけてください。 29 Once you have the plugin archive, you need to copy it into the `plugins` directory of the [wiki:TracEnvironment project environment]. Also, make sure that the web server has sufficient permissions to read the plugin egg. 30 30 31 Python egg をビルドするための Python のバージョンと 32 Trac を動かしている Python のバージョンが一致しなければなりません。 33 例えば、 Trac を Python のバージョン 2.3 以前で動かしていて、 34 2.4 にアップグレードしたときに、 35 Python egg は認識されなくなるでしょう。 31 Note that the Python version that the egg is built with must 32 match the Python version with which Trac is run. If for 33 instance you are running Trac under Python 2.3, but have 34 upgraded your standalone Python to 2.4, the eggs won't be 35 recognized. 36 36 37 === すべてのプロジェクト===37 === For All Projects === 38 38 39 ==== 単一の .egg ファイル====39 ==== With an .egg file ==== 40 40 41 いくつかのプラグイン (例えば [http://trac.edgewall.org/wiki/WebAdmin WebAdmin]) は `.egg` ファイルとしてダウンロードし、 `easy_install` プログラムでインストールすることができます:41 Some 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: 42 42 {{{ 43 43 easy_install TracWebAdmin-0.1.1dev_r2765-py2.3.egg 44 44 }}} 45 45 46 もし、システムに `easy_install` がなくてプラグインをインストールするには上記の必要条件のセクションを見て下さい。 Windows ユーザは `Scripts` ディレクトリを Python をインストールしたディレクトリ (例えば、 `C:\Python23\Scripts`) を環境変数 `PATH` に加えなければなりません。 (より詳しい情報は、 [http://peak.telecommunity.com/DevCenter/EasyInstall#windows-notes easy_install の Windows Notes] を参照して下さい。) 46 If `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). 47 47 48 zipで固められた Python egg をインストールし、 Web サーバに Python egg のキャッシュディレクトリに書き込み権限をつけているのにも関わらず、 Trac がパーミッションエラーを出したら、 解凍した Python egg を単に置き直すことによって回避できます。 `easy_install` に `--always-unzip` オプションを付けるだけです:48 If 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`: 49 49 {{{ 50 50 easy_install --always-unzip TracWebAdmin-0.1.1dev_r2765-py2.3.egg 51 51 }}} 52 zip で固められた Python egg ファイルと同じ名前のディレクトリ (拡張子が `.egg` で終わっているもの) ができ、そのなかに解凍した中身が入っているでしょう。 52 You should end up with a directory having the same name as the zipped egg (complete with `.egg` extension) and containing its uncompressed contents. 53 53 54 Trac はまた `$prefix/share/trac/plugins` 配下に、グローバルにインストールされたプラグインを検索します ''(0.10 以降)''。54 Trac also searches for globally installed plugins under `$prefix/share/trac/plugins` ''(since 0.10)''. 55 55 56 ==== ソースから====56 ==== From source ==== 57 57 58 Subversion からダウンロードしたプラグインのソースや zip で固められたソースファイルはソース中に含まれている `setup.py` を使用してインストールできます:58 If you downloaded the plugin's source from Subversion, or a source zip file you can install it using the included `setup.py`: 59 59 {{{ 60 60 $ python setup.py install 61 61 }}} 62 62 63 ==== プラグインを有効にする====64 個別の TracEnvironment にプラグインをインストールする場合と異なり、システム全体にインストールしたプラグインを有効にするためには、 [wiki:TracIni trac.ini] ファイルで明示的に指定しなければいけません。これは設定ファイルの `[components]` セクションに次のような記載を行います:63 ==== Enabling the plugin ==== 64 Unlike plugins installed per-environment, you'll have to explicitly enable globally installed plugins via [wiki:TracIni trac.ini]. This is done in the `[components]` section of the configuration file, for example: 65 65 {{{ 66 66 [components] … … 68 68 }}} 69 69 70 オプションの名前はプラグインの Python パッケージ名です。これはプラグインのドキュメンテーションに指定されていなければいけませんが、ソースを見れば簡単に見つけることが出来ます。(最上位のディレクトリにあるファイル `__init__.py` を探してください。)70 The name of the option is the Python package of the plugin. This should be specified in the documentation of the Plugin, but can also be easily find out by looking at the source (look for a top-level directory that contains a file named `__init__.py`.) 71 71 72 Note: プラグインのインストール後、 Apache を再起動する必要があるでしょう。72 Note: After installing the plugin, you may need to restart Apache. 73 73 74 == プラグインのキャッシュの設定==74 == Setting up the Plugin Cache == 75 75 76 いくつかのプラグインは Python eggs のランタイム (`pkg_resources`) によって解凍される必要があります。というのもそれらの内容がファイルシステム上に実際に存在する必要があるからです。通常、 Python eggs は現在のユーザのホームディレクトリに解凍されますが、それにより問題が発生するかもしれません。その場合、環境変数 `PYTHON_EGG_CACHE` を設定してデフォルトのロケーションを上書きすることができます。 76 Some plugins will need to be extracted by the Python eggs runtime (`pkg_resources`), so that their contents are actual files on the file system. The directory in which they are extracted defaults to 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. 77 77 78 `PYTHON_EGG_CACHE` を `SetEnv` ディレクティブを使用して Apache に設定するには以下のようにします:78 To do this from the Apache configuration, use the `SetEnv` directive as follows: 79 79 {{{ 80 80 SetEnv PYTHON_EGG_CACHE /path/to/dir 81 81 }}} 82 82 83 これは [wiki:TracCgi CGI] と [wiki:TracModPython mod_python] のどちらをフロントエンドにしようと動作します。このディレクティブに [wiki:TracEnvironment Trac Environment] へのパスに設定し、例えば同じ `<Location>` ブロックにおいてください。 83 This works whether you are using the [wiki:TracCgi CGI] or the [wiki:TracModPython mod_python] front-end. Put this directive next to where you set the path to the [wiki:TracEnvironment Trac environment], i.e. in the same `<Location>` block. 84 84 85 例 (CGI用):85 For example (for CGI): 86 86 {{{ 87 87 <Location /trac> … … 91 91 }}} 92 92 93 例 (mod_python用):93 or (for mod_python): 94 94 {{{ 95 95 <Location /trac> … … 100 100 }}} 101 101 102 ''Note: これは `mod_env` モジュールが必要です。''102 ''Note: this requires the `mod_env` module'' 103 103 104 [wiki:TracFastCgi FastCGI] で、 Web サーバに設定するためには、 `-initial-env` オプションやサーバーが指定している方法で、環境変数を設定する必要があります。 104 For [wiki:TracFastCgi FastCGI], you'll need to `-initial-env` option, or whatever is provided by your web server for setting environment variables. 105 105 106 === Subversion の フックスクリプトについて===106 === About hook scripts === 107 107 108 もし、 Trac エンジンを呼び出すような Subversion の フックスクリプト - Trac の配布物の `/contrib` ディレクトリで提供されている post-commit フックスクリプトなど - を設定していたら、プラグインと同様にスクリプトの中で環境変数 `PYTHON_EGG_CACHE` を定義して下さい。 108 If you have set up some subversion hook scripts that call the Trac engine - 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 as well. 109 109 110 == トラブルシューティング==110 == Troubleshooting == 111 111 112 === setuptools は正しくインストールされていますか？===112 === Is setuptools properly installed? === 113 113 114 これコマンドラインで実行してみてください:114 Try this from the command line: 115 115 {{{ 116 116 $ python -c "import pkg_resources" 117 117 }}} 118 118 119 もし、コマンドラインから '''何も''' かえって来なければ、 setuptools はインストール '''されています'''。そうでなければ、 Trac を動かす前に setuptools をインストールする必要があります。 119 If you get '''no output''', setuptools '''is''' installed. Otherwise, you'll need to install it before plugins will work in Trac. 120 120 121 === Python egg は正しいバージョンですか？===121 === Did you get the correct version of the Python egg? === 122 122 123 Python egg はファイル名の中で Python のバージョンをエンコードします。例えば、 `MyPlugin-1.0-py2.4.egg` は Python 2.4 用の Python egg であり、異なる Python のバージョン (2.3 や 2.5) で動かそうとしても '''動かない''' でしょう。123 Python eggs have the Python version encoded in their filename. For example, `MyPlugin-1.0-py2.4.egg` is an egg for Python 2.4, and will '''not''' be loaded if you're running a different Python version (such as 2.3 or 2.5). 124 124 125 また、ダウンロードした Python egg ファイル が本当に ZIP アーカイブであるかどうかを確認して下さい。もし Trac サイトからダウンロードしたとしたら、 HTML プレビューページを代わりにダウンロードしているかもしれません。 125 Also, verify that the egg file you downloaded is indeed a ZIP archive. If you downloaded it from a Trac site, chances are you downloaded the HTML preview page instead. 126 126 127 === プラグインは有効になっていますか？===127 === Is the plugin enabled? === 128 128 129 グローバル領域にプラグインをインストールした場合 (TracEnvironment の `plugin` ディレクトリ内 ''ではなく'') 、 [TracIni trac.ini] に明確に有効にする設定をしなければなりません。以下の事項を確認して下さい:130 * `[components]` セクションに必要な行数を追加したか。131 * パッケージ / モジュール名は正しいか132 * もし、(クラスに対して) モジュールを参照しているならば、必要に応じて、 ".*" を追加しているかどうか。133 * 正しい値、 "enabled" になっているかどうか。例えば、 "enable" ではなく。129 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 [TracIni trac.ini]. Make sure that: 130 * you actually added the necessary line(s) to the `[components]` section 131 * the package/module names are correct 132 * if you're reference a module (as opposed to a class), you've appended the necessary “.*” 133 * the value is “enabled", not e.g. “enable” 134 134 135 === Python egg ファイルのパーミッションのチェック===135 === Check the permissions on the egg file === 136 136 137 Trac はもちろん Python egg ファイルを読めなければいけません。分かってるよね。;-)137 Trac must of course be able to read the file. Yeah, you knew that ;-) 138 138 139 === ログファイルのチェック===139 === Check the log files === 140 140 141 Trac で [TracLogging logging] を有効にし、ログレベルを `DEBUG` に設定し、プラグインがロードされるときのログメッセージを見て下さい。 141 Enable [TracLogging logging] in Trac, set the log level to `DEBUG` and then watch the log file for messages about loading plugins. 142 142 143 143 ---- 144 See also TracGuide, [http://trac.edgewall.org/wiki/PluginList プラグイン一覧], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture コンポーネント設計]144 See also TracGuide, [http://trac.edgewall.org/wiki/PluginList plugin list], [http://trac.edgewall.org/wiki/TracDev/ComponentArchitecture component architecture]
