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

Merge the following from the English version:

Browse source 
1.10 -> 1.14	fdp-primer/Makefile
  1.9  -> 1.25	fdp-primer/book.sgml
  1.19 -> 1.21	fdp-primer/overview/chapter.sgml
  1.10 -> 1.12	fdp-primer/see-also/chapter.sgml
  1.14 -> 1.15	fdp-primer/structure/chapter.sgml
  1.25 -> 1.28	fdp-primer/tools/chapter.sgml
  1.9  -> 1.38	fdp-primer/writing-style/chapter.sgml

Submitted by:	TAOKA Fumiyoshi <fmysh at iijmio-mail dot jp>
Reviewed by:	Ryusuke Suzuki <ryusuke at nucl dot sci dot hokudai dot ac dot jp>,
		Hiroo Ono <hiroo at oikumene dot gcd dot org>
Reference:	[doc-jp-work 862, 893, 913, 920, 922]
This commit is contained in:
Hideyuki KURASHINA 2004-10-27 20:25:04 +00:00
parent 8595a39c5e
commit a7cc90d656
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=22709
7 changed files with 238 additions and 102 deletions
ja_JP.eucJP/books/fdp-primer
Makefilebook.sgml
overview
chapter.sgml
see-also
chapter.sgml
structure
chapter.sgml
tools
chapter.sgml
writing-style
chapter.sgml

7
ja_JP.eucJP/books/fdp-primer/Makefile
View file

@ -3,10 +3,10 @@
#
# Build the FreeBSD Documentation Project Primer (Japanese).
#
# Original revision: 1.10
# Original revision: 1.14
#
MAINTAINER=
MAINTAINER= doc-jp@jp.FreeBSD.org
DOC?= book
@ -48,6 +48,7 @@ SRCS+= examples/appendix.sgml
# Entities
SRCS+= chapters.ent
DOC_PREFIX?= ${.CURDIR}/../../..
URL_RELPREFIX?= ../../../..
DOC_PREFIX?= ${.CURDIR}/../../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

89
ja_JP.eucJP/books/fdp-primer/book.sgml
View file

