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

Add new translations (but not activated yet):

Browse source 
Makefile
	book.sgml
	chapter.decl
	chapters.ent
	overview/chapter.sgml
	psgml-mode/chapter.sgml
	see-also/chapter.sgml
	structure/chapter.sgml
	stylesheets/chapter.sgml
	tools/chapter.sgml
	writing-style/chapter.sgml

Submitted by:	Kenji Sato <ken@ny.kdd.com>, hrs
This commit is contained in:
Hiroki Sato 2001-03-07 19:40:56 +00:00
parent 2013a0f44e
commit fe0863579b
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=8901
11 changed files with 1987 additions and 0 deletions
ja_JP.eucJP/books/fdp-primer
Makefilebook.sgmlchapter.declchapters.ent
overview
chapter.sgml
psgml-mode
chapter.sgml
see-also
chapter.sgml
structure
chapter.sgml
stylesheets
chapter.sgml
tools
chapter.sgml
writing-style
chapter.sgml

55
ja_JP.eucJP/books/fdp-primer/Makefile Normal file
View file

@ -0,0 +1,55 @@
#
# $FreeBSD$
#
# Build the FreeBSD Documentation Project Primer (Japanese).
#
# Original revision: 1.10
#
MAINTAINER=
DOC?= book
FORMATS?= html-split html
INSTALL_COMPRESSED?= gz
INSTALL_ONLY_COMPRESSED?=
NO_TIDY= YES
#
# SRCS lists the individual SGML files that make up the document. Changes
# to any of these files will force a rebuild
#
# SGML content
SRCS= book.sgml
SRCS+= overview/chapter.sgml
SRCS+= psgml-mode/chapter.sgml
SRCS+= see-also/chapter.sgml
SRCS+= sgml-markup/chapter.sgml
SRCS+= sgml-primer/chapter.sgml
SRCS+= stylesheets/chapter.sgml
SRCS+= structure/chapter.sgml
SRCS+= doc-build/chapter.sgml
SRCS+= the-website/chapter.sgml
SRCS+= tools/chapter.sgml
SRCS+= translations/chapter.sgml
SRCS+= writing-style/chapter.sgml
SRCS+= examples/appendix.sgml
# Images from the cross-document image library
#IMAGES_LIB= callouts/1.png
#IMAGES_LIB+= callouts/2.png
#IMAGES_LIB+= callouts/3.png
#IMAGES_LIB+= callouts/4.png
#IMAGES_LIB+= callouts/5.png
# Entities
SRCS+= chapters.ent
DOC_PREFIX?= ${.CURDIR}/../../..
.include "${DOC_PREFIX}/share/mk/doc.project.mk"

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

@ -0,0 +1,308 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.9
$FreeBSD$
-->
<!DOCTYPE book PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN" [
<!ENTITY % man PUBLIC "-//FreeBSD//ENTITIES DocBook Manual Page Entities//EN">
%man;
<!ENTITY % chapters SYSTEM "chapters.ent"> %chapters;
]>
<!--
訳:
さとけん@ForUs ken@forus.or.jp
-->
<book>
<bookinfo>
<title>新しい貢献者のための FreeBSD ドキュメンテーションプロジェクト入門</title>
<author>
<firstname>Nik</firstname>
<surname>Clayton</surname>
<affiliation>
<address><email>nik@FreeBSD.org</email></address>
</affiliation>
</author>
<copyright>
<year>1998</year>
<year>1999</year>
<holder role="mailto:nik@FreeBSD.org">Nik Clayton</holder>
</copyright>
<pubdate role="rcs">$FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/book.sgml,v 1.9 1999/09/06 07:22:25 peter Exp $</pubdate>
<releaseinfo>$FreeBSD: doc/en_US.ISO_8859-1/books/fdp-primer/book.sgml,v 1.9 1999/09/06 07:22:25 peter Exp $</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>
<abstract>
<para>FreeBSD
ドキュメンテーションプロジェクトに参加してくださってありがとうございます.
あなたの貢献は非常に価値のあることです.</para>
<para>この入門では FreeBSD
ドキュメンテーションプロジェクトへの貢献を始めるにあたって理解する必要のあること,
すなわち(必須のものだけでなく, 推奨されるものも含めた)ツールやソフトウェアの使い方から,
ドキュメンテーションプロジェクトの方針にわたる内容のすべてを扱っています.</para>
<para>この文書は発展途上にあり, まだ完成していません.
まだ完成していない節の名前には
<literal>*</literal>(アスタリスク) が付けてあります.</para>
</abstract>
</bookinfo>
<preface>
<title>まえがき</title>
<sect1>
<title>シェルプロンプト</title>
<para>以下の表は,
標準のシステムプロンプトとスーパーユーザのプロンプト示しています.
この文書であげる実例では,
どちらのユーザでその例を実行すべきか示すためにこれらのプロンプトを使用します.</para>
<informaltable frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>ユーザ</entry>
<entry>プロンプト</entry>
</row>
</thead>
<tbody>
<row>
<entry>通常ユーザ</entry>
<entry>&prompt.user;</entry>
</row>
<row>
<entry><username>root</username></entry>
<entry>&prompt.root;</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect1>
<sect1>
<title>表記上の慣例</title>
<para>下の表は,
この文書で使われる表記上の慣例を示しています.</para>
<informaltable frame="none">
<tgroup cols="2">
<thead>
<row>
<entry>意味</entry>
<entry>例</entry>
</row>
</thead>
<tbody>
<row>
<entry>コマンド, ファイル, ディレクトリの名前および,
コンピュータ画面への出力</entry>
<entry><para>あなたの
<filename>.login</filename> ファイルを編集してください.
</para><para>ファイルの一覧を表示するには
<command>ls -a</command> を使います.
</para><para><screen>You have mail.</screen></para></entry>
</row>
<row>
<entry>コンピュータの画面に表示されるものと,
あなたが入力するものを区別する場合</entry>
<entry><screen>&prompt.user; <userinput>su</userinput>
Password:</screen></entry>
</row>
<row>
<entry>マニュアルページの参照</entry>
<entry>ユーザ名を変更するには
<citerefentry>
<refentrytitle>su</refentrytitle>
<manvolnum>1</manvolnum>
</citerefentry>
を使います.</entry>
</row>
<row>
<entry>ユーザ名とグループ名</entry>
<entry>これが行なえるのは
<username>root</username> だけです.</entry>
</row>
<row>
<entry>強調部分</entry>
<entry>必ずこれを行なわなければ<emphasis>いけません</emphasis>.</entry>
</row>
<row>
<entry>コマンドラインに書かれる引数.
これは実際にあるファイル名や変数名などに置き換えられます.
</entry>
<entry>ファイルを消去するには,
<command>rm <filename><replaceable>ファイル名</replaceable></filename></command>
と入力します.</entry>
</row>
<row>
<entry>環境変数</entry>
<entry><envar>$HOME</envar>は,
あなたのホームディレクトリです.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</sect1>
<sect1>
<title>注記(notes), 警告(warnings), 例示(examples)</title>
<para>注記や警告, 例示は本文中に書かれています.</para>
<note>
<para>注記はこのような感じで表示されます.
これには, 読者が行なう操作に関連して
注意しなければならないことを伝えるための内容が含まれています.
</para>
</note>
<warning>
<para>警告は, このような感じで表示されます.
これには, 手順に従わない場合に何らかの損害を被る可能性があることを
伝える内容が含まれています.
その損害はハードウェアや操作者に対する物理的なものかも知れませんし,
不注意で重要なファイルが削除されてしまうような非物理的なものかも知れません.
</para>
</warning>
<example>
<title>例示のサンプル</title>
<para>例示は, このような感じで表示されます.
これには通常, 読者自身が試す必要のある例や,
ある操作がどのような結果をもたらすのか,
読者に示すための例が含まれています.
</para>
</example>
</sect1>
<sect1>
<title>謝辞</title>
<para>Sue Blake, Patrick Durusau,
Jon Hamilton, Peter Flynn,
Christopher Maden
はこの文書の初稿を読む時間を割いて,
たくさんの有益なコメントや批評を送ってくれました.
ここに感謝の意を表します.</para>
</sect1>
</preface>
&chap.overview;
&chap.tools;
&chap.sgml-primer;
&chap.sgml-markup;
&chap.stylesheets;
&chap.structure;
&chap.the-website;
&chap.translations;
&chap.writing-style;
&chap.psgml-mode;
&chap.see-also;
</book>
<!--
Local Variables:
mode: sgml
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
End:
-->

