JM 文書の管理方法

JM Project では、CVS によって文書の管理をしています。 このページでは、 リポジトリ内部の配置 と、 man ページの作業情報などが記述されたテキストデータベース transalation_list の書式に関する説明をします。

ディレクトリの構成

JM Project の用いている CVS リポジトリのディレクトリ構成は 以下のようになっています。

/ +- www
  |
  +- admin
  |
  +- manual -+- 0unclassified -
             |
             +- GNU_bash -
             |
             +- GNU_binutils -
                    :

このうちの manual/ 以下が、本サイトの roff ディレクトリ 以下にミラーされています。 このディレクトリには、 マニュアルの一次ソースとなるアーカイブパッケージ (例えば util-linux-2.9v.tar.gz など) の basename と同名のサブディレクトリ (util-linux) を設けます。 ただし GNU のパッケージと LDP のパッケージだけには、 便宜上 GNU_, LDP_ という prefix をつけています。 このサブディレクトリを、以下では 「パッケージディレクトリ」と呼びます。

各パッケージディレクトリのサブ構造は以下のようになっています。

- pkg -+- ChangeLog
       +- translation_list
       +- original -+- man1
       |            +- man5
       |            +- man8
       |
       +- draft    -+- man1
       |            +- man5
       |            +- man8
       |
       +- release  -+- man1
       |            +- man5
       |            +- man8
       |
       +- contrib  -+- man1
                    +- man5
                    +- man8

実作業との対応は 翻訳作業の流れ を参考にしてください。

translation_list の書式

translation_list はパッケージディレクトリのルートに 一つだけ置かれるテキストデータベースファイルで、 そのディレクトリ以下に含まれる man ページの情報が 一つのページにつき一行ずつ書かれています。 フィールドの区切りはコロン (:) です。 以下に例を示します。 1行目が 通常のページ の、 2 行目が リンクページ のそれぞれ例になっています。

○:LDP man-pages:1.26:1998/10/03:bind:2:1999/08/02::uv9h-hykw@asahi-net.or.jp:HAYAKAWA Hitoshi:
@:LDP man-pages:1.26:1996/04/15:break:2:unimplemented:2:

通常のページ

「通常のページ」とは、 →リンクページ 以外のページ、実際に文章が書かれているページを指します。

まず第 1 フィールドの内容を説明します。 それぞれのマークの説明に書いてある r:, d:, o: とは、 そのマークのステータスにおいて、 release/, draft/, original/ 各ディレクトリに マニュアルページが存在するかどうかを示したものです。 翻訳作業の流れ と併せてご覧ください。

を表します。

ステータスの遷移をまとめると以下のようになります。

未翻訳状態から:
   × → ▲ →(△)→ ● → ○
                        → ◎
オリジナル改訂後:
  (○)→ ☆ → ■ →(□) → ◆ → ○
  (◎)→ → → ↑              →(◎)

なお、JM 以外のプロジェクトから寄贈を受けたページについては、 以下のようなステータスを用います。 なお寄贈もとの URL がわかる場合は、 「備考」のフィールドに書いておいてください (コロン ":" が含まれていても大丈夫です)。

第二フィールド以下の内容は以下の通りです。

  1. パッケージ名。 パッケージディレクトリ名と基本的に同じものになります。
  2. man ページのバージョン。 リリース後にオリジナルが改定された場合や、 ドラフト作成作業中にさらにオリジナルの改訂があった場合など、 リリース版・ドラフト版・オリジナル版でバージョンが異なってしまった場合には、 "=>" で区切って記述してください。その際には "release=>draft=>original" の順にしてください。 バージョンが同じならわざわざ分けて書かなくても OK です。 なぜなら という条件を考えれば、 どのバージョンがどの版に対応するかを決定するのは容易でしょうから。
  3. オリジナル man-page の日付。 または原文が cvs に commit された日付になっていることもある。
  4. マニュアルファイルの basename。
  5. マニュアルのセクション番号。
  6. 作業の日付。 作業中であることを示すステータス(▲●■◆)では 作業をする宣言をした日になり、 それ以外のステータス(△○◎☆□)では 翻訳ページの最終更新日にします。
  7. 翻訳・再配布に関する条件。 翻訳や配布に関する条件を著作者に確認をとったら、 各著作権に従って以下のステータスを設定します。 確認を取っていないものに関しては、以上のステータスを "()" で囲んでください。
  8. 翻訳作業者のメールアドレス。
  9. 翻訳作業者の名前 (ローマ字表記が望ましい)。
  10. 備考など。

リンクページ

「リンクページ」とは、 別のマニュアルページにシンボリックリンクされていたり、あるいは

.so man1/hoge.1

のように roff 的にリンクされているページのことです。 この種のページに対するステータス行の各フィールドは以下のようになります。 通常の翻訳作業の際には、 このステータスはあまり意識しないでも良いでしょう。

なお、オリジナルではシンボリックリンクになっている場合でも、 JM で配布する際には .so によるリンクに書き換えています。

  1. ステータス
  2. パッケージ名(リンク先と同じ)
  3. バージョン(リンク先と同じ)
  4. 日付(リンク先と同じ)
  5. このマニュアル自体の名前
  6. このマニュアル自体のセクション
  7. リンク先の名前
  8. リンク先のセクション

JM Project や配布マニュアルページに関わるご意見ご要望は JM@linux.or.jp までお願いします。

* JM 翻訳作業の手引きに戻る

* JM Project のメインページへ戻る