@ -29,15 +29,16 @@
The FreeBSD Japanese Documentation Project
Original revision: 1.9
Original revision: 1.25
$FreeBSD$
-->
<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V4.1-Based Extension//EN" [
<!ENTITY % books.ent PUBLIC "-//FreeBSD//ENTITIES DocBook FreeBSD Books Entity Set//EN">
%books.ent;
<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
<!ENTITY % not.published "INCLUDE">
<!-- ENTITY index SYSTEM "index.sgml" -->
]>
<!--
@ -49,61 +50,24 @@
<bookinfo>
<title>新しい貢献者のための FreeBSD ドキュメンテーションプロジェクト入門</title>
<author>
<firstname>Nik</firstname>
<surname>Clayton</surname>
<affiliation>
<address><email>nik@FreeBSD.org</email></address>
</affiliation>
</author>
<corpauthor>FreeBSD ドキュメンテーションプロジェクト</corpauthor>
<copyright>
<year>1998</year>
<year>1999</year>
<holder role="mailto:nik@FreeBSD.org">Nik Clayton</holder>
<year>2000</year>
<year>2001</year>
<year>2002</year>
<year>2003</year>
<year>2004</year>
<holder role="mailto:doceng@FreeBSD.org">DocEng</holder>
</copyright>
<pubdate role="rcs">$FreeBSD$</pubdate>
<releaseinfo>$FreeBSD$</releaseinfo>
<legalnotice>
<para>Redistribution and use in source (SGML DocBook) and 'compiled'
forms (SGML, HTML, PDF, PostScript, RTF and so forth) with or without
modification, are permitted provided that the following conditions are
met:</para>
<orderedlist>
<listitem>
<para>Redistributions of source code (SGML DocBook) must retain the
above copyright notice, this list of conditions and the following
disclaimer as the first lines of this file unmodified.</para>
</listitem>
<listitem>
<para>Redistributions in compiled form (transformed to other DTDs,
converted to PDF, PostScript, RTF and other formats) must
reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other
materials provided with the distribution.</para>
</listitem>
</orderedlist>
<important>
<para>THIS DOCUMENTATION IS PROVIDED BY NIK CLAYTON "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
DAMAGE.</para>
</important>
</legalnotice>
&bookinfo.legalnotice;
<abstract>
<para>FreeBSD
@ -121,10 +85,10 @@
</abstract>
</bookinfo>
<preface>
<preface id="preface">
<title>まえがき</title>
<sect1>
<sect1 id="preface-prompt">
<title>シェルプロンプト</title>
<para>以下の表は、
@ -159,7 +123,7 @@
</informaltable>
</sect1>
<sect1>
<sect1 id="preface-convention">
<title>表記上の慣例</title>
<para>下の表は、
@ -240,8 +204,8 @@ Password:</screen></entry>
</informaltable>
</sect1>
<sect1>
<title>Ãíµ­(notes)¡¢·Ù¹ð(warnings)¡¢Î㼨(examples)</title>
<sect1 id="preface-notes">
<title>注記、Tips、重要な情報、警告、例示</title>
<para>注記や警告、例示は本文中に書かれています。</para>
@ -252,6 +216,19 @@ Password:</screen></entry>
</para>
</note>
<tip>
<para>Tips はこのような感じで表示されます。
これには、読者の役に立つかもしれない情報や、
何かをするのにより易しい方法へと導いてくれるような手がかりが含まれています。
</para>
</tip>
<important>
<para>重要な情報はこのような感じで表示されます。
一般的には読者が追加して行わなければならない手順を示しています。
</para>
</important>
<warning>
<para>警告は、このような感じで表示されます。
これには、手順に従わない場合に何らかの損害を被る可能性があることを
@ -272,7 +249,7 @@ Password:</screen></entry>
</example>
</sect1>
<sect1>
<sect1 id="preface-acknowledgements">
<title>謝辞</title>
<para>Sue Blake, Patrick Durusau,
@ -290,12 +267,18 @@ Password:</screen></entry>
&chap.sgml-markup;
&chap.stylesheets;
&chap.structure;
&chap.doc-build;
&chap.the-website;
&chap.translations;
&chap.writing-style;
&chap.psgml-mode;
&chap.see-also;
&app.examples;
<!--
&index;
-->
</book>
<!--

4
ja_JP.eucJP/books/fdp-primer/overview/chapter.sgml
View file

@ -29,7 +29,7 @@
The FreeBSD Japanese Documentation Project
Original revision: 1.19
Original revision: 1.21
$FreeBSD$
-->
@ -139,7 +139,7 @@
<listitem>
<para>これは、World Wide Web において中心的な FreeBSD のサイトであり、
<ulink url="../../../../index.html">http://www.FreeBSD.org/</ulink>
<ulink url="&url.base;/index.html">http://www.FreeBSD.org/</ulink>
と、世界中に存在するたくさんのミラーサイトから見ることができます。
このウェブサイトは、多くの人々が FreeBSD
を初めて目にする場所でもあります。

4
ja_JP.eucJP/books/fdp-primer/see-also/chapter.sgml
View file

@ -30,7 +30,7 @@
The FreeBSD Japanese Documentation Project
Original revision: 1.10
Original revision: 1.12
$FreeBSD$
-->
@ -47,7 +47,7 @@
<itemizedlist>
<listitem>
<para><ulink url="../../../../docproj/index.html">FreeBSD
<para><ulink url="&url.base;/docproj/index.html">FreeBSD
ドキュメンテーションプロジェクトのウェブページ</ulink></para>
</listitem>

2
ja_JP.eucJP/books/fdp-primer/structure/chapter.sgml
View file

@ -30,7 +30,7 @@
The FreeBSD Japanese Documentation Project
Original revision: 1.14
Original revision: 1.15
$FreeBSD$
-->

