Tcl/Tkコマンド・ライブラリ関数リファレンス翻訳時の注意事項

Tcl/Tkのコマンドやライブラリ関数のリファレンス文書は、manコマンドから利用できるオンラインドキュメント ─ いわゆるman page ─ の形式になって提供されています。 Tcl/Tk日本語チームはこの文書の形式に従って英文を日本語に翻訳作業を行いますが、当文書は翻訳作業をするときに注意しなければならない事項について説明します。

文字コードについて

日本語を含んだ文書を作成するとき、まず最初に問題になるのが文字コードです。

Tcl/Tk日本語チームの文書は必ずEUC-JPで作成してください。
また、改行コードも「LF(0x0a)のみ」にしてください。

WindowsやMacintoshでは、通常、いわゆる「シフトJIS」という文字コードを使って日本語テキストを入力したり表示したりします。このため、Windows標準の「メモ帳」やMac標準の「SimpleText」を使って日本語文書を作成すると「シフトJIS」という文字コードでファイルに出力されてしまうので、別途EUC-JPに変換する作業が必要になります。また、改行コードもWindowsは「CR(0x0d)+LF(0x0a)」、Macは「CR(0x0d)」となってしまうため、これらもLFに変換する作業が必要になります。 WindowsやMacで日本語文書を作成するときは、秀丸エディタやJeditなど、EUC-JPかつLFで日本語文書を作成できるテキストエディタを使うようにするのが望ましいでしょう。

man page形式について

SourceForge.jpのCVSからTcl/Tkのコマンドやライブラリ関数のリファレンス文書をコピーすると、ちょっと変わった形式のテキストになっていることに気付くかと思います。これらの文書は、manコマンドから利用できるオンラインドキュメント(いわゆるman page)の形式になっているのです。 Tcl/Tk日本語チームでは、このman page形式の状態を維持して翻訳作業を行います。つまり、「.SH」や「\fB」「\fR」などman pageをフォーマットするために必要なキーワードはそのまま残すように注意してください。また、「"Tcl Built-In Commands"」みたいな言葉やコマンド名などは日本語に訳さないで英文のままにしておいてください。よく解らないときは、他の人が訳した文書を参考にしてみるとよいでしょう。なお、man page形式の詳細についてはこちらも参照してください。

見出しについて

各々のリファレンス文書には「NAME」や「SYNOPSIS」などの見出しが入っています。これらの見出しについては出来るだけ統一するようにしましょう。頻繁に出てくる見出しについては、次のように置換してください。

NAME	名称
SYNOPSIS	形式
INTRODUCTION	はじめに
ARGUMENTS	引数
DESCR IPTION	説明
SEE ALSO	関連項目
KEYWORDS	キーワード
EXAMPLES	参考例
PORTABILITY ISSUES	移植上の問題点
CREDITS	謝辞

参考文献について

日本語で解説されたTcl/Tk本が多数出版されていますが、翻訳作業を進める上でこれらの文献を参照することもあると思います。参考文献を使って翻訳した場合、その文献名を付記すべきではないかと思います。なお、文章の引用は著作権に関わりますから、その点を十分考慮して翻訳作業を進めてください。これは自動翻訳ソフトを使って翻訳したときも同様です。

訳者について

手間隙をかけて翻訳作業を行ったわけですから、訳者の功績は評価されてしかるべきではないかと(私は)考えています。ですから、末尾に訳者の名前を追加していただいて構いません。もっとも、メールアドレスまで書いてしまうと、問い合わせ先になったりSPAMの対象になったりしそうですけど...

オープンソース・ソフトウェアの開発とダウンロード

Tcl/Tk日本語チーム