1
ja_JP.eucJP/books/fdp-primer/chapter.decl Normal file
View file

@ -0,0 +1 @@
<!DOCTYPE chapter PUBLIC "-//FreeBSD//DTD DocBook V3.1-Based Extension//EN">

26
ja_JP.eucJP/books/fdp-primer/chapters.ent Normal file
View file

@ -0,0 +1,26 @@
<!--
The FreeBSD Documentation Project
The FreeBSD Japanese Documentation Project
Original revision: 1.4
$FreeBSD$
Creates entities for each chapter in the Documentation Project Primer.
Each entity is named chap.foo, where foo is the value of the id
attribute on that chapter, and corresponds to the name of the
directory in which that chapter's .sgml file is stored.
Chapters should be listed in the order in which they are referenced.
-->
<!ENTITY chap.overview SYSTEM "overview/chapter.sgml">
<!ENTITY chap.sgml-primer SYSTEM "sgml-primer/chapter.sgml">
<!ENTITY chap.tools SYSTEM "tools/chapter.sgml">
<!ENTITY chap.sgml-markup SYSTEM "sgml-markup/chapter.sgml">
<!ENTITY chap.stylesheets SYSTEM "stylesheets/chapter.sgml">
<!ENTITY chap.structure SYSTEM "structure/chapter.sgml">
<!ENTITY chap.the-website SYSTEM "the-website/chapter.sgml">
<!ENTITY chap.translations SYSTEM "translations/chapter.sgml">
<!ENTITY chap.writing-style SYSTEM "writing-style/chapter.sgml">
<!ENTITY chap.psgml-mode SYSTEM "psgml-mode/chapter.sgml">
<!ENTITY chap.see-also SYSTEM "see-also/chapter.sgml">

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