27
ja_JP.eucJP/books/fdp-primer/tools/chapter.sgml
View file

@ -30,7 +30,7 @@
The FreeBSD Japanese Documentation Project
Original revision: 1.25
Original revision: 1.28
$FreeBSD$
-->
@ -57,7 +57,7 @@
<para><filename role="package">textproc/docproj</filename> の port
を使うとインストールする手間を大きく省くことができます。これは
<emphasis>メタ (meta) port</emphasis> と呼ばれる port で、
その中にソフトウェアが含むかわりに、他のさまざまな port
その中にソフトウェアを含むかわりに、他のさまざまな port
が正しくインストールされるように依存関係がつくられているものです。
この port をインストールすると、
この章であげられているソフトウェアが
@ -65,8 +65,8 @@
</para>
<para>必要となるパッケージの一つに、JadeTeX マクロセットというものがあります。
このマクロセットは、インストール時に TeX
がインストールされていることを必要とします。TeX
このマクロセットは、インストール時に &tex
がインストールされていることを必要とします。&tex
は非常に大きなパッケージですが、Postscript や PDF
形式の出力を行なわないならばインストールの必要はありません。
</para>
@ -75,13 +75,22 @@
この port をインストールする際に、JadeTeX (すなわち TeX を含む)
を必要とするかどうかを指定する必要があります。
次のいずれかを、場合に応じて実行して下さい。
</para>
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
<para>または</para>
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
<makevar>JADETEX=no</makevar> を指定してツールをインストールすると、
HTML や ACSII テキストだけを出力することができます。
PostScript や PDF を出力するには TeX が必要です。
<para>もしくは <filename role="package">textproc/docproj-jadetex</filename>
や <filename role="package">textproc/docproj-nojadetex</filename>
をインストールしてもよいでしょう。
これらのスレーブ ports は変数 <makevar>JADETEX</makevar> を定義し、
同じアプリケーション一式をマシンにインストールします。
<application>JadeTeX</application> をインストールしなければ、
HTML か ASCII テキストしか生成できないことに注意してください。
PostScript や PDF を出力するには <application>TeX</application> が必要です。
</para>
</tip>
@ -268,7 +277,7 @@
<varlistentry>
<term><application>Emacs</application> もしくは
<application>xemacs</application>
<application>XEmacs</application>
(<filename role="package">editors/emacs</filename> もしくは
<filename role="package">editors/xemacs</filename>)</term>
@ -288,7 +297,7 @@
</variablelist>
<para>もし、この他に SGML 文書を扱うために有用なソフトウェアをご存知でしたら、
&nik; までお知らせ下さい。
&a.doceng; までお知らせ下さい。
このリストに加えさせていただきます。
</para>
</sect2>

207
ja_JP.eucJP/books/fdp-primer/writing-style/chapter.sgml
View file

