[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Debiandoc-SGML markup manual
- From: Masayuki HATTA <masayuki-h@xxxxxxxxxxxxxxx>
- Subject: Debiandoc-SGML markup manual
- Date: Sun, 6 Dec 1998 22:21:47 +0900
- X-dispatcher: imput version 980905(IM100)
- X-fingerprint: 46 F9 F0 BB 1A 8F 04 BE 1D 8F AC E5 17 FD 46 CE
- X-ml-info: If you have a question, send a mail with the body "# help" (without quotes) to the address debian-doc-ctl@debian.or.jp; help=<mailto:debian-doc-ctl@debian.or.jp?body=help>
- X-ml-name: debian-doc
- X-mlserver: fml [fml 2.2]; post only (only members can post)
- X-url: http://www.geocities.co.jp/SiliconValley-PaloAlto/9803/
- Message-id: <199812061321.WAA22030@xxxxxxxxxxxxxxxxxxxx>
- X-mail-count: 00559
- X-mailer: Mew version 1.93 on Emacs 20.2 / Mule 3.0 (MOMIJINOGA)
八田(ま)です。
現時点ではあんまり役に立ちませんが、
一応 Debiandoc-SGML のマークアップマニュアルを訳してみました。
(原本は debiandoc-sgml-1.0.18 付属のもの)
原文を残した SGML ソースと処理済の日本語テキストファイルを
添付します。HTML でも出力できました。
訳そのものも「わけわか」なところが多くありますので、
読んでいろいろ教えて頂けるとうれしいです。<footnote>訳注：なんたらかんたら
</footnote> として不明なところをメモしてあります。
# それにしても、Debiandoc-SGML って今後どうなるんだろう…
--
八田真行 <masayuki-h@xxxxxxxxxxxxxxx>
<!doctype debiandoc system>
<debiandoc>
<book>
<titlepag>
<!--
<title>Debiandoc-SGML markup manual</title>
-->
<title>Debiandoc-SGML マークアップ・マニュアル</title>
<author>
<name>Ian Jackson</name>
<email>ijackson@xxxxxxxxxxxxxx</email>
</author>
<author>
<name>Ardo van Rangelrooij</name>
<email>ardo@debian.org</email>
</author>
<author>
<name>八田真行</name>
<email>masayuki-h@xxxxxxxxxxxxxxx</email>
</author>
<version><date></version>
<copyright>
<copyrightsummary>
Copyright © 1998 Ardo van Rangelrooij
Copyright © 1996 Ian Jackson
Copyright © 1998 八田真行
</copyrightsummary>
<!--
<p>
Debiandoc-SGML, including this manual, is free software; you
may redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software
Foundation; either version 2, or (at your option) any later
version.
</p>
-->
<p>
このマニュアルも含めて、Debiandoc-SGML はフリーソフトウェアです。
Free Software Foundation 発行の GNU General Public License
(Version 2 かそれ以降)が定める条件の下で再配布及び変更が許されます。
</p>
<!--
<p>
This is distributed in the hope that it will be useful, but
<em>without any warranty</em>; without even the implied
warranty of merchantability or fitness for a particular
purpose. See the GNU General Public License for more
details.
</p>
-->
<p>
このソフトウェアは有用であることを願って配布されるもの
ですが、<em>いかなる保証もありません。</em>すなわち、この
ソフトウェアが市場向きであるか、あるいは特定の目的に適合するか
どうかは、全く保証されません<footnote>訳注：どうもしっくりこない
訳です</footnote>。
詳しくは GNU General Public License をご覧下さい。
</p>
<!--
<p>
You should have received a copy of the GNU General Public
License with your Debian GNU/Linux system, in
<tt>/usr/doc/copyright/GPL</tt>, or with the
<prgn>debiandoc-sgml</prgn> source package as the file
<tt>COPYING</tt>. If not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
</p>
-->
<p>
GNU General Public License のコピーはあなたの Debian GNU/Linux
システム内の <tt>/usr/doc/copyright/GPL</tt> か、
<prgn>debiandoc-sgml</prgn> のソースパッケージ中にファイル名
<tt>COPYING</tt> として収録されているはずです。以上で挙げた場所
に存在しない場合には Free Software Foundation に請求して下さい。
(住所： the Free Software Foundation, Inc., 675 Mass Ave,
Cambridge, MA 02139, USA.)
</p>
</copyright>
</titlepag>
<toc sect>
<!--
<chapt id="markup">SGML markup and metacharcters
-->
<chapt id="markup">SGML のマークアップとメタキャラクタ
<!--
<p>
As entered in a text editor SGML document consists of text
interspersed with tags denoting the start and end of elements.
-->
<p>
テキストエディタに入力した状態では、SGML 文書は
エレメント<footnote>訳注：「要素」と訳すのも何か変だし…</footnote>
の始点と終点を示すタグが散在するテキストです。
<!--
<p>
Tags take the form <tt/<<var/element/>/ to start the element
<var/element/ and <tt></<var/element/></> to finish it.
-->
<p>
タグ <tt/<<var/element/>/ があるエレメント
<var/element/ の始点を示し、<tt></<var/element/>
</> が終点を示します。
<!--
<p>
There are some shorthands you can use:
<tt><<var/element//<var/contents//</> specifies an element
<var/element/ with contents <var/contents/ - but the <var/contents/
may not contain a slash <tt>/</>. <tt></></> closes the
innermost currently open element.
-->
<p>
略記法がいくつか使えます。例えば、
<tt><<var/element//<var/contents//</> はあるエレメント
<var/element/ が <var/contents/ という内容を含む
ことを意味します。ただし、内容 <var/contents/
がスラッシュ <tt>/</> を含んではいけません。また、
<tt></></> は現在開いている中で最も内側のエレメントを閉じます。
<!--
<p>
Some types of element start tag can have attributes; these appear
inside the closing angle bracket, and are separated from the element
name by whitespace. The attributes allowed in a particular element's
start tag are described along with the element.
-->
<p>
エレメントを開始するタグのいくつかには属性を与えることができます。
これらの属性はエレメント開始タグを閉じるカギカッコよりも前に現れ、
エレメント名とは空白で区切られます。どのエレメント開始タグがどういう
属性を持ちうるかは各エレメント開始タグについて説明する際いっしょに
説明します。
<!--
<p>
If you want to include SGML's markup characters (angle brackets
<tt/</ <tt/>/ and ampersands <tt/&/) as text you must refer
to them by name (this is called an entity reference in SGML-speak).
<tt/&<var/name/;/ produces the character whose name is <var/name/.
Some useful character names are:
<taglist compact>
<tag><tt/lt/
<item>less than sign (left angle bracket) <tt><</>;
<tag><tt/gt/
<item>greater than sign (right angle bracket) <tt>></>;
<tag><tt/amp/
<item>ampersand <tt>&</>;
<tag><tt/copy/
<item>copyright symbol <tt>©</>;
</taglist>
The full list of characters is borrowed from <prgn/linuxdoc-sgml/, in
<prgn/linuxdoc-sgml/'s <tt>rep/latin1/general</> file.
-->
<p>
もし本文中で SGML のマークアップキャラクタ(カギカッコ
<tt/</ <tt/>/ と アンパサンド <tt/&/)を普通の文字として
使いたい場合には、特別な書き方で表現しなければなりません(これを
SGML の世界では「実体参照」といいます)。
<tt/&<var/name/;/ は実際にはその名称が <var/name/ である
文字を表現します。
良く使う文字の名称をいくつか挙げると、
<taglist compact>
<tag><tt/lt/
<item>小なり(less than) 記号 (左かぎカッコ) <tt><</>
<tag><tt/gt/
<item>大なり(greater than) 記号 (右かぎカッコ) <tt>></>
<tag><tt/amp/
<item>アンパサンド <tt>&</>
<tag><tt/copy/
<item>著作権記号 <tt>©</>
</taglist>
これらの名称は全て <prgn/linuxdoc-sgml/ から
借用したもので、<prgn/linuxdoc-sgml/ の <tt>rep/latin1/general</>
というファイルに記載されています。
<!--
<p>
You can also use <tt/&#<var/number/;/ to refer to the character
whose number is <var/number/ (in ISO-LATIN-1). <var/number/ should be
in decimal.
-->
<p>
ISO-LATIN-1 において文字コード番号が <var/number/ である文字
を表現するのに、 <tt/&#<var/number/;/ という書き方もできます。
<var/number/ は十進法表記でなければなりません。
<!--
<chapt id="structure">Overall structure
-->
<chapt id="structure">文書全体の構造
<!--
<p>
The first line of the document should be
<example>
<!doctype debiandoc system>
</example>
to indicate that the document is a Debiandoc-SGML file.
-->
<p>
文書の最初の一行は、この文書が Debiandoc-SGML
ファイルであることを示すため
<example>
<!doctype debiandoc system>
</example>
でなければなりません。
<!--
<p>
The document should start with the <tt/<book>/ tag and end with
<tt></book></>.
-->
<p>
文書は <tt/<book>/ タグで始まり、<tt></book></>
タグで終ります。
<!--
<p>
This should be followed by the <tt/<title>/, one or more
<tt/<author>/-<tt/<email>/ pairs, and optionally a
<tt/<version>/. Each of these is a piece of marked-up inline
text - see <ref id="inline">. The <tt/<version>/ may also
contain <tt/<date>/ which stands for the date at the time the
document is formatted.
-->
<p>
<tt/<book>/ タグの後には <tt/<title>/ がきて、一つか
それ以上の <tt/<author>/ と <tt/<email>/ のペアがそれに
続きます。必須ではありませんが <tt/<version>/ を使うことも
できます。これらエレメントのそれぞれは一片のマークアップされた
エレメント内テキスト(詳しくは<ref id="inline">参照)です。
<tt/<version>/ は文書が整形された日付を表す
<tt/<date>/ を含むこともできます。
<!--
<p>
Then may come an <tt/<abstract>/ and a <tt/<copyright>/
notice and a <tt/<toc>/ marker.
-->
<p>
そのあとに文書の摘要 <tt/<abstract>/ 、著作権表示
<tt/<copyright>/ 、そして目次 <tt/<toc>/ の
３種のマーカがそれぞれ一つずつきます。
<!--
<p>
The <tt/<abstract>/ contains a single paragraph.
-->
<p>
文書の摘要 <tt/<abstract>/ は段落を一つ含みます。
<!--
<p>
The <tt/<copyright>/ notice contains a copyright summary (this
is used, for example, at the bottom of every HTML page) followed by
one or more paragraphs, the first of which must be indicated by a
<tt/<p>/ tag to distinguish it from the summary.
-->
<p>
著作権表示 <tt/<copyright>/ は著作権表示の要約(例えば、
すべての HTML ページの一番下に表示されるのがこれです)を含み、
その後本文として一つかそれ以上の段落が続きます。本文最初の段落は
要約と区別するために <tt/<p>/ タグで明示されていなければ
なりません。
<!--
<p>
The <tt/<toc>/ marker specifies that a table of contents is to
be produced. The <tt/<toc>/ doesn't contain anything in the
SGML source - its contents are generated by the processing systems.
The <tt/<toc>/ can have an attribute saying how detailed it
should be; for example, <tt/<toc sect1>/ says that subsections
should be included, whereas <tt/<toc chapt>/ says that only
chapters should be included. The values allowed are <tt/chapt/,
<tt/sect/, <tt/sect1/ and <tt/sect2/.
-->
<p>
<tt/<toc>/ マーカは生成される目次を示します。
目次の内容は SGML を処理する過程で生成されるので、<tt/<toc>/
の中身を SGML ソース中で記述する必要はありません。
<tt/<toc>/ に属性を指定することで、出力される目次の内容の詳細を
指定することができます。例えば、<tt/<toc sect1>/ は節も
目次に含めることを、また <tt/<toc chapt>/ は章のみが
目次に含められることを指定します。とりうる属性の値は <tt/chapt/,
<tt/sect/、<tt/sect1/、<tt/sect2/の３つです。
<!--
<p>
Following these parts comes the body of the document - one or more
chapters <tt/<chapt>/.
-->
<p>
以上に続いて文書の本文が現れます。本文は一つかそれ以上の
章 <tt/<chapt>/ で構成されます。
<!--
<p>
It is not necessary to mark the end of the <tt/<title>/,
<tt/<author>/s, <tt/<version>/, <tt/<abstract>/ and
<tt/<copyright>/ elements - they are implicitly ended by the
start of the next element.
-->
<p>
表題 <tt/<title>/、著者名(複数可) <tt/<author>/、文書の
バージョン <tt/<version>/、文書の摘要 <tt/<abstract>/、
著作権表示 <tt/<copyright>/ の４つのエレメントの
終りにはマークをつける必要がありません。次のエレメントが次の行から
始まる、ということでそのエレメントの終りを暗に示せるからです。
<!--
<chapt id="chaptsectpar">Chapters, sections and paragraphs
-->
<chapt id="chaptsectpar">章、節と段落
<!--
<p>
Each chapter starts with a <tt/<chapt>/ tag, followed by the
chapter's title. The title may contain marked-up inline text, but no
cross-references (see <ref id="inline">).
-->
<p>
それぞれの章は <tt/<chapt>/ タグで始まり、その後には
章の表題がきます。表題はマークアップされたエレメント内テキスト
を含むことができますが、他所参照を含んではいけません
(詳しくは <ref id="inline"> を参照)。
<!--
<p>
The body of the chapter is zero or more paragraphs, the first of which
must be indicated by a <tt/<p>/ tag to distinguish it from the
title, and then zero or more sections.
-->
<p>
章の内容は普通いくつかの段落から構成されますが、全く段落が無くても
構いません。最初の段落は表題と区別するため <tt/<p>/ タグで明確
に指定されていなければならず、その後段落がいくつか続きます。
<!--
<p>
A section starts with <tt/<sect>/, and has a similar structure:
title, optionally some paragraphs, and then optionally some
subsections.
-->
<p>
節は <tt/<sect>/ で始まり、章と似たような構造を
持ちます。すなわち、節は表題を含み、
場合によってはいくつかの段落、あるいはいくつかの小節を
含むこともできます。
<!--
<p>
Subsections are <tt/<sect1>/; there are also smaller divisions
<tt/<sect2>/, <tt/<sect3>/ and <tt/<sect4>/.
-->
<p>
小節は <tt/<sect1>/ で表されますが、もっと細かい
区分を表すためには <tt/<sect2>/, <tt/<sect3>/ や
<tt/<sect4>/ も使えます。
<!--
<p>
Paragraphs are introduced by <tt/<p>/. Sometimes the start of
paragraph tag can be omitted, but it is mandatory after
<tt/<chapt>/, <tt/<sect>/ and so forth. It is never
necessary to mark the end of a paragraph with <tt></p></>.
-->
<p>
段落は <tt/<p>/ で始まります。しばしば段落の最初のタグ
は省略されますが、 <tt/<chapt>/ や <tt/<sect>/ など
のタグの後では必須です。段落の最後を <tt></p></> で指定
する必要は全くありません。
<!--
<p>
Paragraphs can contain marked up inline text (see <ref id="inline">)
and also lists and examples (<ref id="listexamp">).
-->
<p>
段落はマークアップされたエレメント内テキスト(詳しくは
<ref id="inline"> を参照)、あるいはリストや例示も含む
ことができます(詳しくは <ref id="listexamp"> を参照)。
<!--
<chapt id="inline">Marked-up inline text and character style markup
-->
<chapt id="inline">マークアップされたエレメント内テキストとキャラクタスタイル指定マークアップ
<!--
<p>
Ordinary text (called `inline text' in this document) may contain a
elements for special formatting and cross-referencing. Inline text
appears in chapter and section titles, in the copyright summary,
inside paragraphs and in other similar places.
-->
<p>
通常のテキスト(この文書中では「エレメント内テキスト」と呼びます)は
特別な体裁や他所参照を指定するためのエレメントを
含むことができます。エレメント内テキストは章や節の表題や
著作権表示の要約、段落の中など様々な場所に現れます。
<!--
<sect>Character style
-->
<sect>キャラクタスタイル
<!--
<p>
There are a number of elements for denoting special significance of
certain pieces of text. For all of them the end of the special text
must be marked up explicitly, by using an explicit end tag
<tt></<var/element/></>, the abbreviated end tag for closing
the innermost element <tt></></> or the slash <tt>/</> which
finishes the most abbreviated form of element markup (see <ref
id="markup">).
-->
<p>
テキストのある部分が特に重要だということを示すエレメントが
数多く存在します。それらのエレメントでは、
終点を明示する <tt></<var/element/></> タグ、最も内側の
エレメントを閉じる省略された形の終点タグ <tt></></>、または
最も省略された形のエレメントマークアップを終らせる
スラッシュ <tt>/</> のうち、必ずどれかを使って終点を
はっきりと指定しなければなりません
(詳しくは<ref id="markup">を参照)。
<footnote>訳注：ここも言ってることはなんとなくわかるものの
うまく訳せません</footnote>
<taglist>
<!--
<tag><tt/<em>/ - emphasis
<item>
Indicates that the contained text is more important or more
significant than that surrounding it.
<p>
Typically this will be represented by italics if available, or
emboldened or underlined text, or in plain text formats with
no haracter highlighting available by surrounding the text
with asterisks like *this*.
-->
<tag><tt/<em>/ - 強調
<item>
含まれるテキストがそれを取り巻く他の部分よりも重要であることを
示します。
<p>
普通これはイタリック体が使えればイタリック体で表現されますが、
太字や下線を引くことで表現されることもあり、あるいは
文字そのものを強調することができない標準テキスト
形式の場合にはテキストをアスタリスクで挟んで、
*こんな感じ* にします。
<!--
<tag><tt/<strong>/ - more emphasis
<item>
Indicates that the contained text is even more important or even
more significant than that surrounding it.
<p>
Typically this will be represented by bold if available or in plain
text formats with no character highlighting available by surrounding
the text with asterisks like *this*.
-->
<tag><tt/<strong>/ - もっと強い強調
<item>
含まれるテキストがそれを取り巻く他の部分よりもはるかに重要
なので、<tt/<em>/ よりもっと目立たせたいとき
使います。
<p>
普通これは太字が使えれば太字で表現されますが、文字
そのものを強調することができない標準テキスト形式の場合には
テキストをアスタリスクで挟んで *こんな感じ* にします。
<!--
<tag><tt/<var>/ - metasyntactic variable
<item>
Indicates that the contained text is a metasyntactic
variable. Ie, it is the name of an object or piece of
syntax which when actually used
would have a real value substituted.
<p>
Typically this will be represented by italics, or in plain
text formats by surrounding the text with angle brackets like
<this>.
If several metasyntactic variables appear one after the other
they should each be given their own <tt/<var>/ element.
-->
<tag><tt/<var>/ - メタ構文的変数
<item>
含まれるテキストがメタ構文的変数<footnote>訳注：どう訳した
ものやら…</footnote>
であることを示します。すなわち、そのテキストがあるものの
名前か構文の断片をを表していて、実際に使われる時には現実の値で
置き換えられることを示しています。
<footnote>訳注：ようするに $ command foo とかいうときの foo
のことか？うまい訳が浮かびません。</footnote>
<p>
普通これはイタリック体で表現されますが、標準テキスト形式
ではそのテキストを <このように> カギカッコで囲んで
表現します。
もしいくつかのメタ構文的変数が次々に現われるならば、それぞれ
を <tt/<var>/ エレメントとして指定しなければ
なりません。
<!--
<tag><tt/<prgn>/ - name of a program or well-known file
<item>
Indicates that the contained text is the name of a program,
well-known filename (usually without paths), function or
some similar thing which has a name in the computer.
<p>
In output formats where character highlighting and various
font styles are available this is usually represented by
using a fixed-width font. In plain text output formats
these names are not specially marked at all, as they occur
frequently and introducing quoting would disrupt the flow of
the text.
-->
<tag><tt/<prgn>/ - プログラムや有名なファイルの名称
<item>
含まれるテキストがプログラムの名前や、有名な<footnote>訳注：
何か変ですよね？</footnote>
ファイル名(普通はパスを除いた形)、あるいは関数など
コンピュータ内で特定の名前を持つものであることを示します。
<p>
文字の強調や様々なフォントスタイルが利用可能な出力形式
においては、普通これは固定幅フォントで表現されます。
標準テキスト形式においてはこれらの名前は特にマーク
されません。というのも、これらはひんぱんに現れるので、
いちいち引用を始める<footnote>訳注：何か変ですよね？
</footnote>のはテキストの流れを阻害するからです。
<!--
<tag><tt/<tt>/ - pathname, code or output fragment,
command string
<item>
Indicates that the contained text is a general string which
came out of or is going in to a computer. It should be used
for full pathames, code fragments that should be displayed
inline and wordrapped (see also <ref id="examples"> for an
alternative), and so forth. It is frequently necessary to
introduce metasyntactic variables into these strings, in
which case they should be made part of the <tt/<tt>/
element rather than elements alongside it.
<p>
This will usually be rendered using a fixed-width font; in
plain-text formats quotes may be used around the element.
-->
<tag><tt/<tt>/ - パス名、ソースコードあるいは出力結果の
断片、コマンド書式
<item>
含まれるテキストが、一般にコンピュータから出力されたか、
入力される文字列であることを示します。
フルパス名、あるいはソースコードの断片といった、
エレメント内にワードラップして表示したいテキストに使うのが
妥当です(他のやり方として <ref id="examples"> もあります)。
これらの文字列内で、文字列をそばのエレメントではなく
むしろ <tt/<tt>/ エレメントの一部分にしたいというとき
など、メタ構文的変数を使わなければいけないということがよく
あります。<footnote>訳注：意味不明です。</footnote>
<p>
普通これは固定幅フォントを用いて表されます。
標準テキスト形式では引用<footnote>訳注：何か変。</footnote>が
エレメントの周りに使われます。
<!--
<tag><tt/<qref id="<var/refid/">/ - quiet reference
<item>
Produces a `quiet reference' to the named reference id (see
<ref id="xref">). This should be used where a
cross-reference would be useful if not intrusive, but where
it is not essential and should be left out if it would need
to intrude on the text.
<p>
In formats where cross-references can be made non-intrusively
by making a region of text a hyperlink without introducing
in-line text this element will cause its contained text to
become a hyperlink to the target of the cross-reference. In
other formats this element will not have any effect.
-->
<tag><tt/<qref id="<var/refid/">/ - 暗黙の参照
<item>
指定された参照識別子(詳しくは<ref id="xref">参照)への
「暗黙の参照」<footnote>訳注：これも何かおかしいですよね。
</footnote>を生成します。これは、邪魔にならないならここで互
他所参照使うと便利そうなんだけど、でもどうしても必要ってわけ
でもないし、テキストに無理やり押し込むのもなあ…というような
時に使うとよいでしょう。
<p>
テキストの特定の領域をエレメント内テキストを入れることなく
<footnote>訳注：意味不明です。</footnote>ハイパーリンク
にすることで他所参照を目立たなくすることができる
出力形式では、このエレメントは含まれるテキストを
他所参照の対象へのハイパーリンクにします。
そうでない出力形式ではこのエレメントは何の効果も持ちません。
</taglist>
<!--
<sect id="xref">Cross-references
-->
<sect id="xref">他所参照
<!--
<p>
There are a number of elements for introducing cross-references
either to other parts of the same document or to other documents.
-->
<p>
同じ文書の他の部分、あるいは他の文書への他所参照を導く
エレメントは数多く存在します。
<!--
<p>
The intra-document cross-references are based on a scheme of
reference identifiers. Each chapter, section, subsection etc. may
have an <tt/id/ attribute giving its reference id - for example
<tt/<chapt id="spong">/ specifies that the chapter being
started has reference id <tt/spong/. This reference id can then
be referred to in other parts of the document using the special
cross-referencing elements.
-->
<p>
文書内の他所参照は参照識別子構造<footnote>訳注：うーんもう少し
何とかならんかな</footnote>を基にしています。
章、節、小節などにはそれぞれに <tt/id/ 属性を与えることで
参照識別子を指定できます。例えば、 <tt/<chapt id="spong">/
はそのタグで始まる章が参照識別子 <tt/spong/ を持つことを示して
います。この参照識別子を特別な他所参照エレメントで指定する
ことで、文書の他の部分からこの章を参照することができるのです。
<!--
<p>
The reference identifier will also be used for generating filenames
and reference tokens for formats such as HTML which produce several
output files; if no reference ids are specified then the chapter and
section numbers will be used. It is a good idea to give at least
all your chapters reference ids so that the filenames will not
change if you change the order of the chapters or sections in your
document.
-->
<p>
参照識別子は HTML のように複数のファイルに分けて
出力する出力形式で使われるファイル名や参照シンボルを生成するのにも
使われます。
参照識別子が一つも指定されていない場合には、章番号
あるいは節番号が使われます。何はともあれすべての章に参照識別子を
つけておくと、文書内で章や節の順番を変えても出力ファイル名
が変わらないので便利でしょう。
<p>
<taglist>
<!--
<tag><tt/<ref id="<var/refid/">/ - intra-document cross
reference
<item>
This generates a cross-reference within the same document to
the section or chapter with id <var/refid/.
<p>
The <tt/<ref>/ element does not have any contents; the
section or chapter number and title and its page number or
whatever is appropriate for the output format will be
inserted into the text at the point where the tag appears.
<p>
Syntactically the cross reference is a noun phrase,
suitable for uses like <tt>(see <ref id="<var/.../">)
</> or <tt>further info is in <ref id="<var/.../">.</>.
-->
<tag><tt/<ref id="<var/refid/">/ - 文書内の他所参照
<item>
同じ文書中の、参照識別子 <var/refid/ が指定された節や
章への他所参照を生成します。
<p>
<tt/<ref>/ エレメントは内容を一切含みません。
節や章の番号と表題、そのページ番号などで出力
形式に適切なものは、タグの現われた所に挿入されます。
<p>
統語論的には、他所参照は名詞で<footnote>訳注：なんのこっちゃ。
</footnote>、<tt>(<ref id="<var/.../"> をご覧下さい)</>
とか <tt>詳しくは <ref id="<var/.../"> を。</> といった
使い方に適します。
<!--
<tag><tt/<manref name="<var/name/"
section="<var/section/">/ - manpage
<item>
Generates a cross-reference to the manpage for <var/name/ in
section <var/section/. This tag does not have any contents;
text describing the page, typically <tt/<var/name/
(<var/section/)/, will be inserted at the point where
<tt/<manref>/ appears.
-->
<tag><tt/<manref name="<var/name/"
section="<var/section/">/ - マニュアルページ
<item>
セクション <var/section/ の <var/name/ というマニュアルページ
への他所参照を生成します。このタグは内容を含みません。
ページを説明するテキスト、典型的には <tt/<var/name/
(<var/section/)/ といったものですが、これらは
<tt/<manref>/ タグのある地点に挿入されます。
<!--
<tag><tt/<email>/ - email address
<item>
Indicates that the contained text is an email address. The
contents of the tag should be just the text of the email
address itself; character style markup and cross-references
are forbidden. Usually the end tag <tt></email></> may
not be omitted, but it may be left out when it appears in an
<tt/<author>/ as the end of the <tt/<author>/,
implied by the start of the next element, will imply the end
of the email address.
<p>
In some formats this will generate a true cross-reference
which might (for example) be used to send email to the
address quoted. In others it will just mark the text
specially, usually including angle brackets <tt/</
<tt/>/ around it.
-->
<tag><tt/<email>/ - 電子メールアドレス
<item>
含まれるテキストが電子メールのアドレスであることを示します。
タグの内容は電子メールのアドレスを記述したテキスト自身のみで、
キャラクタスタイル指定マークアップや他所参照は禁止です。普通
終了タグ <tt></email></> は省略できませんが、
もし 一番最後の <tt/<author>/ の中で使うなら、
次のエレメントの開始により <tt/<author>/ と
<tt/<email>/ の終りを両方暗に示せるので
省くことができます。
<p>
いくつかの出力形式においては、本当の他所参照、
(例えば)引用されたアドレスに電子メールを
送ることができるようなハイパーリンクを生成します。
他の出力形式では、単にテキストを特別にマークするだけで、
普通はカギカッコ <tt/</ <tt/>/ で囲むだけです。
<!--
<tag><tt/<ftpsite>/ - anonymous FTP site name
<tag><tt/<ftppath>/ - path on most recently named FTP site
<item>
<tt/<ftpsite>/ indicates that the content of the
element is the DNS name of an anonymous FTP site, and
<tt/<ftppath>/ that it is a pathname on that site.
Both elements may not contain any character style markup or
cross-references.
<p>
Typically both elements will be rendered in a fixed with
font; if possible, the <tt/<ftppath>/ will be made
into a functional hyperlink to the named file or directory
on the most recent <tt/<ftpsite>/.
<p>
<tt/<ftppath>/ must always have been preceded by a
<tt/<ftpsite>/ in the same chapter, but once one site
has been named several paths may be appear.
-->
<tag><tt/<ftpsite>/ - 匿名 FTP サイト名
<tag><tt/<ftppath>/ - 最後に行った FTP サイトにおけるパス
<item>
<tt/<ftpsite>/ はエレメントの内容が匿名 FTP
サイトの DNS 名であることを、 <tt/<ftppath>/ はその
サイトにおけるパス名であることを示します。
両者ともキャラクタスタイル指定マークアップや他所参照を含んでは
いけません。
<p>
普通両者は固定幅フォントで表わされます。もし可能ならば、
<tt/<ftppath>/ は最後にアクセスした
<tt/<ftpsite>/ 上の指定されたファイルかディレクトリを
実際に指すハイパーリンクになります<footnote>「最も最近の
FTP サイト上の」とはどういうことなのだろうか？</footnote>
<p>
同一の章では <tt/<ftppath>/ に先だって必ず
<tt/<ftpsite>/ が現われますが、一旦あるサイトが
指定されるといくつかのパスが現われるかも知れません。
<footnote>訳注：うーむ。意味不明だ。</footnote>
</taglist>
<!--
<sect>Footnotes
-->
<sect>脚注
<!--
<p>
Footnotes may appear in most inline text, and are indicated
by <tt><footnote><var/.../</footnote></>. The text of
the footnote itself will be removed and placed elsewhere (where
depends on the format), and replaced with a reference or hyperlink
to the footnote.
-->
<p>
脚注は普通エレメント内テキスト中に現れ、<tt><footnote>
<var/.../</footnote></> によって示されます。脚注の本文
そのものはその文書の形式にしたがってどこにでも出力でき、タグ
は脚注への参照やハイパーリンクで置き換えられます。
<!--
<p>
The contents of the footnote should be one or more paragraphs; the
start of the first paragraph need not be marked explicitly. Inline
markup elements such as character style do not take effect on the
contents of footnotes defined inside them - the footnote gets a
`clean slate'.
-->
<p>
脚注の内容は一つかそれ以上の段落から構成されていなければ
なりません。最初の段落は明白にマークされていなくても構いません。
キャラクタスタイルの指定のようなエレメント内マークアップ
エレメントは、そのエレメント中で定義された脚注の内容には
影響しません。すなわち、脚注は「過去を清算して」表示されます。
<!--
<p>
Footnotes may be nested, but this is rarely a good idea.
-->
<p>
脚注を入れ子にすることは可能ですが、止めておいたほうが無難です。
<!--
<chapt id="listexamp">Lists and examples
-->
<chapt id="listexamp">リストと例示
<!--
<sect>Lists
-->
<sect>リスト
<!--
<p>
There are three kinds of lists:
<list compact>
<item><tt/<list>/ - ordinary (bulleted) list;
<item><tt/<enumlist>/ - numbered list;
<item><tt/<taglist>/ - tagged list.
</list>
-->
<p>
３種類のリストが使用できます。
<list compact>
<item><tt/<list>/ - 通常の (先頭に印つき) リスト
<item><tt/<enumlist>/ - 番号つきリスト
<item><tt/<taglist>/ - タグつきリスト
</list>
<!--
<p>
Each entry in an ordinary or numbered list is an item introduced by
<tt/<item>/. Each entry in a tagged list is one or more
<tt/<tag>/s followed by an <tt/<item>/.
-->
<p>
通常のリストや番号つきリストに含まれるそれぞれの項目は
<tt/<item>/ で始まります。タグつきリストのそれぞれ
の項目は一つかそれ以上の <tt/<tag>/ タグで、その後から
<tt/<item>/ が続きます。
<!--
<p>
It is not necessary to mark the end of <tt/<tag>/s or
<tt/<item>/s.
-->
<p>
<tt/<tag>/ や <tt/<item>/ の終りにマークする必要
はありません。
<!--
<p>
All three types of list come in two flavours, depending on whether
you
specify the <tt/compact/ attribute (eg, <tt><taglist
compact></>) or not (eg, <tt/<enumlist>/). The
<tt/<tag>/ may contain only marked-up inline text.
-->
<p>
３種類のリストはすべて、<tt/compact/ 属性を指定する(例えば
<tt><taglist compact></>)かしないか(例えば
<tt/<enumlist>/)で二つの異なる形式をとることができます。
<tt/<tag>/ はマークアップされたエレメント内テキストだけを
含むことができます。
<!--
<p>
The compact versions are intended for use within paragraphs. The
formatter will not put gaps around the list or between
entries.<footnote>There is a problem with this in HTML. The HTML
formatter tries not to, by using HTML lists' <tt/compact/ attribute
on the lists it generates, but not many browsers understand it
properly.</footnote> The entries in a compact list should each
be a single paragraph (it is not necessary to mark the start of the
paragraph). Any lists inside a compact list should themselves be
marked compact (though the formatters will in fact infer for
themselves that they ought to be compact).
-->
<p>
「compact」、すなわち簡略版リストは段落内で使用することを
目的としています。
フォーマッタはリストの周りや項目の間にすき間をいれません。
<footnote>HTML 形式では問題が生じます。HTML 用フォーマッタは
すき間を作らないよう、 生成した HTML のリストで
<tt/compact/ 属性を指定しますが、しかしすべてのブラウザがこれを
正しく解釈できるとは限りません。</footnote>
簡略版リストの項目はそれぞれ単一の段落でなければなりません
(段落の開始をマークする必要はありません)。簡略版リスト内のいかなる
リストもそれら自身に compact 属性が指定されていなければなりません。
(マークしなくても、フォーマッタはそれらが「compact」
でなければならないと推測するでしょうが、した方が無難です)。
<!--
<p>
The non-compact versions are intended to stand as paragraphs
themselves. Each entry in such a list may contain more than one
paragraph (once again, the start of the first paragraph need not be
marked). The list is separated from the surrounding text, and the
entries from each other, by blank lines as would be expected for
paragraph breaks.
-->
<p>
簡略版でない形式のリストはそれ自身で段落を形成するように
なっています。そういったリストに含まれるそれぞれの項目は
段落を一つ以上含むことができます(もう一度繰り返しますが、
最初の段落の開始をマークする必要はありません)。
リストは段落を中断するのに適当なところへ空行を挿入することで
周りのテキストから分離され、項目もそれぞれ分離されます。
<!--
<sect id="examples">Examples
-->
<sect id="examples">例示
<!--
<p>
Examples - multi-line code fragements, scripts, and similar pieces
of computer text - are introduced with <tt/<example>/ and
finish with <tt></example></>.
-->
<p>
例示 - 含まれる内容が複数行にまたがるソースコードの断片、
スクリプト、またはその類のコンピュータテキストであることを示し、
<tt/<example>/ で始まり <tt></example></> で終ります。
<!--
<p>
The example will be formatted exactly as it is typed in, with
spacing and newlines reproduced. It will be displayed in a
fixed-width font, usually the one used for the <tt/<tt>/
character style, even if the formatter usually uses a proportional
font. Any indentation which is appropriate will be added by the
formatter; the example should be entered starting in the left hand
column.
-->
<p>
例示の内容は入力された通りにフォーマットされ、字間や改行はそのまま
保たれます。
例示では、フォーマッタが普段はプロポーショナルフォントを使う
としても、<tt/<tt>/ キャラクタスタイルで普通使われる
のと同じ固定幅フォントが使われます。
フォーマッタが適切に字下げを行いますので、例示は縦列の左端から
入力しなければなりません。
<!--
<p>
Examples may contain marked up character text but may not contain
cross-references or the character style elements <tt/<tt>/,
<tt/<prgn>/, <tt/<em>/, and <tt/<strong>/.
See <ref id="inline">.
-->
<p>
例示はマークアップされたキャラクタテキスト<footnote>訳注：
エレメント内テキストとどう違うんだろう？</footnote>を含むことは
できますが、他所参照やキャラクタスタイルを指定する
エレメント <tt/<tt>/ 、 <tt/<prgn>/、 <tt/<em>/、
<tt/<strong>/ などを含むことはできません。詳しくは
<ref id="inline">を参照してください。
<!--
<p>
An example does not produce a paragraph break; examples are
considered parts of paragraphs. If an example is to be a
paragraph on its own then paragraph start tags should be added as
appropriate.
-->
<p>
例示は段落を中断しません。例示は段落の一部と見なされます。
もし例示をそれ自身で一つの段落としたいなら、段落開始のタグを適切に
加える必要があります。
<!--
<p>
Any SGML markup characters in the example must be escaped as usual -
see <ref id="markup">. <tt/<example>/ does not work like TeX's
<tt/verbatim/ environment.
-->
<p>
例示エレメント内の SGML マークアップキャラクタは通常通りに
退避<footnote>訳注：どういう意味なんだろ。</footnote>
されていなければりません。
詳しくは <ref id="markup">を参照してください。
<tt/<example>/ は TeX の <tt/verbatim/ 環境とは違います。
</book>
</debiandoc>
Debiandoc-SGML マークアップ・マニュアル
---------------------------------------
Ian Jackson<ijackson@xxxxxxxxxxxxxx>
Ardo van Rangelrooij<ardo@debian.org>
八田真行<masayuki-h@xxxxxxxxxxxxxxx>
6 December 1998
0.1 目次
--------
1. SGML のマークアップとメタキャラクタ
2. 文書全体の構造
3. 章、節と段落
4. マークアップされたエレメント内テキストと
キャラクタスタイル指定マークアップ
4.1. キャラクタスタイル
4.2. 他所参照
4.3. 脚注
5. リストと例示
5.1. リスト
5.2. 例示
0.2 著作権表示
--------------
Copyright 1998 Ardo van Rangelrooij Copyright 1996 Ian Jackson
Copyright 1998 八田真行
このマニュアルも含めて、Debiandoc-SGML はフリーソフトウェアです。 Free
Software Foundation 発行の GNU General Public License (Version 2
かそれ以降)が定める条件の下で再配布及び変更が許されます。
このソフトウェアは有用であることを願って配布されるもの
ですが、*いかなる保証もありません。*すなわち、この
ソフトウェアが市場向きであるか、あるいは特定の目的に適合するか
どうかは、全く保証されません[1]。 詳しくは GNU General Public License
をご覧下さい。
[1] 訳注：どうもしっくりこない 訳です
GNU General Public License のコピーはあなたの Debian GNU/Linux
システム内の `/usr/doc/copyright/GPL' か、 debiandoc-sgml
のソースパッケージ中にファイル名 `COPYING'
として収録されているはずです。以上で挙げた場所 に存在しない場合には
Free Software Foundation に請求して下さい。 (住所： the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.)
-------------------------------------------------------------------------------
1. SGML のマークアップとメタキャラクタ
---------------------------------------
テキストエディタに入力した状態では、SGML 文書は エレメント[1]
の始点と終点を示すタグが散在するテキストです。
[1] 訳注：「要素」と訳すのも何か変だし…
タグ `<<element>>' があるエレメント <element>
の始点を示し、`</<element>> ' が終点を示します。
略記法がいくつか使えます。例えば、 `<<element>/<contents>/'
はあるエレメント <element> が <contents> という内容を含む
ことを意味します。ただし、内容 <contents> がスラッシュ `/'
を含んではいけません。また、 `</>'
は現在開いている中で最も内側のエレメントを閉じます。
エレメントを開始するタグのいくつかには属性を与えることができます。
これらの属性はエレメント開始タグを閉じるカギカッコよりも前に現れ、
エレメント名とは空白で区切られます。どのエレメント開始タグがどういう
属性を持ちうるかは各エレメント開始タグについて説明する際いっしょに
説明します。
もし本文中で SGML のマークアップキャラクタ(カギカッコ `<' `>' と
アンパサンド `&')を普通の文字として
使いたい場合には、特別な書き方で表現しなければなりません(これを SGML
の世界では「実体参照」といいます)。 `&<name>;' は実際にはその名称が
<name> である 文字を表現します。
良く使う文字の名称をいくつか挙げると、
`lt'
小なり(less than) 記号 (左かぎカッコ) `<'
`gt'
大なり(greater than) 記号 (右かぎカッコ) `>'
`amp'
アンパサンド `&'
`copy'
著作権記号 `
これらの名称は全て linuxdoc-sgml から 借用したもので、linuxdoc-sgml の
`rep/latin1/general' というファイルに記載されています。
ISO-LATIN-1 において文字コード番号が <number> である文字
を表現するのに、 `&#<number>;' という書き方もできます。 <number>
は十進法表記でなければなりません。
-------------------------------------------------------------------------------
2. 文書全体の構造
------------------
文書の最初の一行は、この文書が Debiandoc-SGML
ファイルであることを示すため
<!doctype debiandoc system>
でなければなりません。
文書は `<book>' タグで始まり、`</book>' タグで終ります。
`<book>' タグの後には `<title>' がきて、一つか それ以上の `<author>'
と `<email>' のペアがそれに 続きます。必須ではありませんが `<version>'
を使うことも
できます。これらエレメントのそれぞれは一片のマークアップされた
エレメント内テキスト(詳しくはchapter 4,
`マークアップされたエレメント内テキストと
キャラクタスタイル指定マークアップ '参照)です。 `<version>'
は文書が整形された日付を表す `<date>' を含むこともできます。
そのあとに文書の摘要 `<abstract>' 、著作権表示 `<copyright>'
、そして目次 `<toc>' の ３種のマーカがそれぞれ一つずつきます。
文書の摘要 `<abstract>' は段落を一つ含みます。
著作権表示 `<copyright>' は著作権表示の要約(例えば、 すべての HTML
ページの一番下に表示されるのがこれです)を含み、
その後本文として一つかそれ以上の段落が続きます。本文最初の段落は
要約と区別するために `<p>' タグで明示されていなければ なりません。
`<toc>' マーカは生成される目次を示します。 目次の内容は SGML
を処理する過程で生成されるので、`<toc>' の中身を SGML
ソース中で記述する必要はありません。 `<toc>'
に属性を指定することで、出力される目次の内容の詳細を
指定することができます。例えば、`<toc sect1>' は節も
目次に含めることを、また `<toc chapt>' は章のみが
目次に含められることを指定します。とりうる属性の値は `chapt',
`sect'、`sect1'、`sect2'の３つです。
以上に続いて文書の本文が現れます。本文は一つかそれ以上の 章 `<chapt>'
で構成されます。
表題 `<title>'、著者名(複数可) `<author>'、文書の バージョン
`<version>'、文書の摘要 `<abstract>'、 著作権表示 `<copyright>'
の４つのエレメントの
終りにはマークをつける必要がありません。次のエレメントが次の行から
始まる、ということでそのエレメントの終りを暗に示せるからです。
-------------------------------------------------------------------------------
3. 章、節と段落
----------------
それぞれの章は `<chapt>' タグで始まり、その後には
章の表題がきます。表題はマークアップされたエレメント内テキスト
を含むことができますが、他所参照を含んではいけません (詳しくは chapter
4, `マークアップされたエレメント内テキストと
キャラクタスタイル指定マークアップ ' を参照)。
章の内容は普通いくつかの段落から構成されますが、全く段落が無くても
構いません。最初の段落は表題と区別するため `<p>' タグで明確
に指定されていなければならず、その後段落がいくつか続きます。
節は `<sect>' で始まり、章と似たような構造を
持ちます。すなわち、節は表題を含み、
場合によってはいくつかの段落、あるいはいくつかの小節を
含むこともできます。
小節は `<sect1>' で表されますが、もっと細かい 区分を表すためには
`<sect2>', `<sect3>' や `<sect4>' も使えます。
段落は `<p>' で始まります。しばしば段落の最初のタグ は省略されますが、
`<chapt>' や `<sect>' など のタグの後では必須です。段落の最後を `</p>'
で指定 する必要は全くありません。
段落はマークアップされたエレメント内テキスト(詳しくは chapter 4,
`マークアップされたエレメント内テキストと
キャラクタスタイル指定マークアップ '
を参照)、あるいはリストや例示も含む ことができます(詳しくは chapter 5,
`リストと例示 ' を参照)。
-------------------------------------------------------------------------------
4. マークアップされたエレメント内テキストとキャラクタスタイル指定マークアップ
----------------------------------------------------------------------------
通常のテキスト(この文書中では「エレメント内テキスト」と呼びます)は
特別な体裁や他所参照を指定するためのエレメントを
含むことができます。エレメント内テキストは章や節の表題や
著作権表示の要約、段落の中など様々な場所に現れます。
4.1. キャラクタスタイル
------------------------
テキストのある部分が特に重要だということを示すエレメントが
数多く存在します。それらのエレメントでは、 終点を明示する
`</<element>>' タグ、最も内側の
エレメントを閉じる省略された形の終点タグ `</>'、または
最も省略された形のエレメントマークアップを終らせる スラッシュ `/'
のうち、必ずどれかを使って終点を はっきりと指定しなければなりません
(詳しくはchapter 1, `SGML のマークアップとメタキャラクタ 'を参照)。
[1]
`<em>' - 強調
含まれるテキストがそれを取り巻く他の部分よりも重要であることを
示します。
[1] 訳注：ここも言ってることはなんとなくわかるものの
うまく訳せません
普通これはイタリック体が使えればイタリック体で表現されますが、
太字や下線を引くことで表現されることもあり、あるいは
文字そのものを強調することができない標準テキスト
形式の場合にはテキストをアスタリスクで挟んで、 *こんな感じ*
にします。
`<strong>' - もっと強い強調
含まれるテキストがそれを取り巻く他の部分よりもはるかに重要
なので、`<em>' よりもっと目立たせたいとき 使います。
普通これは太字が使えれば太字で表現されますが、文字
そのものを強調することができない標準テキスト形式の場合には
テキストをアスタリスクで挟んで *こんな感じ* にします。
`<var>' - メタ構文的変数
含まれるテキストがメタ構文的変数[1]
であることを示します。すなわち、そのテキストがあるものの
名前か構文の断片をを表していて、実際に使われる時には現実の値で
置き換えられることを示しています。 [2]
[1] 訳注：どう訳した ものやら…
[2] 訳注：ようするに $ command foo とかいうときの foo
のことか？うまい訳が浮かびません。
普通これはイタリック体で表現されますが、標準テキスト形式
ではそのテキストを <このように> カギカッコで囲んで 表現します。
もしいくつかのメタ構文的変数が次々に現われるならば、それぞれ を
`<var>' エレメントとして指定しなければ なりません。
`<prgn>' - プログラムや有名なファイルの名称
含まれるテキストがプログラムの名前や、有名な[1]
ファイル名(普通はパスを除いた形)、あるいは関数など
コンピュータ内で特定の名前を持つものであることを示します。
[1] 訳注： 何か変ですよね？
文字の強調や様々なフォントスタイルが利用可能な出力形式
においては、普通これは固定幅フォントで表現されます。
標準テキスト形式においてはこれらの名前は特にマーク
されません。というのも、これらはひんぱんに現れるので、
いちいち引用を始める[1]のはテキストの流れを阻害するからです。
[1] 訳注：何か変ですよね？
`<tt>' - パス名、ソースコードあるいは出力結果の 断片、コマンド書式
含まれるテキストが、一般にコンピュータから出力されたか、
入力される文字列であることを示します。
フルパス名、あるいはソースコードの断片といった、
エレメント内にワードラップして表示したいテキストに使うのが
妥当です(他のやり方として section 5.2, `例示 ' もあります)。
これらの文字列内で、文字列をそばのエレメントではなく むしろ
`<tt>' エレメントの一部分にしたいというとき
など、メタ構文的変数を使わなければいけないということがよく
あります。[1]
[1] 訳注：意味不明です。
普通これは固定幅フォントを用いて表されます。
標準テキスト形式では引用[1]が エレメントの周りに使われます。
[1] 訳注：何か変。
`<qref id="<refid>">' - 暗黙の参照
指定された参照識別子(詳しくはsection 4.2, `他所参照 '参照)への
「暗黙の参照」[1]を生成します。これは、邪魔にならないならここで互
他所参照使うと便利そうなんだけど、でもどうしても必要ってわけ
でもないし、テキストに無理やり押し込むのもなあ…というような
時に使うとよいでしょう。
[1] 訳注：これも何かおかしいですよね。
テキストの特定の領域をエレメント内テキストを入れることなく
[1]ハイパーリンク
にすることで他所参照を目立たなくすることができる
出力形式では、このエレメントは含まれるテキストを
他所参照の対象へのハイパーリンクにします。
そうでない出力形式ではこのエレメントは何の効果も持ちません。
[1] 訳注：意味不明です。
4.2. 他所参照
--------------
同じ文書の他の部分、あるいは他の文書への他所参照を導く
エレメントは数多く存在します。
文書内の他所参照は参照識別子構造[1]を基にしています。
章、節、小節などにはそれぞれに `id' 属性を与えることで
参照識別子を指定できます。例えば、 `<chapt id="spong">'
はそのタグで始まる章が参照識別子 `spong' を持つことを示して
います。この参照識別子を特別な他所参照エレメントで指定する
ことで、文書の他の部分からこの章を参照することができるのです。
[1] 訳注：うーんもう少し 何とかならんかな
参照識別子は HTML のように複数のファイルに分けて
出力する出力形式で使われるファイル名や参照シンボルを生成するのにも
使われます。 参照識別子が一つも指定されていない場合には、章番号
あるいは節番号が使われます。何はともあれすべての章に参照識別子を
つけておくと、文書内で章や節の順番を変えても出力ファイル名
が変わらないので便利でしょう。
`<ref id="<refid>">' - 文書内の他所参照
同じ文書中の、参照識別子 <refid> が指定された節や
章への他所参照を生成します。
`<ref>' エレメントは内容を一切含みません。
節や章の番号と表題、そのページ番号などで出力
形式に適切なものは、タグの現われた所に挿入されます。
統語論的には、他所参照は名詞で[1]、`(<ref id="<...>">
をご覧下さい)' とか `詳しくは <ref id="<...>"> を。' といった
使い方に適します。
[1] 訳注：なんのこっちゃ。
`<manref name="<name>" section="<section>">' - マニュアルページ
セクション <section> の <name> というマニュアルページ
への他所参照を生成します。このタグは内容を含みません。
ページを説明するテキスト、典型的には `<name> (<section>)'
といったものですが、これらは `<manref>'
タグのある地点に挿入されます。
`<email>' - 電子メールアドレス
含まれるテキストが電子メールのアドレスであることを示します。
タグの内容は電子メールのアドレスを記述したテキスト自身のみで、
キャラクタスタイル指定マークアップや他所参照は禁止です。普通
終了タグ `</email>' は省略できませんが、 もし 一番最後の
`<author>' の中で使うなら、 次のエレメントの開始により `<author>'
と `<email>' の終りを両方暗に示せるので 省くことができます。
いくつかの出力形式においては、本当の他所参照、
(例えば)引用されたアドレスに電子メールを
送ることができるようなハイパーリンクを生成します。
他の出力形式では、単にテキストを特別にマークするだけで、
普通はカギカッコ `<' `>' で囲むだけです。
`<ftpsite>' - 匿名 FTP サイト名
`<ftppath>' - 最後に行った FTP サイトにおけるパス
`<ftpsite>' はエレメントの内容が匿名 FTP サイトの DNS
名であることを、 `<ftppath>' はその
サイトにおけるパス名であることを示します。
両者ともキャラクタスタイル指定マークアップや他所参照を含んでは
いけません。
普通両者は固定幅フォントで表わされます。もし可能ならば、
`<ftppath>' は最後にアクセスした `<ftpsite>'
上の指定されたファイルかディレクトリを
実際に指すハイパーリンクになります[1]
[1] 「最も最近の FTP サイト上の」とはどういうことなのだろうか？
同一の章では `<ftppath>' に先だって必ず `<ftpsite>'
が現われますが、一旦あるサイトが
指定されるといくつかのパスが現われるかも知れません。 [1]
[1] 訳注：うーむ。意味不明だ。
4.3. 脚注
----------
脚注は普通エレメント内テキスト中に現れ、`<footnote> <...></footnote>'
によって示されます。脚注の本文
そのものはその文書の形式にしたがってどこにでも出力でき、タグ
は脚注への参照やハイパーリンクで置き換えられます。
脚注の内容は一つかそれ以上の段落から構成されていなければ
なりません。最初の段落は明白にマークされていなくても構いません。
キャラクタスタイルの指定のようなエレメント内マークアップ
エレメントは、そのエレメント中で定義された脚注の内容には
影響しません。すなわち、脚注は「過去を清算して」表示されます。
脚注を入れ子にすることは可能ですが、止めておいたほうが無難です。
-------------------------------------------------------------------------------
5. リストと例示
----------------
5.1. リスト
------------
３種類のリストが使用できます。
* `<list>' - 通常の (先頭に印つき) リスト
* `<enumlist>' - 番号つきリスト
* `<taglist>' - タグつきリスト
通常のリストや番号つきリストに含まれるそれぞれの項目は `<item>'
で始まります。タグつきリストのそれぞれ の項目は一つかそれ以上の
`<tag>' タグで、その後から `<item>' が続きます。
`<tag>' や `<item>' の終りにマークする必要 はありません。
３種類のリストはすべて、`compact' 属性を指定する(例えば `<taglist
compact>')かしないか(例えば
`<enumlist>')で二つの異なる形式をとることができます。 `<tag>'
はマークアップされたエレメント内テキストだけを 含むことができます。
「compact」、すなわち簡略版リストは段落内で使用することを
目的としています。
フォーマッタはリストの周りや項目の間にすき間をいれません。 [1]
簡略版リストの項目はそれぞれ単一の段落でなければなりません
(段落の開始をマークする必要はありません)。簡略版リスト内のいかなる
リストもそれら自身に compact 属性が指定されていなければなりません。
(マークしなくても、フォーマッタはそれらが「compact」
でなければならないと推測するでしょうが、した方が無難です)。
[1] HTML 形式では問題が生じます。HTML 用フォーマッタは
すき間を作らないよう、 生成した HTML のリストで `compact'
属性を指定しますが、しかしすべてのブラウザがこれを
正しく解釈できるとは限りません。
簡略版でない形式のリストはそれ自身で段落を形成するように
なっています。そういったリストに含まれるそれぞれの項目は
段落を一つ以上含むことができます(もう一度繰り返しますが、
最初の段落の開始をマークする必要はありません)。
リストは段落を中断するのに適当なところへ空行を挿入することで
周りのテキストから分離され、項目もそれぞれ分離されます。
5.2. 例示
----------
例示 - 含まれる内容が複数行にまたがるソースコードの断片、
スクリプト、またはその類のコンピュータテキストであることを示し、
`<example>' で始まり `</example>' で終ります。
例示の内容は入力された通りにフォーマットされ、字間や改行はそのまま
保たれます。
例示では、フォーマッタが普段はプロポーショナルフォントを使う
としても、`<tt>' キャラクタスタイルで普通使われる
のと同じ固定幅フォントが使われます。
フォーマッタが適切に字下げを行いますので、例示は縦列の左端から
入力しなければなりません。
例示はマークアップされたキャラクタテキスト[1]を含むことは
できますが、他所参照やキャラクタスタイルを指定する エレメント `<tt>'
、 `<prgn>'、 `<em>'、 `<strong>' などを含むことはできません。詳しくは
chapter 4, `マークアップされたエレメント内テキストと
キャラクタスタイル指定マークアップ 'を参照してください。
[1] 訳注： エレメント内テキストとどう違うんだろう？
例示は段落を中断しません。例示は段落の一部と見なされます。
もし例示をそれ自身で一つの段落としたいなら、段落開始のタグを適切に
加える必要があります。
例示エレメント内の SGML マークアップキャラクタは通常通りに 退避[1]
されていなければりません。 詳しくは chapter 1, `SGML
のマークアップとメタキャラクタ 'を参照してください。 `<example>' は
TeX の `verbatim' 環境とは違います。
[1] 訳注：どういう意味なんだろ。
-------------------------------------------------------------------------------
Debiandoc-SGML マークアップ・マニュアル
Ian Jackson<ijackson@xxxxxxxxxxxxxx>, Ardo van
Rangelrooij<ardo@debian.org>, 八田真行<masayuki-h@xxxxxxxxxxxxxxx> - 6
December 1998