@ -0,0 +1,204 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.4
$FreeBSD$
-->
<chapter id="overview">
<title>概要</title>
<para>FreeBSD ドキュメンテーションプロジェクトへようこそ.
質の高い文書は, FreeBSD
を成功させるために欠かすことができない重要なものです. FreeBSD
ドキュメンテーションプロジェクト(FreeBSD Documentation Project;
FDP)は, そのような文書を数多く作成するためのプロジェクトです.
あなたの貢献は, 非常に貴重です.
</para>
<para>この文書は主に <emphasis>FDP の構成</emphasis>,
<emphasis>文書の作成と FDP への提出方法</emphasis>および,
<emphasis>文書作成のために利用できるツールの効果的な利用法</emphasis>
について解説することを目的としています.
</para>
<para>FDP は, どなたでも参加できます. 参加資格はありませんし,
毎月, 文書の作成が義務づけられているわけでもありません.
あなたがしなければならないのは, ただ
<email>freebsd-doc@FreeBSD.org</email>
メーリングリストに参加することだけです.
</para>
<para>この文書を読み終えた後,
あなたは次のようになっていなければなりません. </para>
<itemizedlist>
<listitem>
<para>どれが FDP が管理する文書はなのか理解して下さい. </para>
</listitem>
<listitem>
<para>FDP の管理する文書の SGML のソースコードを読み,
意味が理解できるようになってください.
</para>
</listitem>
<listitem>
<para>文書へ変更を加える操作ができるようになってください. </para>
</listitem>
<listitem>
<para>あなたの変更が査読を受け, FreeBSD
の文書として採用にまわせるよう, 変更の提出ができるようになってください.
</para>
</listitem>
</itemizedlist>
<sect1>
<title>FreeBSD 文書セット</title>
<para>FDP では FreeBSD 関連文書のうち, 次の
4 つのカテゴリを担当しています.
</para>
<variablelist>
<varlistentry>
<term>マニュアルページ</term>
<listitem>
<para>システムの英語版マニュアルページは基本システムの一部であり,
FDP がその作成を担当しているわけではありません.
しかし FDP は, マニュアルページをよりわかりやすくしたり,
不正確な記述を修正するため, 既存のマニュアルページの改編を行なうことが
できます.
</para>
<para>翻訳チームは, システムのマニュアルページを他言語に翻訳する
作業を担当しています. この翻訳作業は, FDP の担当範囲内です.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>FAQ</term>
<listitem>
<para>FAQ は, FreeBSD
に関連するさまざまなメーリングリストやニュースグループで
よく尋ねられる質問, あるいは質問されるべきものについて,
(短い質疑応答形式で)取り扱ったものです.
この形式では, 必要以上に長く細かい回答は許されません.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ハンドブック</term>
<listitem>
<para>ハンドブックは広範囲の話題を扱った FreeBSD のユーザのための
オンライン情報源, およびリファレンスとなることを意図したものです.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ウェブサイト</term>
<listitem>
<para>これは, World Wide Web において中心的な FreeBSD のサイトであり,
<ulink url="http://www.FreeBSD.org/">http://www.FreeBSD.org/</ulink>
と, 世界中に存在するたくさんのミラーサイトから見ることができます.
このウェブサイトは, 多くの人々が FreeBSD
を初めて目にする場所でもあります.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>この 4 種類の文書は, いずれも FreeBSD CVS ツリーから入手することができます.
そのため, ログとファイルへの変更は一般に公開されていて,
<application>CVSup</application> や
<application>CTM</application> といったプログラムを使い
誰でも文書のローカルコピーを最新のものに保つことができます.
</para>
<para>さらに, たくさんの人々がチュートリアルや FreeBSD
関連のウェブサイトをつくっています. それらのなかには,
他の文書と同じように CVS リポジトリ(の原作者が同意した場所)に
含まれているものもある一方, FreeBSD のリポジトリからは分離して,
原作者の手によって直接保守されているものもあります.
FDP では, そのような文書に対して可能な限り,
リンクを提供するように努力しています.
</para>
</sect1>
<sect1>
<title>はじめる前に</title>
<para>この文書は, 次にあげる内容について
あなたがすでに理解していることを前提として書かれています.
</para>
<itemizedlist>
<listitem>
<para>FreeBSD の文書のローカルコピーを入手し, 最新に維持する方法について.
これには, FreeBSD CVS リポジトリのローカルコピーを
(<application>CVS</application>, もしくは
<application>CVSup</application> か
<application>CTM</application> を使って)維持するか, もしくは
<application>CVSup</application> を使って
<emphasis>チェックアウトした(checked-out)</emphasis>コピーを
ダウンロードするという方法があります.
</para>
</listitem>
<listitem>
<para>FreeBSD Ports システム, もしくは &man.pkg.add.1
を利用して新しいソフトウェアをダウンロードし, インストールする方法について.
</para>
</listitem>
</itemizedlist>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->

166
ja_JP.eucJP/books/fdp-primer/psgml-mode/chapter.sgml Normal file
View file

@ -0,0 +1,166 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.3
$FreeBSD$
-->
<chapter id="psgml-mode">
<title><application>Emacs</application> で
<literal>sgml-mode</literal> を利用する</title>
<para>新しいバージョンの Emacs や Xemacs(Ports Collection にあります)には,
PSGML と呼ばれる非常に便利なパッケージが附属しています.
これは拡張子が <filename>.sgml</filename> のファイルが読み込まれるか,
<command>M-x sgml-mode</command> と入力することで呼び出されます.
PSGML は, SGML ファイルやエレメント, 属性を扱うためのメジャーモードです.
</para>
<para>このモードで提供されているいくつかのコマンドを知っていれば,
ハンドブックなどの SGML 文書をより簡単に扱うことができるようになります.
</para>
<variablelist>
<varlistentry>
<term><command>C-c C-e</command></term>
<listitem>
<para><literal>sgml-insert-element</literal> を実行します.
実行すると, 現在のカーソル位置に挿入すべきエレメント名が聞かれ,
TAB キーを使うことでエレメント名の補完ができます. また,
カーソル位置に挿入できないエレメント名は入力できないようになっています.
</para>
<para>挿入は, 指定したエレメントのスタートタグとエンドタグが両方行なわれます.
もし, そのエレメントが他の必須エレメントを含む場合は,
その必須エレメントも同じように挿入されます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>C-c =</command></term>
<listitem>
<para><literal>sgml-change-element-name</literal> を実行します.
カーソルをエレメントの内側に移動させてこのコマンドを実行して下さい.
変更するエレメント名が聞かれ, 現在のエレメントのスタートタグとエンドタグが
入力した新しいエレメントのものに変更されます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>C-c C-r</command></term>
<listitem>
<para><literal>sgml-tag-region</literal> を実行します.
テキストを指定(テキストの開始点に移動して C-Space を押し,
終了点に移動して C-Space を押す)してから, このコマンドを実行して下さい.
利用するエレメント名が聞かれ,
マークが付けられた範囲(リージョン)のすぐ前後に指定したエレメントが挿入されます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>C-c -</command></term>
<listitem>
<para><literal>sgml-untag-element</literal> を実行します.
カーソルを削除したいエレメントのスタートタグか, エンドタグの上において
このコマンドを実行して下さい. すると, エレメントのスタートタグ,
エンドタグが両方とも削除されます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>C-c C-q</command></term>
<listitem>
<para><literal>sgml-fill-element</literal> を実行します.
実行すると, カーソル位置のエレメントの内容に対して,
(整形する時のように)再帰的な文章の詰めが行なわれます.
この詰め作業は, 含まれている空白文字が重要なもの, たとえば
<sgmltag>programlisting</sgmltag>
エレメントの中などでも<emphasis>効果があります</emphasis>ので,
利用の際は注意して下さい.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>C-c C-a</command></term>
<listitem>
<para><literal>sgml-edit-attributes</literal> を実行します.
実行するともう一つバッファを開き,
最も近い閉じたエレメントのすべての属性のリストと, 現在の値を表示します.
TAB を使って属性間を移動することができ, <command>C-k</command> を
押すことで, 既存の値を新しいものに置き換えることができます.
また, <command>C-c</command> を押すことで, バッファを閉じて
元の文書に戻ることができます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><command>C-c C-v</command></term>
<listitem>
<para><literal>sgml-validate</literal> を実行します.
実行すると(必要に応じて)現在編集中の文書をセーブするかどうか聞かれ,
次に SGML の正当性検査が行なわれます.
検査の出力は新しいバッファに表示されますので,
誤りのある部分へひとつひとつ移動してマークアップのミスを修正することができます.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>もちろん, このモードには他にも有用な機能があります.
ここにあげたのは, その中でもわたしが非常に頻繁に利用しているものです.
</para>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->

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

