guide/translation_guideline.rst

   1 ==========
   2 翻訳の指針
   3 ==========
   4
   5 この文章は JM Project における man page 翻訳作業に関する指針です。 翻訳者のみなさんには余計な手間になるとは思いますが、 より良い日本語マニュアルを作成するためにご協力ください。
   6
   7 マニュアル本文のフォーマットについて
   8 ====================================
   9
  10 本来のフォーマットや著作権を尊重するために、一次配布フォーマットは roff 形式を採用します。
  11 また roff での作業が困難である場合には、 その旨を JM-ML まで連絡してください。他に roff 化のボランティアを募集します。
  12
  13 全体としての文体の統一のため、 特に理由がなければ常体 (「である」調) を用いてください。 マニュアルページの語尾としては、
  14
  15 .. code-block:: none
  16
  17    「〜だ。」
  18    「〜である。」
  19    「〜する。」
  20    「〜できる。」
  21    「〜となる。」
  22
  23 などを使用してください。
  24
  25 句読点は「、」および「。」を使用してください。ただし、英単語や英文の 部分の区切りには「,」「.」を用いてもかまいません。
  26
  27 原文のコメント化
  28 ================
  29
  30 校正作業や改版作業の便宜を図るため、できれば原文をコメントで残しておいてください。
  31 ただし「原文に元からあったコメント」と区別するため、「.\"O」という形式のコメントとしてください (O はアルファベット o の大文字)。
  32 登録システムは、リリース版を作成するときに このコメントを自動的に除去します。
  33
  34 コメント化には以下のような内容の awk スクリプト を用いると良いでしょう。
  35
  36 .. code-block:: none
  37
  38    #!/usr/bin/awk -f
  39    {
  40            if ($0 ~ /^\.\\"/) {
  41                    print
  42            } else {
  43                    printf(".\\\"O %s\n", $0)
  44            }
  45    }
  46
  47 これをオリジナルの roff ファイルに対して
  48
  49 .. code-block:: none
  50
  51    awk -f commentate.awk ar.1 > ar.1.draft
  52
  53 のように用い、 ``ar.1.draft`` に対して作業をします。
  54
  55 以上の作業では原文はすべてコメントアウトされてしまいますが、 .TH 行や .TP 行のように、
  56 そのまま翻訳版にも残しておきたい行もあると思います。
  57 このような行を元に戻す作業には vi を用いるのが楽でしょう。 vim 系なら作業ディレクトリに
  58
  59 .. code-block:: none
  60
  61    map ^T 5xj
  62
  63 というような内容の .vimrc ファイルを置いておきます (^T は Ctrl-T です)。
  64 コメント化した roff ファイルを vi で開き、アンコメントしたい行の先頭で Ctrl-T を打てば、次々に取っていけます。
  65 失敗した場合は u で undo。
  66
  67 著作権表示について
  68 ==================
  69
  70 roff 形式において roff のコメントとして書かれている著作権表示は、英文のまま残してください。
  71 さらにその後にコメントとして、英文で翻訳者の著作権表示を加えてください。
  72 翻訳者の権利表示の例を以下に示します。
  73
  74 .. code-block:: none
  75
  76    .\"
  77    .\" Japanese Version Copyright (c) 1996 HANATAKA Shinya
  78    .\"         all rights reserved.
  79    .\" Translated Wed Nov 20 17:42:39 JST 1996
  80    .\"         by HANATAKA Shinya
  81
  82 本文 (man コマンドの整形結果で見える部分) に著作権表示がある場合には、 それも原文のまま残してください。
  83
  84 原文に著作権表示が含まれていない場合には、 個別対応になると思いますので JM-ML で相談してください。
  85
  86 GNU のマニュアルページにはマニュアルページ中に著作権表示のないもの がありますが、その場合、上記の翻訳版著作権に加えて、以下の文をマニュ アルの先頭に付加してください。
  87
  88 .. code-block:: none
  89
  90    .\"   Copyright (C) 1994-1999 Free Software Foundation, Inc.
  91    .\"
  92    .\"   Permission is granted to make and distribute verbatim copies of
  93    .\"this
  94    .\"manual provided the copyright notice and this permission notice are
  95    .\"preserved on all copies.
  96    .\"
  97    .\"   Permission is granted to copy and distribute modified versions of
  98    .\"this manual under the conditions for verbatim copying, provided that
  99    .\"the entire resulting derived work is distributed under the terms of a
 100    .\"permission notice identical to this one.
 101    .\"
 102    .\"   Permission is granted to copy and distribute translations of this
 103    .\"manual into another language, under the above conditions for modified
 104    .\"versions, except that this permission notice may be stated in a
 105    .\"translation approved by the Foundation.
 106    .\"
 107
 108 特殊用語の翻訳について
 109 ======================
 110
 111 特殊用語の翻訳は以下の方針に従ってください。
 112
 113 * コマンド名、関数名、引き数名などは翻訳せず、 アルファベットのままで記述する。
 114 * 英文との相互参照や用語の統一を簡単にするために、 専門用語を翻訳する場合には、 訳語の後ろにかっこつきで原語を併記してください。
 115
 116   .. code-block:: none
 117
 118      共有メモリ(shared memory)
 119
 120 * 専門用語は無理に日本語にせずカタカナ表記を使用する。
 121
 122   .. code-block:: none
 123
 124      × 記述子 (descriptor)
 125      ○ ディスクリプター (descriptor)
 126
 127 マニュアル間での訳語の統一を行うために、 できれば専門用語について単語リストを作成してください。 単語リストは、それぞれのマニュアルページの頭に 以下のような roffのコメント形式で埋め込んでください。
 128
 129 .. code-block:: none
 130
 131    .\"WORD:        effective uid           実効ユーザーID
 132    .\"WORD:        out-of-band             帯域外
 133    .\"WORD:        physical address        物理アドレス
 134    .\"WORD:        signal                  シグナル
 135
 136 音引きについて
 137 ==============
 138
 139 片仮名語の語尾の音引き(ー)には以下の方針を用いてください。
 140
 141 * 既に日本語になっているものについてはそれを用いる。
 142 * できるだけ原語の発音に近い表現を用いる。
 143
 144   .. code-block:: none
 145
 146      ×メモリー(memory)
 147      ○メモリ(memory)
 148
 149 * それ以外の場合に語尾の音引きは省略しない。
 150
 151   .. code-block:: none
 152
 153      ×コンパイラ(compiler)
 154      ○コンパイラー(compiler)
 155
 156 セクション名について
 157 ====================
 158
 159 セクション名については以下のものを使用してください。
 160
 161 .. code-block:: none
 162
 163    ACKNOWLEDGEMENTS        謝辞
 164    ARGUMENTS               引き数
 165    AUTHOR                  著者 or 作者
 166    AUTHORS                 著者 or 作者
 167    BUGS                    バグ
 168    CAVEATS                 警告
 169    COMMAND LINE OPTIONS    オプション or コマンドラインオプション
 170    COMPATIBILITY           互換性
 171    CONFORMING TO           準拠
 172    CONFORMS TO             準拠
 173    COPYING                 著作権
 174    COPYRIGHT               著作権
 175    DESCRIPTION             説明
 176    DIAGNOSTICS             返り値
 177    ENVIRONMENT             環境変数
 178    ENVIRONMENT VARIABLES   環境変数
 179    ERROR                   エラー
 180    ERRORS                  エラー
 181    EXAMPLE                 例
 182    EXAMPLES                例
 183    EXIT CODES              返り値
 184    EXTENSION               拡張
 185    EXTENSIONS              拡張
 186    FILES                   ファイル
 187    FLAGS                   フラグ
 188    HISTORY                 履歴 (or 歴史)
 189    KEYWORDS                キーワード
 190    LIMITATIONS             制限
 191    NAME                    名前
 192    NOTE                    注意
 193    NOTES                   注意
 194    OPTION                  オプション
 195    OPTIONS                 オプション
 196    PARAMETERS              引き数
 197    PORTABILITY             移植性
 198    RESTRICTIONS            制限
 199    RETURN VALUE            返り値
 200    SEE ALSO                関連項目
 201    SOLICITATION            要請
 202    STANDARDS               標準 (or 準拠)
 203    SYNOPSIS                書式
 204    SYNTAX                  書式
 205    VERSION                 バージョン
 206    WARNING                 警告
 207    WARNINGS                警告