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

- Merge the following from the English version:

Browse source 
r26978 -> r41577	head/ja_JP.eucJP/htdocs/docproj/Makefile
	r28473 -> r41577	head/ja_JP.eucJP/htdocs/docproj/docproj.xml
	r31519 -> r41577 (dead)	head/ja_JP.eucJP/htdocs/docproj/sgml.xml
This commit is contained in:
Ryusuke SUZUKI 2013-05-11 02:15:53 +00:00
parent a6bff3bf37
commit f5b667d5a7
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=41593
3 changed files with 15 additions and 200 deletions
ja_JP.eucJP/htdocs/docproj
Makefiledocproj.xmlsgml.xml

15
ja_JP.eucJP/htdocs/docproj/Makefile
View file

@ -1,6 +1,6 @@
# $FreeBSD$ # $FreeBSD$
# The FreeBSD Japanese Documentation Project # The FreeBSD Japanese Documentation Project
# Original revision: 1.11 # Original revision: r41577
.if exists(../Makefile.conf) .if exists(../Makefile.conf)
.include "../Makefile.conf" .include "../Makefile.conf"
@ -9,15 +9,14 @@
.include "../Makefile.inc" .include "../Makefile.inc"
.endif .endif
DOCS= current.xml DOCS= current.xml
DOCS+= doc-set.xml DOCS+= doc-set.xml
#DOCS+= handbook.xml #DOCS+= handbook.xml
#DOCS+= handbook3.xml #DOCS+= handbook3.xml
DOCS+= sgml.xml DOCS+= submitting.xml
DOCS+= submitting.xml DOCS+= who.xml
DOCS+= who.xml DOCS+= translations.xml
DOCS+= translations.xml DOCS+= docproj.xml
DOCS+= docproj.xml
#DOCS+= todo.xml #DOCS+= todo.xml
INDEXLINK= docproj.html INDEXLINK= docproj.html

31
ja_JP.eucJP/htdocs/docproj/docproj.xml
View file

@ -5,7 +5,7 @@
]> ]>
<!-- $FreeBSD$ --> <!-- $FreeBSD$ -->
<!-- The FreeBSD Japanese Documentation Project --> <!-- The FreeBSD Japanese Documentation Project -->
<!-- Original revision: 1.21 --> <!-- Original revision: r41577 -->
<html xmlns="http://www.w3.org/1999/xhtml"> <html xmlns="http://www.w3.org/1999/xhtml">
<head> <head>
@ -25,15 +25,13 @@
<p>確かに、BSD Unix (と、もっと広範な意味での &unix;) <p>確かに、BSD Unix (と、もっと広範な意味での &unix;)
に関する書籍はたくさん存在します。 に関する書籍はたくさん存在します。
しかし、FreeBSD には FreeBSD なりの独特な機能や手続き、 しかし、FreeBSD には FreeBSD なりの独特な機能や手続き、
クセがあります。 クセがあります。</p>
</p>
<p>それに加えて、 <p>それに加えて、
Unix-like なオペレーティングシステムに触れるのは FreeBSD Unix-like なオペレーティングシステムに触れるのは FreeBSD
が初めてだというユーザもたくさん存在します。 が初めてだというユーザもたくさん存在します。
ですから、 ですから、
質の良い正確なドキュメンテーションが利用可能であることがもっとも大切なのです。 質の良い正確なドキュメンテーションが利用可能であることがもっとも大切なのです。</p>
</p>
<p>FreeBSD ドキュメンテーションプロジェクトは、 <p>FreeBSD ドキュメンテーションプロジェクトは、
ユーザがこの隔たりを埋めるのを助けるために存在します。 ユーザがこの隔たりを埋めるのを助けるために存在します。
@ -42,8 +40,7 @@
<ol> <ol>
<li><p>ドキュメンテーションプロジェクトのメンバは、 <li><p>ドキュメンテーションプロジェクトのメンバは、
ドキュメンテーションを書き、 ドキュメンテーションを書き、
<em>FreeBSD ドキュメンテーション集</em>の一部として寄託します。 <em>FreeBSD ドキュメンテーション集</em>の一部として寄託します。</p></li>
</p></li>
<li><p>ドキュメンテーションプロジェクトのメンバは、 <li><p>ドキュメンテーションプロジェクトのメンバは、
<em>FreeBSD ドキュメンテーション集</em>の体裁や構成について議論し、 <em>FreeBSD ドキュメンテーション集</em>の体裁や構成について議論し、
@ -53,21 +50,18 @@
<table class="tblbasic"> <table class="tblbasic">
<tbody> <tbody>
<tr> <tr>
<td><h2 align="center"><a href="current.html"> <td><h2 align="center"><a href="current.html">進行中のプロジェクト</a></h2>
進行中のプロジェクト</a></h2>
<p>現在、ドキュメンテーションの努力の一環として、 <p>現在、ドキュメンテーションの努力の一環として、
幾つもプロジェクトが<em>進行中です</em>。 幾つもプロジェクトが<em>進行中です</em>。
リストに目を通して、 リストに目を通して、
<b>あなた</b>にもできることがないかどうか調べてみてください。 <b>あなた</b>にもできることがないかどうか調べてみてください。</p></td>
</p></td>
</tr> </tr>
</tbody> </tbody>
</table> </table>
<h2><a href="who.html"> <h2><a href="who.html">我々は何者か、どうしたら参加できるのか</a></h2>
我々は何者か、どうしたら参加できるのか</a></h2>
<p>このページでは、 <p>このページでは、
どのような人々がドキュメンテーションプロジェクトを構成しているのか、 どのような人々がドキュメンテーションプロジェクトを構成しているのか、
@ -79,16 +73,7 @@
ドキュメンテーションプロジェクトが、 ドキュメンテーションプロジェクトが、
それぞれの要素に対して行っている作業について概説しています。</p> それぞれの要素に対して行っている作業について概説しています。</p>
<h2><a href="sgml.html"> <h2><a href="submitting.html">ドキュメンテーションを寄託する</a></h2>
SGML とドキュメンテーションプロジェクト</a></h2>
<p>プロジェクトはドキュメンテーションのために SGML
を使用しています。このページでは、
SGML でドキュメンテーションをつくる方法を概説し、
興味を持った読み手に、SGML に関する更なるリソースを教えています。</p>
<h2><a href="submitting.html">
ドキュメンテーションを寄託する</a></h2>
<p>ドキュメンテーションを寄託するのは、 <p>ドキュメンテーションを寄託するのは、
プロジェクトに参加する最良の方法であり、 プロジェクトに参加する最良の方法であり、