@ -0,0 +1,123 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.4
$FreeBSD$
-->
<chapter id="see-also">
<title>参考サイト</title>
<para>この文書は, SGML や DTD, FreeBSD ドキュメンテーションプロジェクトに関して,
すべてを網羅したものではありません. さらに詳しい内容については,
以下のウェブサイトをご覧になることをおすすめします.
</para>
<sect1>
<title>FreeBSD ドキュメンテーションプロジェクト</title>
<itemizedlist>
<listitem>
<para><ulink url="http://www.FreeBSD.org/docproj/">FreeBSD
ドキュメンテーションプロジェクトのウェブページ</ulink></para>
</listitem>
<listitem>
<para><ulink url="http://www.FreeBSD.org/handbook/">FreeBSD ハンドブック(英語版)</ulink></para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>SGML</title>
<itemizedlist>
<listitem>
<para><ulink url="http://www.oasis-open.org/cover/">SGML/XML ウェブページ</ulink>.
これは広範囲にわたる網羅的な SGML の情報源です. </para>
</listitem>
<listitem>
<para><ulink
url='http://etext.virginia.edu/bin/tei-tocs?div=DIV1&amp;id=SG">http://etext.virginia.edu/bin/tei-tocs?div=DIV1&amp;id=SG'>やさしい SGML 入門</ulink></para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>HTML</title>
<itemizedlist>
<listitem>
<para><ulink url="http://www.w3.org/">World Wide Web コンソーシアム</ulink></para>
</listitem>
<listitem>
<para><ulink url="http://www.w3.org/TR/REC-html40/">HTML 4.0 規格書</ulink></para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>DocBook</title>
<itemizedlist>
<listitem>
<para><ulink url="http://www.oreilly.com/davenport/">The Davenport
Group</ulink>. ここは DocBook DTD の保守を行なっているところです. </para>
</listitem>
</itemizedlist>
</sect1>
<sect1>
<title>Linux ドキュメンテーションプロジェクト</title>
<itemizedlist>
<listitem>
<para><ulink url="http://metalab.unc.edu/LDP/">Linux
ドキュメンテーションプロジェクトのウェブページ</ulink></para>
</listitem>
</itemizedlist>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->

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

