Project Looking Glass 翻訳 - ファイルスタイルガイド

このドキュメントは、 Project Looking Glass 日本語翻訳プロジェクトで作成するファイルの作成ガイドです。

ファイルの配置場所

翻訳ファイルは lg3d-core/www/ja ディレクトリの下に置くようにしてください。

基本的には、lg3d-core/www の木構造をここに複製します (イメージファイルなども,翻訳対象にできる) が、ライセンスファイルなどの一部の例外に関しては原文を直接参照してください。

ファイル名

原文と同じ にするようにしてください。

ファイルフォーマット

XHTML 1.0 で行ってください。決して HTML で記述しないでください。

XHTML 1.0 の DOCTYPE は次のようになります。

<!DOCTYPE html PUBLIC "-//Tigris//DTD XHTML 1.0 Transitional//EN"
"http://style.tigris.org/tigris_transitional.dtd">

この宣言をファイルの先頭につけるようにしてください。

基本的には原文も XHTML で記述されているので、それをそのまま使用することができます。

文字コード

UTF-8 で記述してください。java.net で使用している CollabNet では UTF-8 以外の文字コードだと文字化けを起こしてしまいます。

ローカルファイルシステム上で閲覧するときのために、つぎのようにファイルの charset を META 要素で定義します。

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

META 要素は <head> ... </head> の中に記述してください。

改行コード

LF (0x0A) で記述してください。Windows や Macintosh で記述する場合も LF で記述するようにしてください。

HTML エディタ

予期せぬフォーマットの書き換えや冗長な要素指定を防ぐために、HTML エディタはなるべく使用しないでください

テキストエディタを使用して記述するのが最適です。

ただし、フォーマットの書き換えなどの問題が解決されていることを確認できれば、再び HTML エディタを採用すること検討をする予定です。また、Eclipse などの統合環境へプラグインとして専用ツールを開発することも、今後の課題となっています。

スタイルシート

ローカルファイルシステム上で閲覧するときに、スタイル指定を CollabNet上で閲覧した時と一致させるために、次のようにスタイルシートを指定します。

<style type="text/css"> /* <![CDATA[ */
@import "preview.css";
/* ]]> */</style>

注: この指定は www/ja にファイルが存在する場合のものです。他のディレクトリの場合は後述するように相対 URI で記述してください。

この指定は <head> ... </head> の中で記述するようにしてください。preview.css は lg3d-core CVS の www/ja ディレクトリにありますので、ダウンロードしてお使いください。

ハイパーリンク

ドキュメント中のハイパーリンクは書き換えの手間を減らすために、https://lg3d-core.dev.java.net/ 以下の URI は相対 URI で記述してください。

注: この変更は、原文にも反映します。

ただし、ドキュメントが未翻訳状態の時には、リンクをクリックしてもエラーになる問題に対処するために、たとえば翻訳終了まで以下のように原文にリダイレクトするダミーページを使用することなども検討します。

<meta http-equiv="Refresh" content="1; URL=https://lg3d-core.dev.java.net/foo.html" />

翻訳者名

翻訳者の名前はアルファベットで META 要素で指定してください。

<meta name="Translator" content="Yuichi SAKURABA" />

この指定は <head> ... </head> の中で行ってください。

翻訳内容

翻訳ファイルの内容は翻訳文のみにしてください。

つまり、同一ファイル中に原文・翻訳文を併記しないようにします。

校正用の併記形式は、将来別の方法で実現することを検討する予定です。

CVS のリビジョン

翻訳文を最初に CVS に登録する時に、原文の CVS のリビジョン番号はリセットして、別途下記の形式で併記するようにしてください。

$Revision: 1.3 $ $Date: 2004/10/21 08:02:47 $ (英語版Revision: x.y)

これは読者に最新版であるかどうかを確認する手段を与えると共に、他の翻訳者が CollabNet の差分表示を利用して、ドキュメントの更新を簡単にできるようにするためです。

注: 翻訳文更新時には、その元にしたリビジョン番号を忘れずに手で更新するようにしてください。

CVS へのコミット

CVS へコミットする時のメッセージは英語で記述するようにしてください。

バリデーション

XHTML で記述しているので、CVS コミット前に正当性を検証することを推奨します。たとえば、W3C Markup Validation Service などが利用できます。


$Revision: 1.3 $ $Date: 2004/10/21 08:02:47 $