バージョン 2 から バージョン 3 における更新: TracJa

更新日時:

2006/10/21 20:29:02 (18 年 前)

更新者:

trac (IP アドレス: 127.0.0.1)

コメント:

--

TracJa

@@ +1 @@
+[[PageOutline]]
 = TracJa について =
 '''このファイルはオリジナル Trac の配布物には含まれません。'''
@@ -4 +5 @@
 Trac-Ja は Trac の日本語ローカライズバージョンです。
 
-
+----
 == Trac の I18N 対応状況 ==
-Trac は Python で記述されているため、内部コードは Unicode です。
-また、 Wiki ページやレポート、チケットなどはデータベースに格納する時点で
-UTF-8 に変換されるため、これらは基本的にオリジナル配布のままでも日本語が使用できます。
-
-添付ファイルやリポジトリブラウザの表示が文字化けする場合、適切な文字コードを
-TracIni ファイルのパラメータ `[trac]` `default_charset` に設定してください:
-{{{
-[trac]
-default_charset = Shift_JIS
-}}}
-大抵の場合、この設定だけで文字化けは解消します。
-
-Subversion リポジトリに格納しているファイルのエンコードが、ファイルごとに違う場合、
-Subversion 側で各ファイルの `svn:mime-types` 属性に `charset` を
-正しく設定することで解消します (trac-0.8.2 以降):
-{{{
-PROMPT$ svn propset 'svn:mime-type' 'text/x-csrc; charset=Shift_JIS' *.c
-}}}
-
-添付ファイルの文字コードは TracIni の `default_charset` に固定されます。
-
-
+Trac はオリジナル配布のままでも、日本語を使用することができます。
+
+Trac の内部では ([http://trac.edgewall.org/milestone/0.10 0.10] 以降) Python の
+'Unicode binary' 形式で文字列を処理し、 Web の表示は `UTF-8`で行われるため、
+(対応するフォントがあれば) どのような言語であっても取り扱うことができます。
+(See: TracUnicode)
+
+
+=== [wiki:TracEnvironment Environment] ===
+[http://trac.edgewall.org/wiki/DatabaseBackend バックエンドのデータベース] には
+`UTF-8` でデータ (Wiki ページ, チケット) が保存されます。
+
+添付ファイルはデータベースに格納されません。 Environment の `attachments`
+ディレクトリ配下に、 URL エンコードされたファイル名で保存されます。
+[[BR]]→ ブラウザが URL エンコードに `UTF-8` を使用していない場合、ファイル名が
+文字化けするかもしれません。
+
+[wiki:TracIni trac.ini ファイル] 他、Environment に配置するファイル
+(サイトヘッダや [wiki:WikiMacros Wiki マクロ] など) は、 `UTF-8`
+で作成してください。 (`BOM (Byte Order Mark)` は付けない方が安全です)
+
+
+=== [wiki:TracBrowser リポジトリブラウザ] ===
+今のところ Trac が正式に対応している
+[http://trac.edgewall.org/wiki/VersioningSystemBackend バックエンドのバージョン管理システム]
+は、 Subversion だけです。 ([http://trac-hacks.org Trac Hacks] などには、
+他のバージョン管理システムを使うためのプラグインがありますが、
+動作状況等未確認です。)
+
+バージョン管理下のファイルは、 MIME Viewer という機能で HTML 変換し、
+リポジトリブラウザに表示されます:
+ 1. `svn:mime-type` 属性もしくはファイルのサフィックスが、画像のように表示可能な
+    バイナリファイル形式の場合は、 `<img>` 要素として表示されます。
+ 2. 表示できないバイナリファイル (`application/octet-stream` 等) の場合は、
+    ダウンロードへのリンクが表示されます。
+ 3. バイナリファイルと判別されない場合、全てテキストファイルとして Web
+    ページに表示されます。
+   1. ファイルに設定された `svn:mime-type` 属性が `text/html; charset=utf-8`
+      のように `charset=` を含む場合は、その文字コードでファイルを読み込みます。
+   2. ファイルに `BOM (Byte Order Mark)` が付いていれば、適切な `UTF`
+      でファイルを読み込みます。
+   3. ファイル個別に判定できない場合は、 [wiki:TracIni trac.ini ファイル] の
+      `[trac]` セクション `default_charset` オプションに指定された文字コードで
+      ファイルを読み込みます。
+      このコンフィグの初期値は `iso-8859-15` なので、日本語で Trac
+      を使用する場合は、まず最初に変更する設定になると思います。
+
+Python 2.3 配布には、日本語だけで使用されている文字コード(`shift_jis`, `euc-jp`
+など) の codec が含まれていません。これらの文字コードを使用したい場合は、別途
+[http://www.python.jp/Zope/download/JapaneseCodecs JapaneseCodecs]
+をインストールする必要があります。
+Python 2.4 配布では、 !JapaneseCodecs が同梱されています。
+
+
+=== 添付ファイル ===
+添付ファイル表示もバージョン管理下のファイルと同じく、 MIME Viewer が行います。
+
+ただし添付ファイルでは、 (`svn:mime-type` 属性のような) ファイル毎の文字コード
+指定はできないので、 `BOM` による `UTF` の判別ができなければ、 `default_charset`
+に指定した codec に固定されます。
+
+
+=== [wiki:TracAdmin コンソール] ===
+[wiki:TracAdmin trac-admin コマンド] の入出力では、使用するコンソールの
+文字コードが自動判別されます。
+([http://trac.edgewall.org/milestone/0.10 0.10] 以降)
+
+
+=== [wiki:TracNotification メール通知] ===
+Trac が送信するメールは `UTF-8` が `Base64` か `quoted-printable` で 7bit-safe
+な形式にエンコードされています。MUA がこれらのエンコードに対応していない場合、
+文字化けする可能性があります。 (See: TracNotification)
+
+
+----
 == Trac の L10N 対応状況 ==
 オリジナル配布ではユーザ入力以外の表示メッセージは全て英語です。
-
-プレゼンテーション層の処理は、 `templates` ディレクトリ配下の !ClearSilver テンプレートに
-集約されているのですが、実際に表示される用語などが `trac` ディレクトリ配下の Python コード内に
-ハードコードされているため、 Trac が gettext() などの多言語 API に対応しない限り、
+これを日本語化した手順を記述します。
+
+
+=== Web 画面のコンテンツ ===
+[wiki:TracJa#TracのI18N対応状況 前項] の通りです。
+日本語化作業で変更した点はありません。
+チケット属性について付記します。
+
+
+==== チケット属性名 ====
+チケット属性の名前は、ほとんどの画面で日本語の属性名が表示されますが、
+レポートの検索結果画面は例外です。
+レポートの検索結果画面でのチケット属性の列名は、検索に使用した SQL
+の列名がそのまま表示されます。
+ですが SQL の SELECT 句で `AS` を挿入すれば、列名を日本語化することが出来ます。
+ただし `modified` や `description` など、特定の表示フォーマットに使用する列名
+(See TracReports) は変更するとフォーマットされません。
+
+
+==== チケット属性の値 ====
+チケット属性の値は、データベースにそのまま保存されます。
+データベースには `UTF-8` であれば保存できるので、リストボックス形式の属性は
+[wiki:TracAdmin trac-admin コマンド] で日本語に変更可能です。
+たとえば分類のデフォルトは `defect`, `task`, `enhancement` ですが `不具合`,
+`タスク`, `機能追加` のように日本語に変更することができます。
+とは言え、プロジェクト毎に必要となる用語は異なるでしょうから、 Trac-Ja
+では翻訳対象としていません。
+
+例外は「ステータス (`Status`)」の値です。
+チケットの状態遷移が Python ソースにハードコードされているため、
+変更すると多くの箇所にパッチしなければなりませんし、
+今後の Trac リリースに対応できなくなるおそれがあります。
+
+  [http://trac.edgewall.org/milestone/0.11 0.11] か
+  [http://trac.edgewall.org/milestone/0.12 0.12] で、導入される予定の
+  [http://trac.edgewall.org/wiki/WorkFlow Flexible/Extensible Ticket Workflow]
+  では、日本語化できるようになる可能性があります。
+
+
+=== Web 画面のテンプレート ===
+プレゼンテーション層の処理は、 `templates` ディレクトリ配下の !ClearSilver
+テンプレートに集約されているのですが、実際に表示される用語などが `trac`
+ディレクトリ配下の Python コード内にハードコードされているため、現時点では、
 ソースに直接パッチを行わないと翻訳できません。
 
-Wiki ページとして同梱されているオンラインマニュアルは、 `wiki-default` ディレクトリにある
-ファイルを翻訳すれば地域化することが出来ます。
-(マニュアルについてはロケールを指すディレクトリを作成して、その下にマニュアルを
-置くという [http://projects.edgewall.com/trac/wiki/TracGuideTranslations 案] も出ていましたが、
-差分翻訳が難しいなど実用上に問題があるため放置されています。)
-
-レポートやカスタムクエリの検索結果画面での、チケット属性の列名は
-検索に使用した SQL の列名がそのまま表示されます。
-そのため SQL の SELECT 句で `AS` によって列名を日本語化することが出来ます。
-ただし、 `modified` や `description` など特定の用途に使用される列名
-(See TracReports) は変更すると表示形式が変わってしまいます。
-
-レポートの検索結果画面やチケット閲覧画面での、チケット属性の値については、
-データベースの値をそのまま使用しているため、一部の属性は翻訳することが困難です。
- * ステータス (Status): チケットの状態遷移がハードコードされている
-その他の属性は、 `trac-admin` コマンドで変更することで日本語化できますが、
-プロジェクト毎に必要となる用語は異なるでしょうから、 Trac-Ja では翻訳対象と
-していません。
-
-
-== Trac-Ja の概要 ==
-Trac 配布物を日本語に翻訳しました。Trac の用語は TracTermsJa に示した通りとなっています。
-
-配布は [http://www.i-act.co.jp/project/products/products.html InterAct Web サイト公開資料ページ] で
-行っています。
-
-
+また [http://trac.edgewall.org/milestone/0.10 0.10] 以降、 Trac
+が内部処理に使用する文字コードが `UTF-8` から `Unicode binary` に変更されました。
+この変更によって、文字列の折り返しや切り落としが、
+多バイト文字のバイト境界で行われないようになりましたが、
+Python コード内で非 `ASCII` を使用する場合、 `u'日本語文字列'` のように
+`Unicode binary` 文字列を使わないと動かない箇所があります。
+この制限は [wiki:WikiMacros Wiki マクロ] や [wiki:TracPlugins プラグイン]
+でも適用されますので、マクロやプラグインを作成したり、
+翻訳したりする場合には留意してください。
+
+  [http://trac.edgewall.org/milestone/0.11 0.11] では、テンプレートエンジンが
+  !ClearSilver から [http://genshi.edgewall.org/ Genshi] に乗せ換えられ、
+  表示メッセージは完全に Python コード内に移動します。その上で、
+  各言語でのメッセージが `gettext` 方式で切り替えられる構造に変更される予定です。
+  ですので、今後の地域化は今までと全く違う形になりそうです。
+
+
+=== Wiki ページ ===
+Wiki ページとして同梱されているオンラインマニュアルは、 `wiki-default`
+ディレクトリにあるファイルを翻訳すれば地域化することが出来ます。
+
+  [http://trac.edgewall.org/milestone/0.11 0.11] での多言語化対応も、
+  今のところ Wiki のマニュアルまでは及んでいません。
+  Wiki の地域化は、まだまだ白紙というのが現状です。
+
+Trac-Ja から Wiki ページだけを使いたい場合:
+ 1. `trac-0.xx.x-ja-x.zip` を展開し
+ 2. `wiki-default/check_wiki.py` を削除した上で
+ 3. [wiki:TracAdmin trac-admin コマンド] で、 `wiki import` してください。
+
+
+----
 == Trac のバグ ==
-オリジナル配布に存在するバグについて記載しておきます。
+trac-0.10 のオリジナル配布に存在するバグについて記載しておきます。
+
+
+=== Trac-Ja で修正しているバグ ===
+日本語環境で Trac を使用するために必要な、最小限のパッチを行っています。
 
  * `LC_TIME` にマルチバイト文字が含まれるロケールを使用すると、
-   タイムラインやマイルストーンでの日付入力がエラーになる。[[BR]]
-   ([http://projects.edgewall.com/trac/ticket/2182 本家チケット 2182] に
-   パッチがあります。
-   [http://projects.edgewall.com/trac/milestone/0.10 本家マイルストーン0.10]で
-   対応される予定です)
- * utf-8 以外の charset を使用するコンソール (Windowsを含む) では、
-   `trac-admin` コマンドでの非 ASCII 文字の表示が文字化けする。[[BR]]
-   ([http://projects.edgewall.com/trac/ticket/2394 本家チケット 2394] に
-   暫定パッチがあります。このパッチでは文字列長を考慮していないため、
-   表示上のカラム位置にばらつきが発生しますが、とりあえず読めるようには
-   なります。)
- * コンポーネント名などに半角空白文字を 2 つ以上続けて書くと動作がおかしくなる。
- * `priority` を全て削除すると、ロードマップでの iCalendar 出力に
-   スタックトレースが含まれ、不正フォーマットになる。
- * チケットの概要で 1 文字目の空白文字が削除される。
-   [http://projects.edgewall.com/trac/ticket/2285 本家チケット 2285 参照][[BR]]
-   (trac-0.9.1 で対応されましたが、trac-0.9 で作成したチケットでは、
-   データベース登録時に1文字目の空白文字を削除しているので、この現象は解消されません。）
- * マルチバイト文字列の折り返しや切り取りで境界文字が文字化けすることがある。[[BR]]
-   ([http://projects.edgewall.com/trac/milestone/0.11 本家マイルストーン0.11] で
-   対応される予定です)
- * 0.9 で作ったプロジェクト環境では、優先度 (priority) のデフォルト値が
-   0.8.x 以前と異なる。[[BR]]
-   ([http://projects.edgewall.com/trac/ticket/1861 本家チケット 1861] によると、
-   今後はこれがデフォルトになるようです)
- * レポートによっては、例外が発生することがあります。詳細は、 [http://projects.edgewall.com/trac/ticket/2773 本家チケット 2773] , [http://projects.edgewall.com/trac/wiki/TracUpgrade TracUpgrade] 参照を参照してください。
- * 引数を受け取る WikiMacros では、各マクロで引数のサニタイズを行わないと
-   脆弱性の元になります。 Trac および Trac-Ja の配布に含まれるマクロでは
-   サニタイズが行われていますが、 Trac Hacks などからマクロやプロセッサを
-   導入する際には、引数がサニタイズされているか確認してから使用するように
-   してください。
-
-これらのバグは、今後のオリジナルのリリースや、 Trac-Ja のリリースで解消されるかもしれませんが、
-現状では修正されていません。
+   タイムラインやマイルストーンでの日付入力がエラーになる。
+   (See: [http://trac.edgewall.org/ticket/2182 #2182])[[BR]]
+   [http://trac.edgewall.org/milestone/0.11 trac-0.11]
+   ではタイムゾーンのハンドリングを含めた対応が予定されていますが、
+   どのような形になるかは未定です。
+   (See: [http://trac.edgewall.org/browser/sandbox/datetime datetime 開発ブランチ],
+   [http://trac.edgewall.org/browser/sandbox/datetime-genshi datetime-genshi 開発ブランチ])
+   [[BR]]日付が入力できないと実用上の問題が大きいので、デフォルトの日付書式を
+   `%x %X` から `%Y/%m/%d %H:%M:%S` に変更しています。
+ * [wiki:WikiMacros Wiki マクロ] のヘルプが `ascii`, `Unicodebinary`
+   以外のエンコードの場合に `[[MacroList]]` で表示されない。[[BR]]
+   マクロヘルプは基本的に class コメントから取得します。この class コメントを
+   `Unicode binary` にすることで work arround になるのですが、
+   [wiki:WikiMacros Wiki マクロ] は 3rd-party からも提供されているので、
+   全てに適用するのは面倒です。マクロヘルプを表示する際に `utf-8` か
+   `preferred encoding` から `Unicode bianry` に変換するように変更しています。
+
+
+=== 修正していないバグ ===
+これらのバグは、今後のオリジナルのリリースや、 Trac-Ja
+のリリースで解消されるかもしれませんが、現状では修正されていません。
+
+ * `priority` を全て削除すると、ロードマップでの iCalendar
+   出力にスタックトレースが含まれ、不正フォーマットになる。
+ * 変数を使用するレポートで、例外が発生することがある。
+   (See: [http://trac.edgewall.org/ticket/2773 #2773],
+   [http://trac.edgewall.org/wiki/TracUpgrade TracUpgrade])[[BR]]
+   [http://trac.edgewall.org/changeset/2941 "[2941]"] で一旦解消されましたが、 
+   [http://trac.edgewall.org/changeset/3300 "[3300]"] で上書かれています。
+   [http://trac.edgewall.org/milestone/0.10.1 trac-0.10.1]
+   以降では解消されるかもしれません。
+ * 複数のバージョンを持つ Wiki ページで ''このバージョンを削除''
+   ボタンをクリックすると、削除の警告メッセージに
+   「このページには1つのバージョンしかありませんのでページを完全に削除します!」
+   と出力されるが実際に削除されるのは、 ''このバージョン'' のみである。
+   (See: [http://trac.edgewall.org/ticket/3928 #3928])
+ * チケットのメール通知を有効にしている場合で、 [wiki:TracIni trac.ini ファイル]
+   の `[notification]` セクション `always_notify_updater` オプションを `false`
+   に設定している場合は、チケット登録時の通知メールが送信されない。
+   (See: [http://trac.edgewall.org/ticket/3654 #3654])[[BR]]
+   ([http://trac.edgewall.org/changeset/3808 "[3808]"] で
+   [http://trac.edgewall.org/browser/branches/0.10-stable trac-0.10 保守ブランチ]
+   に取り込まれたので、 [http://trac.edgewall.org/milestone/0.10.1 trac-0.10.1]
+   で解消する見込みです。)
+
+
+----
+== セキュリティ上の注意点 ==
+Trac を使用する上でのセキュリティ上の注意点です。
+
+
+=== [wiki:WikiMacros Wiki マクロ] の導入 ===
+[wiki:WikiMacros Wiki マクロ] では、受け取った引数を表示に含める場合、
+`trac.util.escape()` を使用してサニタイズを行わないと脆弱性の原因になります。
+
+サニタイズの実施は各マクロで行う必要があります。
+Trac および Trac-Ja の配布に含まれるマクロではサニタイズが行われていますが、
+マクロを自作する場合や、
+[http://trac-hacks.org/ Trac Hacks] 等からマクロを導入する際には、
+各自で確認してから使用するようにしてください。
+
+
+=== コメント Spam 対策 ===
+最近 Trac を標的にしたコメント Spam が発生しています。
+
+Public に公開する Trac では [wiki:TracPermissions パーミッション]
+を適切に設定したり、 [http://trac.edgewall.org/wiki/SpamFilter 本家 Wiki]
+を参考に [http://trac.edgewall.org/browser/sandbox/spam-filter SpamFilter]
+を導入するなど、対策を怠らないようにしてください。