@ -0,0 +1,322 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.2
$FreeBSD$
-->
<chapter id="structure">
<title><filename>doc/</filename> 以下に構成されている文書</title>
<para><filename>doc/</filename> ソースツリーは, ある一貫した方針で構成されています.
また, そのうち FDP が管理する文書は, さらに別の方針で構成されています.
これは新しい文書をソースツリーに追加する作業の単純化に加え, </para>
<orderedlist>
<listitem>
<para>文書を他の形式への変換を自動化しやすくすること</para>
</listitem>
<listitem>
<para>他の異なる文書構成との間の一貫性を維持し,
相互に作業しやすくすること
</para>
</listitem>
<listitem>
<para>ソースツリー上で新しい文書を導入する場所の決定を簡単に行なえるようにすること</para>
</listitem>
</orderedlist>
<para>を目的としています.
さらに文書のソースツリーは, さまざまな異なる言語や
文字エンコーディングに対応できなければなりません.
文書ツリーの構造が特定の慣習や文化背景を強制するものであっては
ならないという点は重要です. </para>
<sect1>
<title>ソースツリーの最上位 <filename>doc/</filename></title>
<para><filename>doc/</filename> の下には二種類のディレクトリがあり,
各ディレクトリはそれぞれ, 特別な名前と意味を持っています. </para>
<segmentedlist>
<seglistitem>
<seg><filename>share/</filename></seg>
<seg>このディレクトリには, 文書の翻訳やエンコーディングに依存しないファイルが収められ,
その分類のためのサブディレクトリがつくられています.
たとえば, &man.make.1; で使用されるファイルは <filename>share/mk</filename>
に, (FreeBSD で拡張された DocBook DTD などの) SGML 関連のファイルは
<filename>share/sgml</filename> におかれています. </seg>
</seglistitem>
<seglistitem>
<seg><filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename></seg>
<seg>各々の文書の翻訳, エンコーディングに対して,
それに対応する一つのディレクトリがあります.
具体的には, <filename>en_US.ISO_8859-1/</filename> や
<filename>zh_TW.Big5/</filename> というディレクトリです.
ディレクトリ名が長いのですが, 言語とエンコーディングを完全に記述することで,
翻訳チームが将来的に, 同一の言語で異なるエンコーディングの
文書を提供する際に発生する問題を回避することができます.
また, Unicode に移行するとしても, この方法ならば問題はまったくありません. </seg>
</seglistitem>
</segmentedlist>
</sect1>
<sect1>
<title>
<filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable>/</filename>
ディレクトリ群</title>
<para>これらのディレクトリには, 文書そのものがおかれています.
文書はこのディレクトリからさらに,
それぞれ異なるディレクトリ名で示される三種類に分類されます. </para>
<segmentedlist>
<seglistitem>
<seg><filename>articles</filename></seg>
<seg>DocBook の <sgmltag>article</sgmltag>(もしくはそれと同等なもの)
でマークアップされた文書です.
文書は短めのもので, 構成単位は節(section)となっています.
通常, 一つの HTML ファイルとして生成されます. </seg>
</seglistitem>
<seglistitem>
<seg><filename>books</filename></seg>
<seg>DocBook の <sgmltag>book</sgmltag>(もしくはそれと同等なもの)
でマークアップされた文書です. 文書は比較的長めで,
構成単位は章(chapter)となっています. 通常,
(高速なネットワーク接続を持っている人や,
ブラウザからの印刷に便利なよう)大きな単一の HTML ファイルと,
リンクされた小さな HTML ファイルの両方が生成されます. </seg>
</seglistitem>
<seglistitem>
<seg><filename>man</filename></seg>
<seg>システムのマニュアルページの翻訳をおくためのディレクトリです.
このディレクトリには, さらに <filename>man<replaceable>n</replaceable></filename> という,
翻訳されたマニュアルのセクションに対応する複数のディレクトリがあります. </seg>
</seglistitem>
</segmentedlist>
<para>
ここで説明したディレクトリすべてが, 必ずそれぞれの
<filename><replaceable>lang</replaceable>.<replaceable>encoding</replaceable></filename>
ディレクトリにあるというわけではありません.
どのディレクトリが存在するかについては, 翻訳チームがどれだけ翻訳を完了しているかに依存します.
</para>
</sect1>
<sect1>
<title>特定の文書に関する情報</title>
<para>このセクションでは, FDP
が管理する特定の文書に関する注意点が書かれています.
</para>
<sect2>
<title>ハンドブック</title>
<subtitle><filename>books/handbook/</filename></subtitle>
<para>ハンドブックは, FreeBSD
によって拡張された DocBook DTD で書かれています.
</para>
<para>ハンドブックは, DocBook の <sgmltag>book</sgmltag>
によって構成されています.
そしてそれは複数の <sgmltag>part</sgmltag> に分割され,
<sgmltag>part</sgmltag> はいくつかの <sgmltag>chapter</sgmltag>
を含みます. <sgmltag>chapter</sgmltag> は
さらにセクション(<sgmltag>sect1</sgmltag>), サブセクション
(<sgmltag>sect2</sgmltag>, <sgmltag>sect3</sgmltag>)
などに分割されています.
</para>
<sect3>
<title>物理的な構成</title>
<para><filename>handbook</filename> ディレクトリには,
数多くのファイルとディレクトリがおかれています. </para>
<note>
<para>ハンドブックの構成は, 時より変更されますので,
この文書では,
構成変更の細かな部分の記述が古くなってしまっているかも知れません.
ハンドブックの構成について疑問点がありましたら,
FreeBSD ドキュメンテーションプロジェクト
<email>freebsd-doc@FreeBSD.org</email> まで連絡下さい.
</para>
</note>
<sect4>
<title><filename>Makefile</filename></title>
<para><filename>Makefile</filename> は, SGML
ソースを他の形式に変換する方法を決めたり,
ハンドブックを構築する各種ソースファイルを列挙する
さまざまな変数を定義するものです.
このファイルは, 文書形式の変換を扱うためのコードを取り込むために
標準の <filename>doc.project.mk</filename> をインクルードします.
</para>
</sect4>
<sect4>
<title><filename>book.sgml</filename></title>
<para>これはハンドブックの構造において最上位にあたる文書です.
ハンドブックの <link
linkend="sgml-primer-doctype-declaration">DOCTYPE
宣言</link>とハンドブックの構成を記述するためのエレメントが含まれています.
</para>
<para><filename>book.sgml</filename> は,
<filename>.ent</filename>
という拡張子のついたファイルをロードするために<link
linkend="sgml-primer-parameter-entities">パラメータ実体(parameter
entities)</link>を使います. (後述する)これらのファイルには,
ハンドブックの他の部分で共通して使われる<link
linkend="sgml-primer-general-entities">一般実体(general
entities)</link>
が定義されています. </para>
</sect4>
<sect4>
<title><filename><replaceable>directory</replaceable>/chapter.sgml</filename></title>
<para>ハンドブックの各章は, 互いに個別に分けられたディレクトリに
<filename>chapter.sgml</filename> というファイルとして格納されています.
それぞれのディレクトリには, <sgmltag>chapter</sgmltag> エレメントの
<literal>id</literal> 属性の値と同じ名前が付けられています.
</para>
<para>たとえば, ある章のファイルが</para>
<programlisting><![ CDATA [
<chapter id="kernelconfiguration">
...
</chapter>]]></programlisting>
<para>のようになっていたとすれば, それは
<filename>kernelconfiguration</filename> という
ディレクトリ中の <filename>chapter.sgml</filename>
というファイルです. 通常,
その章の内容はすべてこのファイルに書かれています. </para>
<para>HTML 版のハンドブックを構築する時, この章は
<filename>kernelconfiguration.html</filename>
というファイル名として生成されます. これは
<literal>id</literal> の値に関係するもので,
ディレクトリ名との関連はありません. </para>
<para>ハンドブックの以前の版では, 文書のファイルは
<filename>book.sgml</filename> と同じディレクトリにおかれていて,
ファイル名は <sgmltag>chapter</sgmltag> エレメントの
<literal>id</literal> 属性の値になっていました.
これを個別のディレクトリに分けて移動させたのはハンドブックの
将来的な計画の準備のためです. 具体的には, こうすることで,
特に変更することなく各章に画像を追加することが可能になります.
また, それぞれの画像ファイルを章のテキストファイルと同じディレクトリに
おくことは, 大きな一つのディレクトリにすべてのテキストファイルと
画像ファイルをおいて管理しようとするより分かりやすくなります.
名前空間の衝突が発生したとしても,
格納ファイルの少ないディレクトリで作業する方が,
数多くのファイルがディレクトリにある場合よりも対処しやすくなるでしょう. </para>
<para>ここまでを簡単にまとめると,
個々に <filename>chapter.sgml</filename>
というファイルを含むディレクトリがたくさんあり, それらは
<filename>basics/chapter.sgml</filename>,
<filename>introduction/chapter.sgml</filename>,
<filename>printing/chapter.sgml</filename>
などという名前になっているということです. </para>
<important>
<para>章とディレクトリは,
ハンドブックの並び順を反映した方法で名付けられるべきではありません.
順番はハンドブックの改訂の際に変更される可能性があります.
(章全体が階層構造の中で上下に移動するような場合でなければ)
こういった改訂が行なわれる場合にファイル名を変更する必要性が
(なるべく) 生じないようにするべきです.
</para>
</important>
<para>各々の <filename>chapter.sgml</filename> ファイルは,
完全な SGML 文書ではありません. 詳しく言えば,
それらのファイルの先頭には DOCTYPE 宣言の行が書かれていません.
</para>
<para>これには, 二つの欠点があります. </para>
<itemizedlist>
<listitem>
<para>これらのファイルは一般的な SGML
ファイルとして扱うことができないため,
HTML, RTF, PS などの形式に変換するのに,
ハンドブック全体の生成に用いている方法と同じ方法を単純に用いることができません.
そのため, ただ一つの章だけを変更し, その結果を確認しようという場合には,
毎回ハンドブック全体を<emphasis>構築し直さなければならない</emphasis>ことになります.
</para>
</listitem>
<listitem>
<para>Emacs の <literal>sgml-mode</literal> を使う場合,
文書が利用している DTD を認識できないために
<literal>sgml-mode</literal>
の便利な機能(エレメントの補完入力,
自動チェック機能など)が利用できなくなります.
</para>
</listitem>
</itemizedlist>
</sect4>
</sect3>
</sect2>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->