@ -30,7 +30,7 @@
The FreeBSD Japanese Documentation Project
Original revision: 1.9
Original revision: 1.38
$FreeBSD$
-->
@ -42,13 +42,25 @@
</para>
<variablelist>
<varlistentry>
<term>米国式の英語のつづりを用いる</term>
<listitem>
<para>英語には同じ単語に対して異なるつづりをする変種があります。
いろいろなつづりがある場合には、米国式を用いてください。
<quote>colour</quote> ではなく <quote>color</quote>,
<quote>rationalise</quote> ではなく <quote>rationalize</quote>
などです。</para>
</listitem>
</varlistentry>
<varlistentry>
<term>短縮形は使わない</term>
<listitem>
<para>短縮形は使わないでください。
スペルは常に完全な形で書き、
&ldquo;Don't use contractions&rdquo;
<quote>Don't use contractions</quote>
というような表現は使ってはいけません。
</para>
@ -65,7 +77,7 @@
<para>
段落のなかで項目を並べる場合には、
それぞれの項目をカンマを使って分けてください。
最後の項目では、カンマと &ldquo;and&rdquo; を使います。
最後の項目では、カンマと <quote>and</quote> を使います。
</para>
<para>たとえば、次の例を見てください。</para>
@ -74,10 +86,10 @@
<para>This is a list of one, two and three items.</para>
</blockquote>
<para>さて、これは三つの項目、&ldquo;one&rdquo;,
&ldquo;two&rdquo; および &ldquo;three&rdquo;
<para>さて、これは三つの項目、<quote>one</quote>,
<quote>two</quote> および <quote>three</quote>
を並べたものでしょうか?
それとも、二つの項目、&ldquo;one&rdquo; と &ldquo;two and three&rdquo;
それとも、二つの項目、<quote>one</quote> と <quote>two and three</quote>
を並べたものなのでしょうか?
</para>
@ -95,9 +107,9 @@
<listitem>
<para>冗長な表現を使わないよう配慮してください。具体的に言うと、
&ldquo;the command&rdquo;,
&ldquo;the file&rdquo;,
そして &ldquo;man command&rdquo;
<quote>the command</quote>,
<quote>the file</quote>,
そして <quote>man command</quote>
というような表現は、いずれも余計なものです。
</para>
@ -147,7 +159,7 @@
<listitem>
<para>文の最後には、常に二個分の空白を入れてください。
これは読みやすさを向上させるためと、
<application>emacs</application>
<application>Emacs</application>
のようなツールで扱いやすくするためです。
</para>
@ -165,10 +177,10 @@
</variablelist>
<para>文体についての詳細は、William Strunk 氏による <ulink
url="http://www.bartleby.com/141/index.html">Elements of
url="http://www.bartleby.com/141/">Elements of
Style</ulink> が参考になります。</para>
<sect1>
<sect1 id="writing-style-guide">
<title>スタイルガイド</title>
<para>ハンドブックはたくさんの人々によって編集されます。
@ -199,21 +211,21 @@
<sect2>
<title>字下げ</title>
<!-- hrs:2000/03/25 - what's "this one?" -->
<para>Each file starts with indentation set at column 0,
<emphasis>regardless</emphasis> of the indentation level of the file
which might contain this one.</para>
<para>それぞれのファイルの字下げは 0 桁目から始まります。
他のファイルに読み込まれる場合でも、
読み込む側のファイルの字下げの深さには<emphasis>よりません</emphasis>。
</para>
<para>開始タグでは必ず二個分の空白で字下げ幅を増やし、
同様に終了タグでは二個分の空白で字下げ幅を減らします。
エレメント中の内容が一行以上にわたる場合は、
さらに二個分の空白で字下げされていなければなりません。
<para>開始タグでは 2 個の空白で字下げ幅を増やし、
終了タグでは 2 個の空白で字下げ幅を減らします。
行頭の 8 つの空白のかたまりはタブへ置き換えられるべきです。
タブの前に空白を用いず、行末に余分な空白を加えないでください。
要素の中身が一行以上に渡るならば 2 個の空白で字下げしてください。
</para>
<para>たとえば、このセクションのソースはつぎのようになっています。</para>
<programlisting>
<![ CDATA [+--- This is column 0
<programlisting><![ CDATA [+--- This is column 0
V
<chapter>
<title>...</title>
@ -228,21 +240,29 @@ V
<emphasis>regardless</emphasis> of the indentation level of the file
which might contain this one.</para>
<para>Every start tag increases the indentation level by 2 spaces, and
every end tag decreases the indentation level by 2 spaces. Content
within elements should be indented by two spaces if the content runs
over more than one line.</para>
...
</sect2>
</sect1>
</chapter>]]></programlisting>
<para>ファイルの編集に <application>Emacs</application> か
<application>Xemacs</application> を使っている場合には
<application>XEmacs</application> を使っている場合には
<literal>sgml-mode</literal> が自動的にロードされますので、
各ファイルの最後に書かれた Emacs
各ファイルの最後に書かれた <application>Emacs</application>
のローカル変数によってこのスタイルが維持されます。</para>
<para><application>Vim</application>
ユーザは以下のようにエディタを設定すると良いでしょう。</para>
<programlisting>augroup sgmledit
autocmd FileType sgml set formatoptions=cq2l " Special formatting options
autocmd FileType sgml set textwidth=70 " Wrap lines at 70 spaces
autocmd FileType sgml set shiftwidth=2 " Automatically indent
autocmd FileType sgml set softtabstop=2 " Tab key indents 2 spaces
autocmd FileType sgml set tabstop=8 " Replace 8 spaces with a tab
autocmd FileType sgml set autoindent " Automatic indentation
saugroup END</programlisting>
</sect2>
<sect2>
@ -259,17 +279,17 @@ V
<informalexample>
<programlisting><![ CDATA [<article>
<artheader>
<articleinfo>
<title>NIS</title>
<pubdate>October 1999</pubdata>
<pubdate>October 1999</pubdate>
<abstract>
<para>...
...
...</para>
</abstract>
</artheader>
</articleinfo>
<sect1>
<title>...</title>
@ -341,6 +361,129 @@ V
翻訳チームは無視しても大丈夫です」ということを示すようにしてください。
</para>
</sect2>
<sect2>
<title>非改行空白</title>
<para>改行により醜くなったり、
読みづらくなるような場所では改行を避けてください。
改行は選択した出力媒体の幅に依存します。
特に、HTML 文書をテキストブラウザで閲覧すると
次の段落のように汚くフォーマットされることがあります。</para>
<literallayout class="monospaced">Data capacity ranges from 40 MB to 15
GB. Hardware compression &hellip;</literallayout>
<para>一般実体 <literal>&amp;nbsp;</literal> は、
これを挟む場所での改行を禁止します。
非改行空白は次の場所で使用してください。</para>
<itemizedlist>
<listitem>
<para>数値と単位の間:</para>
<programlisting><![ CDATA [57600&nbsp;bps]]></programlisting>
</listitem>
<listitem>
<para>プログラム名とバージョン番号の間:</para>
<programlisting><![ CDATA [FreeBSD&nbsp;4.7]]></programlisting>
</listitem>
<listitem>
<para>複数の単語から成る名前の間 (<quote>The FreeBSD Brazilian
Portuguese Documentation Project</quote> のような
3, 4 語以上の名前へ適用する場合には注意してください):</para>
<programlisting><![ CDATA [Sun&nbsp;Microsystems]]></programlisting>
</listitem>
</itemizedlist>
</sect2>
</sect1>
<sect1 id="writing-style-word-list">
<title>語句リスト</title>
<para>次は FreeBSD ドキュメンテーションプロジェクトで用いるべき
つづりを示した小さな語句リストです。
探している語句がこのリストに見つからなかったら、
<ulink
url="http://www.oreilly.com/oreilly/author/stylesheet.html">O'Reilly
word list</ulink> を参照してください。</para>
<itemizedlist>
<listitem>
<para>2.2.X</para>
</listitem>
<listitem>
<para>4.X-STABLE</para>
</listitem>
<listitem>
<para>CDROM</para>
</listitem>
<listitem>
<para>DoS <emphasis>(Denial of Service)</emphasis> </para>
</listitem>
<listitem>
<para>FreeBSD Ports Collection</para>
</listitem>
<listitem>
<para>IPsec</para>
</listitem>
<listitem>
<para>Internet</para>
</listitem>
<listitem>
<para>MHz</para>
</listitem>
<listitem>
<para>Soft Updates</para>
</listitem>
<listitem>
<para>Unix</para>
</listitem>
<listitem>
<para>disk label</para>
</listitem>
<listitem>
<para>email</para>
</listitem>
<listitem>
<para>file system</para>
</listitem>
<listitem>
<para>manual page(s)</para>
</listitem>
<listitem>
<para>mail server</para>
</listitem>
<listitem>
<para>name server</para>
</listitem>
<listitem>
<para>ports collection</para>
</listitem>
<listitem>
<para>web server</para>
</listitem>
</itemizedlist>
</sect1>
</chapter>