169
ja_JP.eucJP/htdocs/docproj/sgml.xml
View file

@ -1,169 +0,0 @@
<?xml version="1.0" encoding="euc-jp"?>
<!DOCTYPE html PUBLIC "-//FreeBSD//DTD XHTML 1.0 Transitional-Based Extension//EN"
"http://www.FreeBSD.org/XML/doc/share/xml/xhtml10-freebsd.dtd" [
<!ENTITY title "FreeBSD ドキュメンテーションプロジェクト: SGML">
]>
<!-- The FreeBSD Japanese Documentation Project -->
<!-- Original revision: 1.28 -->
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>&title;</title>
<cvs:keyword xmlns:cvs="http://www.FreeBSD.org/XML/CVS">$FreeBSD$</cvs:keyword>
</head>
<body class="navinclude.docs">
<p>ドキュメンテーションプロジェクトは SGML
をドキュメントを表現するための標準の手段として使用しています。</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 を使ったことがあるでしょうが、
それには覚えがないでしょう。HTML (それは web
ページを書くための言語ですが) には、正式の書き方があります。
その書き方が SGML で書かれているのです。あなたが HTML
を書いているときには (それ自体は) SGML で書いているとは<b>言いません</b>が、
SGML を使って定義された言語を使っているということになります。</p>
<p>SGML を使って定義されたマークアップ言語は非常にたくさんあります。
HTML もその一つです。ほかには "DocBook"
というものがあります。
これは技術的なドキュメントを書くためことに特化して設計された言語なので、
後から書式を整えるように技術的なドキュメントを記述するためのタグ
(<tt>&lt;tag&nbsp;content&gt;</tt> のもの) がたくさんあります。
FreeBSD ドキュメンテーションプロジェクトはこれを採用し、
より明確にするためにいくつかの新しい要素を定義しました。</p>
<p>例えば、これは HTML で短い段落を書いてみたものです。
(内容については気にせずに、タグだけを見て下さい)</p>
<pre><![CDATA[
<p>システムのパスワードは <tt>/etc/passwd</tt> に記録されます。
このファイルを編集したいときには <b><tt>vipw</tt></b> を使うべきです。
しかし、単に新しいユーザを加えたいだけのときには <b><tt>adduser</tt></b>
も使うことができます。</p>
]]></pre>
<p>同じ段落を DocBook を使ってみるとこのようになります。</p>
<pre><![CDATA[
<para>システムのパスワードは <filename>/etc/passwd</filename>
に記録されます。このファイルを編集したいときには
<command>vipw</command> を使うべきです。しかし、
単に新しいユーザを加えたいだけのときには <command>adduser</command>
も使うことができます。</para>
]]></pre>
<p>見てわかるように、DocBook は HTML よりもずっと '表現が豊富' です。
HTML の例ではファイル名は 'typewriter' フォントで表示されるように
マークアップされていますが、DocBook の例ではファイル名は 'filename'
としてマークアップされ、ファイル名の表示については記述されません。</p>
<p>このマークアップのより表現に富む形式について多くの利点を挙げてみましょう。</p>
<ul>
<li><p>曖昧だったり無節操だったりすることがありません。</p>
<p>「うーん、ファイル名を表示するのに、'tt'、'b'、'em' のどれを
使うべきなんだろう?」と考える無駄な時間は取りません。</p>
<p>その代わりに、タグを適材適所に使うだけのことです。</p>
<p>DocBook から他のフォーマット (HTML, PostScript&reg; など)
への変換過程では、すべての &lt;filename&gt;
要素は同じように表されます。</p>
</li>
<li><p>あなたはドキュメントの表示について考えることを止めて、
その代わりに内容に集中できるのです。</p>
</li>
<li><p>ドキュメントはどのそれぞれの出力形式には拘束されていないので、
同じドキュメントからさまざまな異なった形式のものを作ることができます。
&mdash; プレインテキスト、HTML, PostScript, RTF, PDF などです。</p></li>
<li><p>ドキュメントを作るということはとても '知的な' ことで、
そのためにより知的なことが行われています。
例えば、ドキュメントに含まれるそれぞれのコマンドのリストから自動的に索引を作るということもできます。</p></li>
</ul>
<p>これは Microsoft&reg; Word
のスタイルシートに少々似ているものではありますが、
より強力なものとなっています。</p>
<p>もちろん、この能力を生かすにはそれなりの労力が必要です。</p>
<ul>
<li><p>使えるタグが非常に多いために、
そのすべてを覚えたりそれらを効果的に使えるようになるためには、
より多くの時間が必要です。</p>
<p>SGML と DocBook を学ぶための最も良い方法は、
数多くの例のドキュメントのソースを読んで、
他の著者が同じ情報をどう書いているかを見ることです。</p></li>
<li><p>この方法に転向するのは簡単ではありません。</p></li>
</ul>
<h2>DocBook について何も知らないとしても、貢献できることがあるのでしょうか?</h2>
<p>はい。もちろんです。
どんなドキュメントであっても何もないよりは良いものです。
もしあなたが貢献すべきドキュメントを持っていて、
それが DocBook でマークアップされていないとしても、
何の問題もありません。</p>
<p>普通にそのドキュメントを <a href="submitting.html">提出してください</a>。
プロジェクトのほかの誰かがあなたの提出されたドキュメントを見つけると、
それにマークアップをして、そしてコミットしてくれます。
少々運がいいとそのときにあなたにマークアップされたテキストが戻ってきます。
それは役に立ちます。というのはあなたはドキュメントがマークアップされる
&quot;前と後の&quot; 状態を持っているということになり、
うまくいけばその過程からマークアップについていくらかでも学ぶことができるからです。</p>
<p>もちろん、
あなたの提出したドキュメントはマークアップしなければならないので、
数時間では済まず、数日に延びてしまうかもしれませんが、
いずれはコミットされることでしょう。</p>
<h2>SGML や DocBook に関する他の情報は?</h2>
<p>まず、<a
href="&base;/../doc/en_US.ISO8859-1/books/fdp-primer/index.html"><b>ドキュメンテーションプロジェクト入門</b></a>を読んでください。これは FreeBSD
ドキュメンテーションプロジェクトの作業をおこなうために知っておくべきすべてのことに関する包括的な説明をねらったものです。
これは長編のドキュメントで、
たくさんの小さなページに分割されています。また<a
href="&base;/../doc/en_US.ISO8859-1/books/fdp-primer/book.html"><b>
ひとつの大きなページ</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>
<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>
<dd><p>「やさしい SGML の紹介」です。初心者の見方から SGML
についてもっと学びたいという方にお勧めです。</p></dd>
<dt><a
href="http://www.oasis-open.org/docbook/"><b>http://www.oasis-open.org/docbook/</b></a></dt>
<dd><p>OASIS が DocBook DTD の保守をしています。
これらのページはすでに SGML について慣れているユーザや、
DocBook を学んでみたい方を目的としています。</p>
</dd>
</dl>
<p></p><a href="docproj.html">FreeBSD
ドキュメンテーションプロジェクトのページ</a>
</body>
</html>