89
ja_JP.eucJP/books/fdp-primer/stylesheets/chapter.sgml Normal file
View file

@ -0,0 +1,89 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.4
$FreeBSD$
-->
<chapter id="stylesheets">
<title>* スタイルシート</title>
<para>SGML は, 文書が利用者にどのように表示されるかということや,
紙の上にどう配置されるかということについては何も定義していません.
それらを行なうためにスタイルシートを記述するさまざまな言語が開発されています.
その言語には, DynaText, Panorama, SPICE, JSSS, FOSI, CSS, DSSSL
などがあります.
</para>
<para>わたしたちは, DocBook 文書用として DSSSL で書かれたスタイルシートを,
HTML 文書用として CSS を利用しています. </para>
<sect1>
<title>* DSSSL</title>
<para>ドキュメンテーションプロジェクトでは,
Norm Walsh 氏による Modular DocBook Stylesheets
を少しカスタマイズしたものを使っています. </para>
<para>このスタイルシートは,
<filename>textproc/dsssl-docbook-modular</filename>
から入手できます. </para>
<para>変更が加えられたスタイルシートは, ports システムに含まれていません.
それらはドキュメンテーションプロジェクトのソースリポジトリの一部であり,
<filename>doc/share/sgml/freebsd.dsl</filename> におかれています.
変更が加えられたスタイルシートには詳細なコメントが付けられていますので,
この章が完成するまで, 標準のスタイルシートにあるオプションが
どういった風に FreeBSD ドキュメンテーションプロジェクト用に
カスタマイズされているのか, このファイルを見て調べてみてください.
このファイルには FreeBSD 独自のエレメントを組版するために
スタイルシートを適用するエレメントを追加する方法の例も含まれています.
</para>
</sect1>
<sect1>
<title>* CSS</title>
<para></para>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->

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

@ -0,0 +1,306 @@
<!-- Copyright (c) 1998, 1999 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.7
$FreeBSD$
-->
<chapter id="tools">
<title>ツール</title>
<para>FDP では FreeBSD の文書を管理したり,
他の出力形式にに整形したりするため, さまざまなソフトウェアツールを利用します.
FreeBSD の文書で作業するには, あなた自身がそれらのツールを使う必要があります.
</para>
<para>これらのツールはすべて FreeBSD の port や package として入手可能で,
インストール作業は非常に簡単です.
</para>
<para>以下の章に書かれた例を試すには, あらかじめ
これらのツールがインストールされていなければなりません.
各ツールの実際の利用方法は, その例が書かれた章で説明されています.
</para>
<important>
<title>できるだけ <filename>textproc/docproj</filename> を利用してください</title>
<para><filename>textproc/docproj</filename> の port
を使うとインストールする手間を大きく省くことができます. これは
<emphasis>メタ(meta) port</emphasis> と呼ばれる port で,
その中にソフトウェアが含むかわりに, 他のさまざまな port
が正しくインストールされるように依存関係がつくられているものです.
この port をインストールすると,
この章であげられているソフトウェアのうち,
あなたのシステムにインストールされていないものが
自動的に<emphasis>すべてダウンロードされ, インストールされます</emphasis>.
</para>
<para>必要となるパッケージの一つに, JadeTeX マクロセットというものがあります.
このマクロセットは, インストール時に TeX
がインストールされていることを必要とします. TeX
は非常に大きなパッケージですが, Postscript や PDF
形式の出力を行なわないならばインストールの必要はありません.
</para>
<para>時間とディスクスペースの節約のため,
この port をインストールする際に, JadeTeX(すなわち TeX を含む)
を必要とするかどうかを指定する必要があります.
次のいずれかを, 場合に応じて実行して下さい.
<screen>&prompt.root; <userinput>make JADETEX=yes install</userinput></screen>
<screen>&prompt.root; <userinput>make JADETEX=no install</userinput></screen>
</para>
</important>
<sect1>
<title>必須のツール</title>
<sect2>
<title>ソフトウェア</title>
<para>以下のプログラムは, FreeBSD
の文書で快適に作業するために必要なものです. これらはすべて,
<filename>textproc/docproj</filename>
に含まれています. </para>
<variablelist>
<varlistentry>
<term><application>SP</application>
(<filename>textproc/sp</filename>)</term>
<listitem>
<para>正当性検査のための SGML パーサや
SGML 正規化ツールを含むアプリケーションのセットです.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Jade</application>
(<filename>textproc/jade</filename>)</term>
<listitem>
<para>DSSSL の実装です. これはマークアップされた文書を HTML
や TeX といった他の形式に変換するために使われます. </para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Tidy</application>
(<filename>www/tidy</filename>)</term>
<listitem>
<para>HTML 整形ツールです.
これは自動生成された HTML 文書を整形し,
より利用しやすいものにするために使われます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Lynx</application>
(<filename>www/lynx-current</filename>)</term>
<listitem>
<para>
テキストモードの WWW ブラウザです. &man.lynx.1;
は, HTML
ファイルをプレインテキストに変換することができます.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>文書型定義(DTD)と実体宣言(entity)</title>
<para>以下にあげるのは, FDP で使われている DTD と実体宣言集合(entity set)です.
これらはいずれも, 文書を取り扱う前に必要となります.
</para>
<variablelist>
<varlistentry>
<term>HTML DTD (<filename>textproc/html</filename>)</term>
<listitem>
<para>HTML は, World Wide Web で採用されているマークアップ言語です.
これは FreeBSD ウェブサイト全体でも利用されます. </para>
</listitem>
</varlistentry>
<varlistentry>
<term>LinuxDoc DTD (<filename>textproc/linuxdoc</filename>)</term>
<listitem>
<para>FreeBSD の文書には, LinuxDoc でマークアップされたものがあります.
FDP では, LinuxDoc から DocBook への移行を積極的にすすめています.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>DocBook DTD (<filename>textproc/docbook</filename>)</term>
<listitem>
<para>DocBook は, 技術文書のマークアップのために設計された DTD であり,
FDP では LinuxDoc から DocBook への移行をすすめています.
この原稿を執筆している時点で, FreeBSD ハンドブックが
DockBook によってマークアップされています.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>ISO 8879 公開実体宣言
(<filename>textproc/iso8879</filename>)</term>
<listitem>
<para>ISO 8879:1986 に規定された 19 種類の 文字実体集合です.
これはたくさんの DTD で利用されるもので, 数学記号や latin
文字集合の追加文字(アクセント記号, 発音記号など),
ギリシャ文字などが含まれます.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2>
<title>スタイルシート</title>
<para>スタイルシートは, 文書を画面表示や印刷などに利用される形式に変換,
整形するために使われます.
</para>
<variablelist>
<varlistentry>
<term>Modular DocBook Stylesheets
(<filename>textproc/dsssl-docbook-modular</filename>)</term>
<listitem>
<para>Modular DocBook Stylesheets は,
DocBook DTD でマークアップされた文書を HTML や RTF
形式に変換するのに使われます. </para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1>
<title>必須でない(optional)ツール</title>
<para>もし必要性を感じないなら, 以下にあげるソフトウェアはインストールしなくともかまいません.
しかしインストールしていれば, 文書の取り扱いに便利だと感じるでしょうし,
これらを使うことで, より多様な出力形式で文書を出力することが可能となります.
</para>
<sect2>
<title>ソフトウェア</title>
<variablelist>
<varlistentry>
<term><application>JadeTeX</application> および
<application>teTeX</application>
(<filename>print/jadetex</filename> および
<filename>print/teTeX-beta</filename>)</term>
<listitem>
<para><application>Jade</application> と
<application>teTeX</application> は,
DocBook 文書を DVI, Postscript, PDF の各形式に変換するのに使われます.
また, このとき <application>JadeTeX</application> マクロも必要となります.
</para>
<para>文書をそのような形式に変換しなくて良い
(たとえば HTML, プレインテキスト, RTF で十分であるような)場合には,
<application>JadeTeX</application> および
<application>teTeX</application> をインストールする必要はありません.
これらのインストールには大きなディスクスペースと時間を必要とします.
<application>teTeX</application> は, 30MB を超える大きなものです.
</para>
<important>
<para><application>JadeTeX</application> と
<application>teTeX</application>
をインストールする場合には,
<application>JadeTeX</application> がインストールされた後,
<application>teTeX</application> の設定を行なわなければなりません.
必要な手順の詳細は,
<filename>print/jadetex/pkg/MESSAGE</filename>
に説明されています. </para>
</important>
</listitem>
</varlistentry>
<varlistentry>
<term><application>Emacs</application> もしくは
<application>xemacs</application>
(<filename>editors/emacs</filename> もしくは
<filename>editors/xemacs</filename>)</term>
<listitem>
<para>このエディタは両方とも, SGML DTD
でマークアップされた文書を編集するための特別なモードを備えています.
このモードには,
必要なタイプ量や誤りをを低減するためのコマンドがあります.
</para>
<para>どのようなテキストエディタでもマークアップされた文書を編集することは可能ですので,
これらを使う必要があるというわけではありません.
しかしおそらく, これらは便利なものだと感じると思います.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>もし, この他に SGML 文書を扱うために有用なソフトウェアをご存知でしたら,
Nik Clayton(<email>nik@FreeBSD.org</email>) までお知らせ下さい.
このリストに加えさせていただきます.
</para>
</sect2>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->

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

@ -0,0 +1,387 @@
<!-- Copyright (c) 1998 Nik Clayton, All rights reserved.
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:
1. 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.
2. 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.
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.
The FreeBSD Japanese Documentation Project
Original revision: 1.7
$FreeBSD$
-->
<chapter id="writing-style">
<title>文体について</title>
<para>FreeBSD の文書はたくさんの人々によって書かれています.
そのため, 文書の一貫性を保てるよう, 作者向けにガイドラインがつくられています.
</para>
<variablelist>
<varlistentry>
<term>短縮形は使わない</term>
<listitem>
<para>短縮形は使わないでください.
スペルは常に完全な形で書き,
&ldquo;Don't use contractions&rdquo;
というような表現は使ってはいけません.
</para>
<para>短縮形を使わないことで文の調子が引き締まり, かたい感じになります.
また, 多少ですが翻訳者の負担を軽減できます.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>並記の際にはカンマを使う</term>
<listitem>
<para>
段落のなかで項目を並べる場合には,
それぞれの項目をカンマを使って分けてください.
最後の項目では, カンマと &ldquo;and&rdquo; を使います.
</para>
<para>たとえば, 次の例を見てください. </para>
<blockquote>
<para>This is a list of one, two and three items.</para>
</blockquote>
<para>さて, これは三つの項目, &ldquo;one&rdquo;,
&ldquo;two&rdquo; および &ldquo;three&rdquo;
を並べたものでしょうか?
それとも, 二つの項目, &ldquo;one&rdquo; と &ldquo;two and three&rdquo;
を並べたものなのでしょうか?
</para>
<para>これは,
並記の際にカンマを使うことではっきりさせることができます. </para>
<blockquote>
<para>This is a list of one, two, and three items.</para>
</blockquote>
</listitem>
</varlistentry>
<varlistentry>
<term>冗長な表現を避ける</term>
<listitem>
<para>冗長な表現を使わないよう配慮してください. 具体的に言うと,
&ldquo;the command&rdquo;,
&ldquo;the file&rdquo;,
そして &ldquo;man command&rdquo;
というような表現は, いずれも余計なものです.
</para>
<para>ここに, コマンドに関する二つの例を示します.
好ましいのは二番目の例です. </para>
<informalexample>
<para>Use the command <command>cvsup</command> to update your
sources</para>
</informalexample>
<informalexample>
<para>Use <command>cvsup</command> to update your sources</para>
</informalexample>
<para>次に, ファイル名に関する二つの例を示します.
こちらも, 好ましいのは二番目の例です. </para>
<informalexample>
<para>&hellip; in the filename
<filename>/etc/rc.local</filename>&hellip;</para>
</informalexample>
<informalexample>
<para>&hellip; in
<filename>/etc/rc.local</filename>&hellip;</para>
</informalexample>
<para>マニュアルページ参照に関する二つの例を示します.
こちらも, 好ましいのは二番目の例です (二番目の例では,
<sgmltag>citerefentry</sgmltag> が使われています). </para>
<informalexample>
<para>See <command>man csh</command> for more
information.</para>
</informalexample>
<informalexample>
<para>See &man.csh.1;</para>
</informalexample>
</listitem>
</varlistentry>
<varlistentry>
<term>文の最後には二個分の空白を入れる</term>
<listitem>
<para>文の最後には, 常に二個分の空白を入れてください.
これは読みやすさを向上させるためと,
<application>emacs</application>
のようなツールで扱いやすくするためです.
</para>
<para>文の最後のピリオドに続く文字は大文字だから,
スペースの数が 一つでも文の最後と分かるじゃないか,
と思われた方がいらっしゃるかも知れませんが,
これは特に, 名前にピリオドが使われるときには当てはまりません.
適当な例として, たとえば <quote>Jordan K. Hubbard</quote>
があげられます. この場合, ピリオドと一つのスペースの後ろに大文字の
<literal>H</literal> が来ていますが,
明らかに新しい文のはじまりではありません.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>文体についての詳細は, William Strunk 氏による <ulink
url="http://www.columbia.edu/acis/bartleby/strunk/">Elements of
Style</ulink> が参考になります. </para>
<sect1>
<title>スタイルガイド</title>
<para>ハンドブックはたくさんの人々によって編集されます.
ソースファイルにおける一貫性を維持するため,
以下にあげるようなスタイルを守るようにお願いします.
</para>
<sect2>
<title>大文字と小文字</title>
<para>タグは小文字で入力します.
<literal>&lt;PARA&gt;</literal>
<emphasis>ではなく</emphasis>,
<literal>&lt;para&gt;</literal> です.
</para>
<para>SGML コンテキスト(訳注: DTD などの部分)では通常,
大文字で書かれます.
たとえば <literal>&lt;!entity&hellip;&gt;</literal> や
<literal>&lt;!doctype&hellip;&gt;</literal>
<emphasis>ではなく</emphasis>,
<literal>&lt!ENTITY&hellip;&gt;</literal> や
<literal>&lt;!DOCTYPE&hellip;&gt;</literal>
というように書きます.
</para>
</sect2>
<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>開始タグでは必ず二個分の空白で字下げ幅を増やし,
同様に終了タグでは二個分の空白で字下げ幅を減らします.
エレメント中の内容が一行以上にわたる場合は,
さらに二個分の空白で字下げされていなければなりません.
</para>
<para>たとえば, このセクションのソースはつぎのようになっています. </para>
<programlisting>
<![ CDATA [+--- This is column 0
V
<chapter>
<title>...</title>
<sect1>
<title>...</title>
<sect2>
<title>Indentation</title>
<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>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> を使っている場合には
<literal>sgml-mode</literal> が自動的にロードされますので,
各ファイルの最後に書かれた Emacs
のローカル変数によってこのスタイルが維持されます. </para>
</sect2>
<sect2>
<title>タグのスタイル</title>
<sect3>
<title>タグ間のスペース</title>
<para>
タグはその前にあるタグと同じ字下げ幅ではじめ,
タグとの間は一行空けてください.
ただしその前のタグが同じ字下げ幅でなければ行を空けてはいけません.
</para>
<informalexample>
<programlisting><![ CDATA [<article>
<artheader>
<title>NIS</title>
<pubdate>October 1999</pubdata>
<abstract>
<para>...
...
...</para>
</abstract>
</artheader>
<sect1>
<title>...</title>
<para>...</para>
</sect1>
<sect1>
<title>...</title>
<para>...</para>
</sect1>
</article>]]></programlisting>
</informalexample>
</sect3>
<sect3>
<title>特殊なタグ</title>
<para>
いくつかのタグには前節であげた字下げルールにを適用しません.
<sgmltag>screen</sgmltag> タグと
<sgmltag>programlisting</sgmltag> タグは,
常に左詰めにしてください.
</para>
<informalexample>
<programlisting><![ RCDATA [<informalexample>
<programlisting>
&hellip;
</programlisting>
</informalexample>]]></programlisting>
</informalexample>
<para>
<sgmltag>informalexample</sgmltag> タグも
<sgmltag>screen</sgmltag> や
<sgmltag>programlisting</sgmltag>
が含まれる場合には左詰めにします. </para>
<para>
これらの例の場合は前後に空白行を入れ,
残りのテキストと分離してください.
</para>
</sect3>
<sect3>
<title>タグの分離</title>
<para>
<sgmltag>itemizedlist</sgmltag>
のようなタグは常に内部に別のタグが入り,
実際の文字データは入りません.
そのため, 常にタグだけで一行になります.
</para>
<para><sgmltag>para</sgmltag> と <sgmltag>term</sgmltag> は,
通常の文字データを他のタグを使わずにそのまま入れることができます.
そのため, 内容は開始タグの直後,
すなわち<emphasis>同じ行から</emphasis>はじまります.
</para>
<para>これは, 二種類のタグが閉じるときも同様です. </para>
<para>このルールは, この種のタグが混ぜて使われる際に問題となります. </para>
<para>直接文字データを含むことができない開始タグに続くタグがこの種のタグ,
すなわち文字データを入れるために他のタグを使わなければならないものであった場合,
それらはそれぞれ独立した行になります.
二番目のタグは, 適切に字下げされていなければなりません.
</para>
<para>文字データを直接含むことのできるタグが
データを直接含むことのできないタグの直後に現われる場合は,
それらは同一の行に共存することになります.
</para>
</sect3>
</sect2>
<sect2>
<title>空白の変更</title>
<para>変更を commit する際には,
<emphasis>内容の変更と体裁の変更を同時に
commit してはいけません</emphasis>.
</para>
<para>これは, ハンドブックを他の言語に翻訳している翻訳チームがあなたの
commit で実際の内容が変更されたことをすぐに判別できるようにするためです.
commit が分けてあれば, その変更が内容的なものか,
それとも単に整形のためなのかを確認する必要がなくなります.
</para>
<para>たとえば, ある段落に二つの文を追加する場合を考えてみましょう.
文を追加したことにより, 段落の長さが 80 カラムを超えたとします.
そういう場合には, 最初の commit で整形せずに長いまま commit してください.
そして次に行の折り返しを行ない, 二回目としてその結果を commit します.
また, 二回目の commit ログには「これは空白の変更だけであり,
翻訳チームは無視しても大丈夫です」ということを示すようにしてください.
</para>
</sect2>
</sect1>
</chapter>
<!--
Local Variables:
mode: sgml
sgml-declaration: "../chapter.decl"
sgml-indent-data: t
sgml-omittag: nil
sgml-always-quote-attributes: t
sgml-parent-document: ("../book.sgml" "part" "chapter")
End:
-->