diff --git a/ja_JP.eucJP/books/fdp-primer/chapters.ent b/ja_JP.eucJP/books/fdp-primer/chapters.ent index 3fa92c30f4..33da333bbd 100644 --- a/ja_JP.eucJP/books/fdp-primer/chapters.ent +++ b/ja_JP.eucJP/books/fdp-primer/chapters.ent @@ -1,26 +1,29 @@ + + + diff --git a/ja_JP.eucJP/books/fdp-primer/overview/chapter.sgml b/ja_JP.eucJP/books/fdp-primer/overview/chapter.sgml index 3fb37988c0..79d1f0dd73 100644 --- a/ja_JP.eucJP/books/fdp-primer/overview/chapter.sgml +++ b/ja_JP.eucJP/books/fdp-primer/overview/chapter.sgml @@ -1,329 +1,329 @@ 概要 FreeBSD ドキュメンテーションプロジェクトへようこそ. 質の高い文書は, FreeBSD を成功させるために欠かすことができない重要なものです. FreeBSD ドキュメンテーションプロジェクト(FreeBSD Documentation Project; FDP)は, そのような文書を数多く作成するためのプロジェクトです. あなたの貢献は, 非常に貴重です. この文書は主に FDP の構成, 文書の作成と FDP への提出方法および, 文書作成のために利用できるツールの効果的な利用法 について解説することを目的としています. 参加資格 FDP は, どなたでも参加できます. 参加資格はありませんし, 毎月, 文書の作成が義務づけられているわけでもありません. あなたがしなければならないのは, ただ &a.doc; メーリングリストに参加することだけです. この文書を読み終えた後, あなたは次のようになっていなければなりません. どれが FDP が管理する文書はなのか理解して下さい. FDP の管理する文書の SGML のソースコードを読み, 意味が理解できるようになってください. 文書へ変更を加える操作ができるようになってください. あなたの変更が査読を受け, FreeBSD の文書として採用にまわせるよう, 変更の提出ができるようになってください. FreeBSD 文書セット FDP では FreeBSD 関連文書のうち, 次の 4 つのカテゴリを担当しています. マニュアルページ システムの英語版マニュアルページは基本システムの一部であり, FDP がその作成を担当しているわけではありません. しかし FDP は, マニュアルページをよりわかりやすくしたり, 不正確な記述を修正するため, 既存のマニュアルページの改編を行なうことが できます. 翻訳チームは, システムのマニュアルページを他言語に翻訳する 作業を担当しています. この翻訳作業は, FDP の担当範囲内です. FAQ FAQ は, FreeBSD に関連するさまざまなメーリングリストやニュースグループで よく尋ねられる質問, あるいは質問されるべきものについて, (短い質疑応答形式で)取り扱ったものです. この形式では, 必要以上に長く細かい回答は許されません. ハンドブック ハンドブックは広範囲の話題を扱った FreeBSD のユーザのための オンライン情報源, およびリファレンスとなることを意図したものです. ウェブサイト これは, World Wide Web において中心的な FreeBSD のサイトであり, http://www.FreeBSD.org/ と, 世界中に存在するたくさんのミラーサイトから見ることができます. このウェブサイトは, 多くの人々が FreeBSD を初めて目にする場所でもあります. この 4 種類の文書は, いずれも FreeBSD CVS ツリーから入手することができます. そのため, ファイルへの変更履歴は一般に公開されていて, CVSupCTM といったプログラムを使い 誰でも文書のローカルコピーを最新のものに保つことができます. さらに, たくさんの人々がチュートリアルや FreeBSD 関連のウェブサイトをつくっています. それらのなかには, 他の文書と同じように CVS リポジトリ(の原作者が同意した場所)に 含まれているものもある一方, FreeBSD のリポジトリからは分離して, 原作者の手によって直接保守されているものもあります. FDP では, そのような文書に対して可能な限り, リンクを提供するように努力しています. はじめる前に この文書は, 次にあげる内容について あなたがすでに理解していることを前提として書かれています. FreeBSD CVS リポジトリのローカルコピーを (CVS, もしくは CVSupCTM を使って) 入手したり, CVSup を使って チェックアウトした(checked-out)コピーを ダウンロードすることで, FreeBSD の文書のローカルコピーを最新に維持する方法について. FreeBSD Ports システム, もしくは &man.pkg.add.1 を利用して新しいソフトウェアをダウンロードし, インストールする方法について. まずははじめてみる もし何かやってみたくなって, 継続してやっていく自信があるなら, 以下の手順を追ってみてください. textproc/docproj メタ port を インストールします. &prompt.root; cd /usr/ports/textproc/docproj &prompt.root; make JADETEX=no install FreeBSD doc ツリーのローカルコピー を入手します. CVSup を checkout モードで使うか, CVS リポジトリの完全なコピーをローカルに取り寄せるかします. CVS リポジトリをローカルに持つようにした場合, 少なくとも doc/sharedoc/en_US.ISO8859-1/share ディレクトリ をチェックアウトする必要があります. &prompt.user; cvs checkout doc/share &prompt.user; cvs checkout doc/en_US.ISO8859-1/share ディスクスペースに余裕があるようでしたら, 全てをチェックアウト してしまうこともできます. &prompt.user; cvs checkout doc 既存の book もしくは article に変更を加えようと している場合には, リポジトリのその部分をチェックアウトします. 新規に book や article を寄稿しようとしている場合には, 既存のものをテンプレートとして使ってください. 例えば, FreeBSD と Windows 2000 の間に VPN を設定するような 新しい article を寄稿しようとしている場合, 以下のようにします. articles ディレクトリを チェックアウトします. &prompt.user; cvs checkout doc/en_US.ISO8859-1/articles 既存の article をテンプレートとして使うために コピーします. 今回は, 新しい article は vpn-w2k というディレクトリに入れることにしましょう. &prompt.user; cd doc/en_US.ISO8859-1/articles &prompt.user; cp -r committers-guide vpn-w2k もし doc/en_US.ISO8859-1/books/faq にある FAQ のような既存の文書に手を加える場合, リポジトリから以下のようにチェックアウトします. &prompt.user; cvs checkout doc/en_US.ISO8859-1/books/faq .sgml ファイルをあなたの好きな エディタで編集します. lint ターゲットでマークアップ をテストします. これにより, 時間のかかる変換を実際に行なうこと無く, 文書中の間違いをすばやく見つけることができます. &prompt.user; make lint 文書を実際に構築する準備ができたら, FORMATS 変数で単一のフォーマット, もしくはフォーマットの一覧を指定することができます. 今のところ, html, html-split, txt, ps, pdf, rtf が指定できます. サポートされているフォーマットの最新のリストは doc/share/mk/doc.docbook.mk ファイルの 先頭を見てください. 単一のコマンドで複数のフォーマットを構築しようとする際 には, フォーマットの一覧を引用符で括ることを忘れないでください. 例えば, 文書を html に変換する だけなら以下のようになります: &prompt.user; make FORMATS=html 文書を htmltxt の両方のフォーマットに変換したい場合は, 以下のように &man.make.1; を二回にわけて実行することでできます: &prompt.user; make FORMATS=html &prompt.user; make FORMATS=txt 一回のコマンドで実行するには, 以下のようになります: &prompt.user; make FORMATS="html txt" 変更点を &man.send-pr.1; を使って提出します. diff --git a/ja_JP.eucJP/books/fdp-primer/psgml-mode/chapter.sgml b/ja_JP.eucJP/books/fdp-primer/psgml-mode/chapter.sgml index de77261a93..0d855f85d7 100644 --- a/ja_JP.eucJP/books/fdp-primer/psgml-mode/chapter.sgml +++ b/ja_JP.eucJP/books/fdp-primer/psgml-mode/chapter.sgml @@ -1,183 +1,183 @@ <application>Emacs</application> で <literal>sgml-mode</literal> を利用する 新しいバージョンの EmacsXemacs (Ports Collection にあります)には, PSGML と呼ばれる非常に便利なパッケージが附属しています. これは拡張子がとなっている .sgml のファイルが読み込まれるか, M-x sgml-mode と入力することで呼び出されます. PSGML は, SGML ファイルやエレメント, 属性を扱うためのメジャーモードです. このモードで提供されているいくつかのコマンドを知っていれば, ハンドブックなどの SGML 文書をより簡単に扱うことができるようになります. C-c C-e sgml-insert-element を実行します. 実行すると, 現在のカーソル位置に挿入すべきエレメント名が聞かれ, TAB キーを使うことでエレメント名の補完ができます. また, カーソル位置に挿入できないエレメント名は入力できないようになっています. 挿入は, 指定したエレメントのスタートタグとエンドタグが両方行なわれます. もし, そのエレメントが他の必須エレメントを含む場合は, その必須エレメントも同じように挿入されます. C-c = sgml-change-element-name を実行します. カーソルをエレメントの内側に移動させてこのコマンドを実行して下さい. 変更するエレメント名が聞かれ, 現在のエレメントのスタートタグとエンドタグが 入力した新しいエレメントのものに変更されます. C-c C-r sgml-tag-region を実行します. テキストを指定(テキストの開始点に移動して C-Space を押し, 終了点に移動して C-Space を押す)してから, このコマンドを実行して下さい. 利用するエレメント名が聞かれ, マークが付けられた範囲(リージョン)のすぐ前後に指定したエレメントが挿入されます. C-c - sgml-untag-element を実行します. カーソルを削除したいエレメントのスタートタグか, エンドタグの上において このコマンドを実行して下さい. すると, エレメントのスタートタグ, エンドタグが両方とも削除されます. C-c C-q sgml-fill-element を実行します. 実行すると, カーソル位置のエレメントの内容に対して, (整形する時のように)再帰的な文章の詰めが行なわれます. この詰め作業は, 含まれている空白文字が重要なもの, たとえば programlisting エレメントの中などでも効果がありますので, 利用の際は注意して下さい. C-c C-a sgml-edit-attributes を実行します. 実行するともう一つバッファを開き, 最も近い閉じたエレメントのすべての属性のリストと, 現在の値を表示します. TAB を使って属性間を移動することができ, C-k を 押すことで, 既存の値を新しいものに置き換えることができます. - また, C-c を押すことで, バッファを閉じて + また, C-c C-c を押すことで, バッファを閉じて 元の文書に戻ることができます. C-c C-v sgml-validate を実行します. 実行すると(必要に応じて)現在編集中の文書をセーブするかどうか聞かれ, 次に SGML の正当性検査が行なわれます. 検査の出力は新しいバッファに表示されますので, 誤りのある部分へひとつひとつ移動してマークアップのミスを修正することができます. もちろん, このモードには他にも有用な機能があります. ここにあげたのは, その中でもわたしが非常に頻繁に利用しているものです. ドキュメンテーションプロジェクトで作業するのに, 適切な空白, インデント, コラム幅を設定するのに, .emacs に以下のエントリを使うことができます. (setq sgml-mode-hook '(lambda () (setq fill-column 70 indent-tabs-mode nil next-line-add-newlines nil standard-indent 2) (auto-fill-mode t))) diff --git a/ja_JP.eucJP/books/fdp-primer/structure/chapter.sgml b/ja_JP.eucJP/books/fdp-primer/structure/chapter.sgml index 2ba21acc15..d3fa600e45 100644 --- a/ja_JP.eucJP/books/fdp-primer/structure/chapter.sgml +++ b/ja_JP.eucJP/books/fdp-primer/structure/chapter.sgml @@ -1,322 +1,317 @@ <filename>doc/</filename> 以下に構成されている文書 doc/ ソースツリーは, ある一貫した方針で構成されています. また, そのうち FDP が管理する文書は, さらに別の方針で構成されています. これは新しい文書をソースツリーに追加する作業の単純化に加え, 文書を他の形式への変換を自動化しやすくすること 他の異なる文書構成との間の一貫性を維持し, 相互に作業しやすくすること ソースツリー上で新しい文書を導入する場所の決定を簡単に行なえるようにすること を目的としています. さらに文書のソースツリーは, さまざまな異なる言語や 文字エンコーディングに対応できなければなりません. 文書ツリーの構造が特定の慣習や文化背景を強制するものであっては ならないという点は重要です. - + ソースツリーの最上位 <filename>doc/</filename> doc/ の下には二種類のディレクトリがあり, 各ディレクトリはそれぞれ, 特別な名前と意味を持っています. + ディレクトリ + + 意味 + share/ このディレクトリには, 文書の翻訳やエンコーディングに依存しないファイルが収められ, その分類のためのサブディレクトリがつくられています. たとえば, &man.make.1; で使用されるファイルは share/mk に, (FreeBSD で拡張された DocBook DTD などの) SGML 関連のファイルは share/sgml におかれています. lang.encoding/ 各々の文書の翻訳, エンコーディングに対して, それに対応する一つのディレクトリがあります. 具体的には, en_US.ISO8859-1/zh_TW.Big5/ というディレクトリです. ディレクトリ名が長いのですが, 言語とエンコーディングを完全に記述することで, 翻訳チームが将来的に, 同一の言語で異なるエンコーディングの 文書を提供する際に発生する問題を回避することができます. また, Unicode に移行するとしても, この方法ならば問題はまったくありません. - + <filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename> ディレクトリ群 これらのディレクトリには, 文書そのものがおかれています. 文書はこのディレクトリからさらに, それぞれ異なるディレクトリ名で示される三種類に分類されます. + ディレクトリ + + 内容 + articles DocBook の article(もしくはそれと同等なもの) でマークアップされた文書です. 文書は短めのもので, 構成単位は節(section)となっています. 通常, 一つの HTML ファイルとして生成されます. books DocBook の book(もしくはそれと同等なもの) でマークアップされた文書です. 文書は比較的長めで, 構成単位は章(chapter)となっています. 通常, (高速なネットワーク接続を持っている人や, ブラウザからの印刷に便利なよう)大きな単一の HTML ファイルと, リンクされた小さな HTML ファイルの両方が生成されます. man システムのマニュアルページの翻訳をおくためのディレクトリです. このディレクトリには, さらに mann という, 翻訳されたマニュアルのセクションに対応する複数のディレクトリがあります. ここで説明したディレクトリすべてが, 必ずそれぞれの lang.encoding ディレクトリにあるというわけではありません. どのディレクトリが存在するかについては, 翻訳チームがどれだけ翻訳を完了しているかに依存します. - + 特定の文書に関する情報 このセクションでは, FDP が管理する特定の文書に関する注意点が書かれています. ハンドブック books/handbook/ ハンドブックは, FreeBSD によって拡張された DocBook DTD で書かれています. ハンドブックは, DocBook の book によって構成されています. そしてそれは複数の part に分割され, part はいくつかの chapter を含みます. chapter は さらにセクション(sect1), サブセクション (sect2, sect3) などに分割されています. 物理的な構成 handbook ディレクトリには, 数多くのファイルとディレクトリがおかれています. ハンドブックの構成は, 時より変更されますので, この文書では, 構成変更の細かな部分の記述が古くなってしまっているかも知れません. ハンドブックの構成について疑問点がありましたら, FreeBSD ドキュメンテーションプロジェクト freebsd-doc@FreeBSD.org まで連絡下さい. <filename>Makefile</filename> Makefile は, SGML ソースを他の形式に変換する方法を決めたり, ハンドブックを構築する各種ソースファイルを列挙する さまざまな変数を定義するものです. このファイルは, 文書形式の変換を扱うためのコードを取り込むために 標準の doc.project.mk をインクルードします. <filename>book.sgml</filename> これはハンドブックの構造において最上位にあたる文書です. ハンドブックの DOCTYPE 宣言とハンドブックの構成を記述するためのエレメントが含まれています. book.sgml は, .ent という拡張子のついたファイルをロードするためにパラメータ実体(parameter entities)を使います. (後述する)これらのファイルには, ハンドブックの他の部分で共通して使われる一般実体(general entities) が定義されています. <filename><replaceable>directory</replaceable>/chapter.sgml</filename> ハンドブックの各章は, 互いに個別に分けられたディレクトリに chapter.sgml というファイルとして格納されています. それぞれのディレクトリには, chapter エレメントの id 属性の値と同じ名前が付けられています. たとえば, ある章のファイルが ... ]]> のようになっていたとすれば, それは kernelconfiguration という ディレクトリ中の chapter.sgml というファイルです. 通常, その章の内容はすべてこのファイルに書かれています. HTML 版のハンドブックを構築する時, この章は kernelconfiguration.html というファイル名として生成されます. これは id の値に関係するもので, ディレクトリ名との関連はありません. ハンドブックの以前の版では, 文書のファイルは book.sgml と同じディレクトリにおかれていて, ファイル名は chapter エレメントの id 属性の値になっていました. これを個別のディレクトリに分けて移動させたのはハンドブックの 将来的な計画の準備のためです. 具体的には, こうすることで, 特に変更することなく各章に画像を追加することが可能になります. また, それぞれの画像ファイルを章のテキストファイルと同じディレクトリに おくことは, 大きな一つのディレクトリにすべてのテキストファイルと 画像ファイルをおいて管理しようとするより分かりやすくなります. 名前空間の衝突が発生したとしても, 格納ファイルの少ないディレクトリで作業する方が, 数多くのファイルがディレクトリにある場合よりも対処しやすくなるでしょう. ここまでを簡単にまとめると, 個々に chapter.sgml というファイルを含むディレクトリがたくさんあり, それらは basics/chapter.sgml, introduction/chapter.sgml, printing/chapter.sgml などという名前になっているということです. 章とディレクトリは, ハンドブックの並び順を反映した方法で名付けられるべきではありません. 順番はハンドブックの改訂の際に変更される可能性があります. (章全体が階層構造の中で上下に移動するような場合でなければ) こういった改訂が行なわれる場合にファイル名を変更する必要性が (なるべく) 生じないようにするべきです. 各々の chapter.sgml ファイルは, 完全な SGML 文書ではありません. 詳しく言えば, それらのファイルの先頭には DOCTYPE 宣言の行が書かれていません. これには, 二つの欠点があります. - - - - これらのファイルは一般的な SGML - ファイルとして扱うことができないため, - HTML, RTF, PS などの形式に変換するのに, - ハンドブック全体の生成に用いている方法と同じ方法を単純に用いることができません. - そのため, ただ一つの章だけを変更し, その結果を確認しようという場合には, - 毎回ハンドブック全体を構築し直さなければならないことになります. - - - - - Emacs の sgml-mode を使う場合, - 文書が利用している DTD を認識できないために - sgml-mode - の便利な機能(エレメントの補完入力, - 自動チェック機能など)が利用できなくなります. - - - + + これらのファイルは一般的な SGML ファイルとして扱うことが + できないため, HTML, RTF, PS などの形式に変換するのに, + ハンドブック全体の生成に用いている方法と同じ方法を + 単純に用いることができないという欠点があります. + そのため, ただ一つの章だけを変更し, + その結果を確認しようという場合には, 毎回ハンドブック全体を + 構築し直さなければならないことになります. diff --git a/ja_JP.eucJP/books/fdp-primer/stylesheets/chapter.sgml b/ja_JP.eucJP/books/fdp-primer/stylesheets/chapter.sgml index 5d4e1da2ab..d22f960b58 100644 --- a/ja_JP.eucJP/books/fdp-primer/stylesheets/chapter.sgml +++ b/ja_JP.eucJP/books/fdp-primer/stylesheets/chapter.sgml @@ -1,89 +1,114 @@ * スタイルシート SGML は, 文書が利用者にどのように表示されるかということや, 紙の上にどう配置されるかということについては何も定義していません. それらを行なうためにスタイルシートを記述するさまざまな言語が開発されています. その言語には, DynaText, Panorama, SPICE, JSSS, FOSI, CSS, DSSSL などがあります. わたしたちは, DocBook 文書用として DSSSL で書かれたスタイルシートを, HTML 文書用として CSS を利用しています. - + * DSSSL ドキュメンテーションプロジェクトでは, Norm Walsh 氏による Modular DocBook Stylesheets を少しカスタマイズしたものを使っています. このスタイルシートは, - textproc/dsssl-docbook-modular + textproc/dsssl-docbook-modular から入手できます. 変更が加えられたスタイルシートは, ports システムに含まれていません. それらはドキュメンテーションプロジェクトのソースリポジトリの一部であり, doc/share/sgml/freebsd.dsl におかれています. 変更が加えられたスタイルシートには詳細なコメントが付けられていますので, この章が完成するまで, 標準のスタイルシートにあるオプションが どういった風に FreeBSD ドキュメンテーションプロジェクト用に カスタマイズされているのか, このファイルを見て調べてみてください. このファイルには FreeBSD 独自のエレメントを組版するために スタイルシートを適用するエレメントを追加する方法の例も含まれています. - - * CSS - - + + CSS + + Cascading Stylesheets (CSS) はスタイル情報 + (フォント, ウェイト, 大きさ, 色などなど) + を HTML 文書の要素に付加する機構です. + + + ウェブサイト (HTML 文書) + + FreeBSD のウェブサイトは現在 CSS を使用していません. + 残念ながら, 見た目とその印象は HTML の各属性で直接調整されており, + 人によってその度合は異なります. + この問題は解決すべきであり, ドキュメンテーションプロジェクトに + 貢献するに値する良いプロジェクトになるでしょう. + + + + DocBook 文書 + + FreeBSD の DSSSL スタイルシートには, スタイルシート + docbook.css への参照が含まれています. + このスタイルシートは HTML ファイルと同一のディレクトリに + 存在することが想定されています. + プロジェクトにまたがる CSS ファイルは, + 文書が HTML に変換される時に + doc/share/misc/docbook.css + から複製され, 自動的にインストールされます. + diff --git a/ja_JP.eucJP/books/fdp-primer/tools/chapter.sgml b/ja_JP.eucJP/books/fdp-primer/tools/chapter.sgml index deec842422..5369e3ead0 100644 --- a/ja_JP.eucJP/books/fdp-primer/tools/chapter.sgml +++ b/ja_JP.eucJP/books/fdp-primer/tools/chapter.sgml @@ -1,305 +1,307 @@ ツール FDP では FreeBSD の文書を管理したり, 他の出力形式にに整形したりするため, さまざまなソフトウェアツールを利用します. FreeBSD の文書で作業するには, あなた自身がそれらのツールを使う必要があります. これらのツールはすべて FreeBSD の port や package として入手可能で, インストール作業は非常に簡単です. 以下の章に書かれた例を試すには, あらかじめ これらのツールがインストールされていなければなりません. 各ツールの実際の利用方法は, その例が書かれた章で説明されています. - - できるだけ <filename>textproc/docproj</filename> を利用してください + + できるだけ <filename role="package">textproc/docproj</filename> を利用してください - textproc/docproj の port + textproc/docproj の port を使うとインストールする手間を大きく省くことができます. これは - メタ(meta) port と呼ばれる port で, + メタ (meta) port と呼ばれる port で, その中にソフトウェアが含むかわりに, 他のさまざまな port が正しくインストールされるように依存関係がつくられているものです. この port をインストールすると, この章であげられているソフトウェアが 自動的にすべてダウンロードされ, インストールされます. 必要となるパッケージの一つに, JadeTeX マクロセットというものがあります. このマクロセットは, インストール時に TeX がインストールされていることを必要とします. TeX は非常に大きなパッケージですが, Postscript や PDF 形式の出力を行なわないならばインストールの必要はありません. 時間とディスクスペースの節約のため, - この port をインストールする際に, JadeTeX(すなわち TeX を含む) + この port をインストールする際に, JadeTeX (すなわち TeX を含む) を必要とするかどうかを指定する必要があります. 次のいずれかを, 場合に応じて実行して下さい. &prompt.root; make JADETEX=yes install &prompt.root; make JADETEX=no install + JADETEX=no を指定してツールをインストールすると, + HTML や ACSII テキストだけを出力することができます. + PostScript や PDF を出力するには TeX が必要です. - + - + 必須のツール ソフトウェア 以下のプログラムは, FreeBSD - の文書で快適に作業するために必要なものです. これらはすべて, - textproc/docproj + の文書で快適に作業するために必要なものであり, 文書を + HTML, プレインテキストや RTF 形式に変換することができます. + これらはすべて, + textproc/docproj に含まれています. SP - (textproc/sp) + (textproc/sp) 正当性検査のための SGML パーサや SGML 正規化ツールを含むアプリケーションのセットです. Jade - (textproc/jade) + (textproc/jade) DSSSL の実装です. これはマークアップされた文書を HTML や TeX といった他の形式に変換するために使われます. Tidy - (www/tidy) + (www/tidy) HTML 整形ツールです. これは自動生成された HTML 文書を整形し, より利用しやすいものにするために使われます. - W3M - (www/w3m) + Links + (www/links) - - テキストモードの WWW ブラウザです. &man.w3m.1; - は, HTML - ファイルをプレインテキストに変換することができます. - + HTML ファイルをプレインテキストに変換することのできる + テキストモードの WWW ブラウザです. + + + + + peps + (graphics/peps) + + + いくつかの文書には画像が含まれており, その中には + EPS 形式で格納されているファイルがあります. + ウェブブラウザが表示できるように + PNG 形式に変換するために使われます. - 文書型定義(DTD)と実体宣言(entity) + 文書型定義 (DTD) と実体宣言 (entity) - 以下にあげるのは, FDP で使われている DTD と実体宣言集合(entity set)です. + 以下にあげるのは, FDP で使われている DTD と実体宣言集合 (entity set)です. これらはいずれも, 文書を取り扱う前に必要となります. - HTML DTD (textproc/html) + HTML DTD (textproc/html) HTML は, World Wide Web で採用されているマークアップ言語です. これは FreeBSD ウェブサイト全体でも利用されます. - LinuxDoc DTD (textproc/linuxdoc) - - - FreeBSD の文書には, LinuxDoc でマークアップされたものがあります. - FDP では, LinuxDoc から DocBook への移行を積極的にすすめています. - - - - - - DocBook DTD (textproc/docbook) + DocBook DTD (textproc/docbook) - DocBook は, 技術文書のマークアップのために設計された DTD であり, - FDP では LinuxDoc から DocBook への移行をすすめています. - この原稿を執筆している時点で, FreeBSD ハンドブックが - DockBook によってマークアップされています. + DocBook は, 技術文書のマークアップのために設計された DTD です. + FreeBSD の文書はすべて DocBook で記述されています. ISO 8879 公開実体宣言 - (textproc/iso8879) + (textproc/iso8879) ISO 8879:1986 に規定された 19 種類の 文字実体集合です. これはたくさんの DTD で利用されるもので, 数学記号や latin - 文字集合の追加文字(アクセント記号, 発音記号など), + 文字集合の追加文字 (アクセント記号, 発音記号など), ギリシャ文字などが含まれます. スタイルシート スタイルシートは, 文書を画面表示や印刷などに利用される形式に変換, 整形するために使われます. Modular DocBook Stylesheets - (textproc/dsssl-docbook-modular) + (textproc/dsssl-docbook-modular) Modular DocBook Stylesheets は, DocBook DTD でマークアップされた文書を HTML や RTF 形式に変換するのに使われます. - - 必須でない(optional)ツール + + 必須でない (optional) ツール もし必要性を感じないなら, 以下にあげるソフトウェアはインストールしなくともかまいません. しかしインストールしていれば, 文書の取り扱いに便利だと感じるでしょうし, これらを使うことで, より多様な出力形式で文書を出力することが可能となります. ソフトウェア JadeTeX および teTeX - (print/jadetex および - print/teTeX) + (print/jadetex および + print/teTeX) JadeteTeX は, DocBook 文書を DVI, Postscript, PDF の各形式に変換するのに使われます. また, このとき JadeTeX マクロも必要となります. 文書をそのような形式に変換しなくて良い - (たとえば HTML, プレインテキスト, RTF で十分であるような)場合には, + (たとえば HTML, プレインテキスト, RTF で十分であるような) 場合には, JadeTeX および teTeX をインストールする必要はありません. これらのインストールには大きなディスクスペースと時間を必要とします. teTeX は, 30MB を超える大きなものです. JadeTeXteTeX をインストールする場合には, JadeTeX がインストールされた後, teTeX の設定を行なわなければなりません. 必要な手順の詳細は, - print/jadetex/pkg/MESSAGE + print/jadetex/pkg-message に説明されています. Emacs もしくは xemacs - (editors/emacs もしくは - editors/xemacs) + (editors/emacs もしくは + editors/xemacs) このエディタは両方とも, SGML DTD でマークアップされた文書を編集するための特別なモードを備えています. このモードには, 必要なタイプ量や誤りをを低減するためのコマンドがあります. どのようなテキストエディタでもマークアップされた文書を編集することは可能ですので, これらを使う必要があるというわけではありません. しかしおそらく, これらは便利なものだと感じると思います. もし, この他に SGML 文書を扱うために有用なソフトウェアをご存知でしたら, - Nik Clayton(nik@FreeBSD.org) までお知らせ下さい. + &nik; までお知らせ下さい. このリストに加えさせていただきます.