Appendix C. NetBSD ガイドへの寄稿

目次
C.1. ガイドの翻訳
C.2. 原稿の送付
C.3. SGML/DocBook テンプレート

NetBSD の紹介と高度な ドキュメントに興味があり: これは多分、このオペレーティングシステムの人口と user base の増加を示します。 そのために、このガイドへの新しい素材の追加や、既存物の改良を 続けることは重要です。

あなたの NetBSD 習熟度がどんなレベルであっても、 このガイドの開発に貢献できます。 この appendix では、あなたができる NetBSD ガイドへの貢献方法 と、それを始める前に知っていると良いことを書きます。

もし、あなたが初心者でこのガイドが役に立つなら、 comments や suggestions を送ってください。例えば、 ここで述べられたことを試したけども動かなかった、 あるいは、どこか明白じゃないと思う、 あるいは、新しい章のアイデアがあるなど: この種の意見は とても役に立ちます。

もしあなたが 中級あるいは上級ユーザーなら、 ぜひ このガイドの新しい素材の寄付を考慮してください: 新しい章を書いたり、既存の章の改善ができます。

もし、時間があれば、このガイドを他の言語に 翻訳できます。

どれをするのでも、重複をさけるために 始める前に私に連絡をしてください

C.1. ガイドの翻訳

ガイドを翻訳したい場合、最初にすることは、 既に言っているように、私に連絡をとるか、 netbsd-docs@netbsd.org メーリングリストに書いてください。 いくつか、採れるシナリオは:

翻訳が既に終わっていても、 新しい素材が追加されたり訂正が入るので 元の版に関心を持っていつも最新状態に保つことも必要で: あなたが翻訳のメンテナーになることができます。

C.1.1. 翻訳をはじめるのに必要なこと

ガイドの翻訳をするには必ずガイドのソースを 取得してください。 私に e-mail を出していただけば、最新のソース、 makefile 等を送ります。

つまり、必要なものは:

  • ガイドのソース

  • viemacs のようなテキストエディター。

註: HTML や 他のフォーマットの物を元にして作業しないで: NetBSD ガイドで用いている SGML/DocBook 形式への変換が とても難しいからです。

C.1.2. SGML/DocBook の記述

ガイドを翻訳するために SGML/DocBook を 勉強 する必要はありません: SGML/DocBook ソースを持ってきて、それに直接作業をすることで、 既存の体裁(つまり tags)を 再利用します。 例えば、 上の註の翻訳には 次のように:

  1. エディターで、 この章の英語版ソース ap-contrib.sgml を ロードします。

  2. 上の註の文章を探します。 このようになっていて:

    <note>
      <para>
        don't start working with HTML or other formats:
        it will be very difficult to convert you work
        to SGML/DocBook, the format used by the NetBSD
        guide.
      </para>
    </note>            

  3. 英文の後ろ、タグとの間に翻訳文を 書きます。 このとき、テキストはこのようになっていて:

    <note>
      <para>
        don't start working with HTML or other formats:
        it will be very difficult to convert you work
        to SGML/DocBook, the format used by the NetBSD
        guide.
        翻訳文をここに
        翻訳文をここに
        翻訳文をここに
      </para>
    </note>            

  4. 翻訳文とその上の、 tags 間の英文4行を消します。

    <note>
      <para>
        翻訳文をここに
        翻訳文をここに
        翻訳文をここに
      </para>
    </note>            

翻訳する時は、オリジナルテキストと同じ インデントと書式にしてください。 例として Section C.3 をご覧ください。

DocBook 文章 を書いているときに、突き当たると思われる問題は、 各国の文字です (例えば アクセント付き 文字、 "è" のような)。 これらの文字をソースドキュメント中に使うことはできますが、 SGML entities で置きかえるよりは良いです。 例えば、 "è""&egrave;" として書かれています。 もちろん、ソースのテキストは読み書きしにくくなります; 最初の問題は、書くことについては、 マクロの使える良いエディターを使うことで解決します。 Viemacs は非常に人気のある選択で、 この両方ともに、この機能があって、 アクセント付きキーをキーボードの 割り当てたいところに自動的に 割り当てることができます。 例えば、 vi では あなたの .exrc ファイルに次のような行を書いておけば:

map! è &egrave;	

Appendix D では DocBook ソースから HTML や他のフォーマットを生成するツールの インストールについて記述しています。 これは作業の確認 (つまり 不注意に tag を消してないかの確認) や 出力がどうなるかを見るのに便利ですが、翻訳にとっては必需品 というわけではありません。 ツールをインストールしたくなければ、 私にソースを送っていただけば、チェックして、 各種フォーマットで作ります。

C.2. 原稿の送付

このガイドに何らかの素材を寄付する場合、 あなたが書く量に応じて いくつかの方法があります。 多少の修正ならば、 私に e-mail で送っていただくのが一番簡単です。 それなりの量の文章、一節あるいは一章といった場合は 多くの書式の中から選べて:

C.3. SGML/DocBook テンプレート

ガイドはプログラムに似た流儀の書式にしています。 テンプレートは次の通り:

<chapter id="chap-xxxxx">
  <title>これは章題です</title>
  
  <para>
    これは節の本文です。  これは節の本文です。
    これは節の本文です。  これは節の本文です。
    これは節の本文です。
  </para>
  
  <!-- ============================================================= -->

  <sect1>
    <title>ここは sect1 のタイトルです</title>
    
    <para>
      これは節の本文です。  これは節の本文です。
      これは節の本文です。  これは節の本文です。
      これは節の本文です。
    </para>

    <!-- ........................................................... -->

    <sect2>
      <title>ここは sect2 のタイトルです</title>

      <para>
	 sect2 は sect1 の中に入れ子にします。
      </para>
    </sect2>
    
  </sect1>
  
  <!-- ============================================================= -->

  <sect1>
    <title>ここは別の sect1 のタイトルです</title>
    
    <para>
      An itemized list:
      <itemizedlist>
	<listitem>
	  <para>
	    本文
	  </para>
	</listitem>
	<listitem>
	  <para>
	    本文
	  </para>
	</listitem>
      </itemizedlist>
    </para>
    
  </sect1>
</chapter>    

デフォルトは: