os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Merge the following from the English version.

Browse source 
And
 - Refine translation.
 - Fix indent.
 - Rewrap lines.

	docproj/docproj/sgml.sgml       1.22 -> 1.28

Submitted by:	Hiroki Kobayashi <solidsneak at hyper dot cx>
References:	[doc-jp-work 1437, 1451]
This commit is contained in:
Ryusuke SUZUKI 2010-06-08 12:43:16 +00:00
parent 302a099d15
commit e016f4800d
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/www/; revision=35862
1 changed files with 56 additions and 62 deletions

118
ja/docproj/sgml.sgml
View file

@ -1,46 +1,43 @@
<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
<!ENTITY base CDATA "..">
<!ENTITY date "$FreeBSD: www/ja/docproj/sgml.sgml,v 1.27 2005/10/04 16:21:46 hrs Exp $">
<!ENTITY title "FreeBSD Documentation Project: SGML">
<!ENTITY date "$FreeBSD: www/ja/docproj/sgml.sgml,v 1.28 2006/08/19 21:24:41 hrs Exp $">
<!ENTITY title "FreeBSD ドキュメンテーションプロジェクト: SGML">
<!ENTITY % navinclude.docs "INCLUDE">
]>
<!-- The FreeBSD Japanese Documentation Project -->
<!-- Original revision: 1.22 -->
<!-- Original revision: 1.28 -->
<html>
&header;
<p>ドキュメンテーションプロジェクトは SGML
をドキュメントを表現するための標準の手段としようとしています。</p>
をドキュメントを表現するための標準の手段として使用しています。</p>
<p>SGML とは <b>S</b>tandard <b>G</b>eneralised <b>M</b>arkup
<b>L</b>anguage のことです。</p>
<p>SGML とは <b>S</b>tandard <b>G</b>eneralized <b>M</b>arkup
<b>L</b>anguage のことです。</p>
<p>簡単に言えば (読者の中の SGML の純正主義者の方々にはお気にさわったら
ごめんなさい) SGML は他の言語を記述するための言語です。</p>
<p>簡単に言えば (読者の中の SGML
の純正主義者の方々にはお気にさわったらごめんなさい)、
SGML は他の言語を記述するための言語です。</p>
<p>あなたはおそらくすでに SGML を使ったことがあるでしょうが、
それには覚えがないでしょう。HTMLには、それは web
ページを書くための言語ですが、正式の書き方があります。
その書き方が SGML で書かれているのです。あなたが HTML
を書いているときには SGML で書いているとは<b>言いません</b>が
(per se)、SGML を使って定義された言語を使っている
ということになります。</p>
それには覚えがないでしょう。HTML (それは web
ページを書くための言語ですが) には、正式の書き方があります。
その書き方が SGML で書かれているのです。あなたが HTML
を書いているときには (それ自体は) SGML で書いているとは<b>言いません</b>が、
SGML を使って定義された言語を使っているということになります。</p>
<p>SGML を使って定義されたマークアップ言語は非常にたくさんあります。
HTMLもその中の一つです。ほかには "LinuxDoc"
と呼ばれるものもあります。おそらくあなたが想像しているように、
それはもともとは Linux のドキュメンテーショングループが
彼らのドキュメントを書くために作ったもので、
FreeBSDドキュメンテーションプロジェクトでも同様にそれを採用しました。</p>
HTML もその一つです。ほかには "DocBook"
というものがあります。
これは技術的なドキュメントを書くためことに特化して設計された言語なので、
後から書式を整えるように技術的なドキュメントを記述するためのタグ
(<tt>&lt;tag&nbsp;content&gt;</tt> のもの) がたくさんあります。
FreeBSD ドキュメンテーションプロジェクトはこれを採用し、
より明確にするためにいくつかの新しい要素を定義しました。</p>
<p>もう一つの SGML で定義されたマークアップ言語として "DocBook"
というものがあります。これは技術的なドキュメントを書くために特別に
設計された言語で、それなりにたくさんのタグがあって (&lt;...&gt;
の中のもの) そのものに関連する技術的なドキュメントを記述しています。</p>
<p>例えば、これは HTML で短い段落を書いてみたものです。
(内容については気にせずに、タグだけを見て下さい)</p>
(内容については気にせずに、タグだけを見て下さい)</p>
<pre><![ CDATA [
<p>システムのパスワードは <tt>/etc/passwd</tt> に記録されます。
@ -72,9 +69,9 @@
使うべきなんだろう?」と考える無駄な時間は取りません。</p>
<p>その代わりに、タグを適材適所に使うだけのことです。</p>
<p>DocBook から他のフォーマット (HTML、PostScript&reg; など) への変換方法は
すべての &lt;filename&gt; が同じように表されるということを
確かめるということです。</p>
<p>DocBook から他のフォーマット (HTML, PostScript&reg; など)
への変換過程では、すべての &lt;filename&gt;
要素は同じように表されます。</p>
</li>
<li><p>あなたはドキュメントの表示について考えることを止めて、
@ -83,40 +80,38 @@
<li><p>ドキュメントはどのそれぞれの出力形式には拘束されていないので、
同じドキュメントからさまざまな異なった形式のものを作ることができます。
- プレインテキスト、HTML、PostScript、RTF、PDF などです。</p></li>
&mdash; プレインテキスト、HTML, PostScript, RTF, PDF などです。</p></li>
<li><p>ドキュメントを作るということはとても '知的な' ことで、
そのためにより知的なことが行われています。例えば、
ドキュメントに含まれるそれぞれのコマンドのリストから
自動的に索引を作るということもできます。</p></li>
そのためにより知的なことが行われています。
例えば、ドキュメントに含まれるそれぞれのコマンドのリストから自動的に索引を作るということもできます。</p></li>
</ul>
<p>もしそれらについてよく知っているなら、これは Microsoft&reg; Word
のスタイルシートに少々似ているものではありますが、
しかし非常により強力なものとなっています。</p>
<p>これは Microsoft&reg; Word
のスタイルシートに少々似ているものではありますが、
より強力なものとなっています。</p>
<p>もちろん、この能力を生かすにはそれなりの労力が必要です。</p>
<ul>
<li><p>使えるタグが非常に多いために、そのすべてを覚えたりそれらを
効果的に使えるようになるためには、より多くの時間が必要です。</p>
<li><p>使えるタグが非常に多いために、
そのすべてを覚えたりそれらを効果的に使えるようになるためには、
より多くの時間が必要です。</p>
<p>覚えるための最も良い方法は、数多くの例のドキュメントのソースを
読んで、他の著者が同じ情報をどう書いているかを見ることです。</p></li>
<p>SGML と DocBook を学ぶための最も良い方法は、
数多くの例のドキュメントのソースを読んで、
他の著者が同じ情報をどう書いているかを見ることです。</p></li>
<li><p>この方法に転向するにはそれほど簡単ではありません。</p></li>
<li><p>この方法に転向するのは簡単ではありません。</p></li>
</ul>
<p>いまのところは、このプロジェクトはまだ LinuxDoc をハンドブックや
FAQ に使っています。それは変更中で、特にドキュメントを DocBook
へ作り変えるプロジェクトを進めているところです。</p>
<h2>もしあなたが DocBook について何も知らないとしても、
貢献できることがあるのでしょうか?</h2>
<h2>もしあなたが LinuxDoc/DocBook について何も知らないとしても、
貢献できることはありますか?</h2>
<p>はい。もちろんです。どんなドキュメントであってもなにもないよりは
良いものです。もしあなたが貢献すべきドキュメントを持っていて、
それが LinuxDoc もしくは DocBook でマークアップされていないとしても、
<p>はい。もちろんです。
どんなドキュメントであっても何もないよりは良いものです。
もしあなたが貢献すべきドキュメントを持っていて、
それが DocBook でマークアップされていないとしても、
何の問題もありません。</p>
<p>普通にそのドキュメントを <a href="submitting.html">提出してください</a>。
@ -124,33 +119,32 @@
それにマークアップをして、そしてコミットしてくれます。
少々運がいいとそのときにあなたにマークアップされたテキストが戻ってきます。
それは役に立ちます。というのはあなたはドキュメントがマークアップされる
"前と後の" 状態を持っているということになり、うまくいけばその過程から
マークアップについていくらかでも学ぶことができるからです。</p>
&quot;前と後の&quot; 状態を持っているということになり、
うまくいけばその過程からマークアップについていくらかでも学ぶことができるからです。</p>
<p>明らかに、あなたの提出したドキュメントは
マークアップされる必要があるために、このことでコミットされるまでの過程は
長引いてしまうことになり、何日も掛かるかもしれません。
しかしそれはちゃんとコミットされることでしょう。</p>
<p>もちろん、
あなたの提出したドキュメントはマークアップしなければならないので、
数時間では済まず、数日に延びてしまうかもしれませんが、
いずれはコミットされることでしょう。</p>
<h2>SGML や DocBook に関する他の情報は ?</h2>
<p>まず、<a
href="&base;/../doc/en_US.ISO8859-1/books/fdp-primer/index.html"><b>Documentation Project
入門</b></a>を読むべきでしょう。 これは FreeBSD documentation の
入門</b></a>を読んでください。 これは FreeBSD documentation の
作業をおこなうために知っておくべきすべてのことに関する包括的な
説明をねらったものです。</p>
<p>これは長編のドキュメントであり、たくさんの小さなファイルに
分割されています。また <a
説明をねらったものです。
これは長編のドキュメントで、
たくさんの小さなページに分割されています。また<a
href="&base;/../doc/en_US.ISO8859-1/books/fdp-primer/book.html"><b>
ひとつの大きなファイル</b></a>としてまとめられているものもあります。</p>
ひとつの大きなページ</b></a>にまとめられているものもあります。</p>
<dl>
<dt><a
href="http://www.oasis-open.org/cover/sgml-xml.html"><b>http://www.oasis-open.org/cover/sgml-xml.html</b></a></dt>
<dd><p>SGML/XML の web ページ。SGML
について数え切れないほどの情報へのポインタがあります。</p></dd>
について数え切れないほどの情報へのリンクがあります。</p></dd>
<dt><a
href="http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html"><b>http://www-sul.stanford.edu/tools/tutorials/html2.0/gentle.html</b></a></dt>