Writing I-Ds and RFCs using XML

XML を使って I-D や RFC を書く

Status of this Memo

このメモの位置付け

This memo provides information for the Internet community. It does not specify an Internet standard of any kind. Distribution of this memo is unlimited.

このメモは、 Internet 社会に情報を提供します。いかなる種類の Internet 標準を規定するものでもありません。このメモの配布は制限しません。

Abstract

概要

This memo presents a technique for using XML (Extensible Markup Language) as a source format for documents in the Internet-Drafts (I-Ds) and Request for Comments (RFC) series.

このメモは、 XML (拡張マーク付け言語) を Internet-Draft (I-D) や Request for Comments (RFC) 系列の文書の原形式として使用する手法を説明します。

1. Introduction

1. はじめに

This memo describes how to write a document for the I-D and RFC series using the Extensible Markup Language  [1] (XML). This memo has three goals:

このメモは、 I-D および RFC 系列の文書を拡張マーク付け言語  [1] (XML) を使って書く方法を説明します。このメモには、三つの目的があります。

  1. To describe a simple XML Document Type Definition (DTD) that is powerful enough to handle the simple formatting requirements of RFC-like documents whilst allowing for meaningful markup of descriptive qualities.

    意味マーク付けの記述品質が可能な RFC 型文書の単純な書式づけ要件を取り扱うのに十分強力である XML 文書型定義 (DTD) の説明

  2. To describe software that processes XML source files, including a tool that produces documents conforming to RFC 2223  [2] , HTML format, and so on.

    RFC 2223  [2] に適合する文書, HTML 形式, その他を生成する道具を含む、 XML 源ファイルを処理するソフトウェアの説明

  3. To provide the proof-of-concept for the first two goals (this memo was written using this DTD and produced using that software).

    前述の2つの目的の概念の証明の提供 (このメモはその DTD を使って執筆され、そうしたソフトウェアを使って生成されました。)

It is beyond the scope of this memo to discuss the political ramifications of using XML as a source format for RFC-like documents. Rather, it is simply noted that adding minimal markup to plain text:

RFC 的文書の源形式として XML を使うことの政治的議論はこのメモの適用範囲外です。それよりも、平文 (plain text) に最小のマーク付けを加えることで、

ということを単に記すものです。

2. Using the DTD to Write I-Ds and RFCs

2. I-D や RFC を書くのに DTD を使う

We do not provide a formal or comprehensive description of XML. Rather, this section discusses just enough XML to use a Document Type Declaration (DTD) to write RFC-like documents.

XML についての正式な、あるいは包括的な説明はしません。 この節では、 RFC 的文書を書くための文書型宣言 (DTD) を使うのに必要なだけの話をします。

If you're already familiar with XML, skip to section 2 to look at the DTD.

XML について既によく分かっているなら、 附属書Bに飛んで、 DTD を御覧下さい。

2.1. XML basics

2.1. XML の基礎

There are very few rules when writing in XML, as the syntax is simple. There are five terms you'll need to know:

XML は構文が簡単なので、書く時に必要なのはほんの少しの規則だけです。知っておくべきことは5つあります。

  1. An “element” usually refers to a start tag, an end tag, and all the characters in between, e.g., "<example>text and/or nested elements</example>"

    「要素」は通常開始タグと終了タグ、それに間の全ての文字、例えば 「<例>文字とか入れ子の要素</例>」 を指します。

  2. An "empty element" combines the start tag and the end tag, e.g., "<empty/>". You don't find these in HTML.

    「空要素」は開始タグと終了タグがくっついて、 「<空/>」 のようになります。 HTML にはこれはありません。

  3. An "attribute" is part of an element. If present, they occur in the start tag, e.g., "<example name='value'>". Of course, they can also appear in empty elements, e.g., "<empty name='value'/>".

    「属性」は要素の一部です。存在する場合、開始タグ中に、 「<例 名前='値'>」 の様に現れます。もちろん、空要素中でも 「<空 名前='値'/>」 の様に使えます。

  4. An "entity" is a textual macro that starts with "&". Don't worry about these, you'll only use them whenever you want to put a "&" or a "<" in your text.

    「実体」は文字マクロで、「&」で始まります。 な〜に心配しなさんな、「&」や「<」を文中に入れたい時にだけいつでも使うことが出来ます。

  5. A "token" is a string of characters. The first character is either a letter or an underscore ("_"). Any characters that follow are either letters, numbers, an underscore, or a period (".").

    「字句 (token)」 は文字の列です。最初の文字は文字か下線 (「_」) です。その後の文字は文字、数字、下線、句点 (「.」) です。 (訳注:ここで文字とは、26×2種類の基本ラテン字母のことです。)

 

First, start your source file with an XML declaration, a reference to the DTD, and the "rfc" element:

最初に、源ファイルは XML 宣言, DTD への参照, 「rfc」要素で始めます。

    <?xml version="1.0"?>
    <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
    <rfc>
        ...
    </rfc>

Ignore the first two lines ―― the declaration and the reference ―― and simply treat them as opaque strings. Nothing else should be present after the "</rfc>" tag.

最初の2行 (宣言と参照) は無視し、単に呪文だと思って下さい。 「</rfc>」タグの後には何も現れるべきではありません。 (訳注:rfc 要素については、 附属書A に説明があります。)

Second, make sure that all elements are properly matched and nested. A properly matched element that starts with "<example>" is eventually followed with "</example>". (Empty elements are always matched.) Elements are properly nested when they don't overlap.

二番目に、全ての要素が適切に対応・入れ子になっているか確かめて下さい。 「<例>」 で始まる適切に対応する要素は、最終的には 「</例>」 が続くことになります。 (空要素は常に対応しています。) 各要素は重複していない時で適切に入れ子になっています。

 

For example,

例えば、

    <outer>
        ...
        <inner>
            ...
        </inner>
        ...
    </outer>

is properly nested.

は適切に入り組んでいます。

 

However,

しかし、

    <outer>
        ...
        <inner>
            ...
        </outer>
        ...
    </inner>

overlaps, so the elements aren't properly nested.

は重なっているので、要素は正しく入れ子になっていません。

Third, never use "<" or "&" in your text. Instead, use either "&lt;" or "&amp;", respectively.

三番目に、「<」や「&」を文中に使ってはいけません。代わりに、それぞれ「&lt;」と「&amp;」を使います。

Fourth, there are two quoting characters in XML, 'apostrophe' and "quotation". Make sure that all attributes values are quoted, e.g., "<example name='value'>", If the value contains one of the quoting characters, then use the other to quote the value, e.g., "<example name='"'>", If the value contains both quoting characters, then use one of them to quote the value, and replace occurrances of that character in the attribute value with either '&apos;' (apostrophe) or "&quot;" (quotation), e.g., "<example name='"&apos;"'>".

四番目に、 XML では 'アポストロフィ' と "引用" の二種類の引用文字があります。全ての属性値を、 「6lt;例 名前='値'>」 の様に引用符で囲むことを確認して下さい。値に引用文字の一方が使われている時は、 「<例 名前='"'>」 の様に他方を値を囲むのに使います。 値が引用文字の両方を含んでいる場合、どちらかを値を囲むのに使い、属性値に使われている文字を '&apos;' (アポストロフィ) または "&quot;" (引用) に置き換えて、 「<例 名前='"&apos;"'>"」 のようにします。

 

If you want to put a comment in your source file, here's the syntax:

源ファイルに注釈を入れたい時は、次の構文の様にします。

        <!-- comments can be multiline,
         if you wish -->

        <!-- 注釈行は、必要なら
         複数行に出来ます。 -->
(訳注:また、注釈中に「--」を使ってはいけません。)

Finally, XML is case sensitive.

五番目に、 XML は大文字と小文字を区別します。

2.2. Front matter

 

Immediately following the "<rfc>" tag is the "front" element:

"<rfc>" タグの直ぐ後に続くのは "front" 要素です。

    <?xml version="1.0"?>
    <!DOCTYPE rfc SYSTEM "rfc2629.dtd">
    <rfc>
        <front>
            <title ...>
            <author ...>
            <author ...>
            <date ...>
            <area ...>
            <workgroup ...>
            <keyword ...>
            <keyword ...>
            <abstract ...>
            <note ...>
        </front>
        ...
    </rfc>

(Note that in all examples, indentation is used only for expository purposes.)

(全ての例で、字下げは説明のためだけに使っていることに注意して下さい。)

The "front" element consists of a "title" element, one or more "author" elements, a "date" element, one or more optional "area" elements, one or more optional "workgroup" elements, one or more optional "keyword" elements, an optional "abstract" element. and, one or more optional "note" elements.

"front" 要素は "title" 要素, 1つ以上の "author" 要素, "date" 要素, 1つ以上の省略可能な "area" 要素, 1つ以上の省略可能な "workgroup" 要素, 1つ以上の省略可能な "keyword" 要素, 省略可能な "abstract" 要素, 1つ以上の省略可能な "note" 要素から成ります。

2.2.1. The title Element

2.2.1. title 要素

 

The "title" element identifies the title of the document. Because the title will be used in the headers of the document when formatted according to [2] , if the title is more than 42 characters, then an abbreviation should also be provided, e.g.,

"title" 要素は、文書の題を識別します。題は [2] に従って整形する時に文書の頭に使われるので、題は42文字以上の時は、省略形も与えるべきです。例えば、次のようにします。

    <title abbrev="Much Ado about Nothing">
    The IETF's Discussion on "Source Format of RFC Documents"
    </title>

2.2.2. The author Element

2.2.2. author 要素

 

Each "author" element identifies a document author. Since a document may have more than one author, more than one "author" element may be present. If the author is a person, then three attributes must be present in the "<author>" tag, "initials", "surname", and "fullname", e.g.,

各 "author" 要素は、文書の要素を識別します。文書には複数人の著者がい得ますので、複数の "author" 要素を使うことが出来ます。著者が人物である時は、 "initials" (頭文字), "surname" (姓), "fullname" (全名) の3つの属性が "author" タグになければなりません。例えば、次の様にします。

    <author initials="M.T." surname="Rose"
            fullname="Marshall T. Rose">

The "author" element itself consists of an "organization" element, and, an optional "address" element.

"author" 要素自身は "organization" 要素と、省略可能な "address" 要素から成ります。

 

The "organization" element is similar to the "title" element, in that an abbreviation may be paired with a long organization name using the "abbrev" attribute, e.g.,

"organization" 要素は "title" 要素と同じ様に、長い組織名に "abbrev" 属性を使って次の例の様に省略名を指定することが出来ます。

    <organization abbrev="ISI">
        USC/Information Sciences Institute
    </organization>

The "address" element consists of an optional "postal" element, an optional "phone" element, an optional "facsimile" element, an optional "email" element, and, an optional "uri" element.

"address" 要素は省略可能な "postal" 要素, 省略可能な "phone" 要素, 省略可能な "facsimile" 要素, 省略可能な "email" 要素, 省略可能な "uri" 要素から成ります。

 

The "postal" element contains one or more "street" elements, followed by any combination of "city", "region" (state or province), "code" (zipcode or postal code), and "country" elements, e.g.,

"postal" 要素は次の例の様に、1つ以上の "street" 要素, それに続く "city", "region" (州や地方), "code" (郵便番号), "country" 各要素の自由な組合せから成ります。

    <postal>
        <street>660 York Street</street>
        <street>M/S 40</street>
        <city>San Francisco</city> <region>CA</region>
        <code>94110</code>
        <country>US</country>
    </postal>

This flexibility is provided to allow for different national formats for postal addresses. Note however, that although the order of the "city", "region", "code", and "country" elements isn't specified, at most one of each may be present. Regardless, these elements must not be re-ordered during processing by an XML application (e.g., display applications must preserve the ordering of the information contained in these elements). Finally, the value of the "country" element should be a two-letter code from ISO 3166.

この柔軟さにより、異なった国家郵便住所形式が使えます。 しかし、 "city", "region", "code", "country" 各要素の順序は規定していませんが、この内のせいぜい1つは出現するかもしれないことに注意して下さい。とにかく、これらの要素は XML 応用の処理の過程で順序を入れ替えてはなりません。 (例えば、表示応用はこれらの要素に含まれる情報の順序を保たなければなりません。) 最後に、 "country" 要素の値は ISO 3166 の2文字符号とするべきです。

 

The "phone", "facsimile", "email", and "uri" elements are simple, e.g.,

"phone", "facsimile", "email", "uri" 各要素は簡単で、次の様な感じです。

    <phone>+1 415 695 3975</phone>
    <email>mrose@not.invisible.net</email>
    <uri>http://invisible.net/</uri>

2.2.3. The date Element

2.2.3. date 要素

 

The "date" element identifies the publication date of the document. It consists of a month and a year, e.g.,

"date" 要素は文書の出版の日付を示します。次のように月と年から成ります。

    <date month="February" year="1999" />

The "date" element also has an optional day attribute.

"date" 要素には省略可能な day 属性もあります。

2.2.4. Meta Data Elements

2.2.4. メタ・データ要素

The "front" element may contain meta data ―― the content of these elements does not appear in printed versions of the document.

"front" 要素はメタ・データ (内容は文書の印刷版には出現しないもの) も含むことが出来ます。

 

A document has one or more optional "area", "workgroup" and "keyword" elements, e.g.,

文書は1つ以上の省略可能な "area", "workgroup", "keyword" 各要素を次の例の様に持ちます。

    <area>General</area>
    <workgroup>RFC Beautification Working Group</workgroup>
    <keyword>RFC</keyword>
    <keyword>Request for Comments</keyword>
    <keyword>I-D</keyword>
    <keyword>Internet-Draft</keyword>
    <keyword>XML</keyword>
    <keyword>Extensible Markup Language</keyword>

The "area" elements identify a general category for the document (e.g., one of "Applications", "General", "Internet", "Management", "Operations", "Routing", "Security", "Transport", or "User"), while the "workgroup" elements identify the IETF working groups that produced the document, and the "keyword" elements identify useful search terms.

"area" 要素は文書の一般分類 ("Applications" (応用), "General" (一般), "Internet", "Management" (経営), "Operations" (作業), "Routing" (経路), "Security" (保安), "Transport" (輸送), "User" (利用者)) を示し、 "workgroup" 要素は文書を出した IETF 作業部会を示し、 "keyword" 要素は有用な検索語を示します。

2.2.5. The abstract Element

2.2.5. abstract 要素

 

A document may have an "abstract" element, which contains one or more "t" elements . In general, only a single "t" element is present, e.g.,

文書には "abstract" 要素を使うことが出来て、 それには1つ以上の "t" 要素が含められます。通常、次の例の様に、 "t" 要素を1つだけ使います。

    <abstract>
        <t>This memo presents a technique for using XML
        (Extensible Markup Language) as a source format
        for documents in the Internet-Drafts (I-Ds) and
        Request for Comments (RFC) series.</t>
    </abstract>

    <abstract>
        <t>このメモは、 XML (拡張マーク付け言語) を 
        Internet-Draft (I-D) や Request for Comments (RFC) 
        系列の文書の原形式として使用する手法を説明します。</t>
    </abstract>

2.2.6. The note Element

2.2.6. note 要素

 

A document may have one or more "note" elements, each of which contains one or more "t" elements . There is a mandatory "title" attribute. In general, the "note" element contains text from the IESG, e.g.,

文書には1つ以上の "note" 要素を使うことが出来て、 それぞれ1つ以上の "t" 要素が含められます。必須の "title" 属性があります。通常、 "note" 要素は IESG からの文を次の例の様に入れます。

    <note title="IESG Note">
        <t>The IESG has something to say.</t>
    </note>

    <note title="IESG 注記">
        <t>IESG は特に言うことはありません。</t>
    </note>

2.2.7. Status, Copyright Notice, Table of Contents

2.2.7. 位置付け, 著作権表示, 目次

Note that text relating to the memo's status, copyright notice, or table of contents is not included in the document's markup ―― this is automatically inserted by an XML application when it produces either a text or HTML version of the document.

メモの位置付けを説明する文章, 著作権表示, 目次は文書のマーク付けには含めません。これは XML 応用が文書の text 版や HTML 版を生成する時に自動的に挿入されます。

2.2.7.1. Conformance with RFC 2026

2.2.7.1. RFC 2026 への適合性

If an Internet-Draft is being produced, then the "ipr" attribute should be present in the "<rfc>" tag at the beginning of the file. The value of the attribute should be one of:

Internet-Draft が生成される場合に、 "ipr" 属性がファイルのはじめの "<rfc>"タグに現れるべきです。この属性の値は次のいずれかであるべきです。

full2026:

indicating that the document is in full conformance with all the provisions of Section 10 of RFC 2026;

文書が RFC 2026第10章 の全ての要件に完全に適合することを示します

noDerivativeWorks2026:

indicating that the document is in full conformance with all the provisions of Section 10 of RFC 2026 except that the right to produce derivative works is not granted; or,

文書が、派生的作業の生成が認められていないことを除いて、 RFC 2026第10章 の全ての要件に完全に適合することを示します

none:

indicating that the document is NOT offered in accordance with Section 10 of RFC 2026, and the author does not provide the IETF with any rights other than to publish as an Internet-Draft.

文書が RFC 2026第10章 に従っておらず、著者は IETF に Internet-Draft として発行する以外のいかなる権利をも提供しないことを示します

In the latter case, a copyright notice will not be automatically inserted during processing by an XML application.

後者の場合では、著作権表示は XML 応用により自動的には挿入されません。 (訳注:後者 (the latter case) とは最後の場合のみ? rfc2629.xslt ではどの場合でも挿入されるようですが...)

Consult [3] for further details.

詳しくは [3] を調べて下さい。

 

Finally, if the Internet-Draft is being submitted to an automated process, then the "docName" attribute should be present in the "<rfc>" tag at the beginning of the file. The value of this attribute contains the document (not file) name associated with this Internet-Draft, e.g.,

最後に、 Internet-Draft が自動処理に回された時は、 "docName" 属性がファイルのはじめの "<rfc>" タグ中に出現するべきです。 この属性の値は Internet-Draft につけられた文書 (ファイルでなしに) の名前で、次の様になります。

    <rfc ipr="full" docName="draft-mrose-writing-rfcs-01">
        ...
    </rfc>

2.2.8. Everything in the Front

2.2.8. Front 全体

 

So, putting it all together, we have, e.g.,

以上をまとめると次の様になります。

    <front>
        <title>Writing I-Ds and RFCs using XML</title>
    
        <author initials="M.T." surname="Rose"
                fullname="Marshall T. Rose">
            <organization>Invisible Worlds, Inc.</organization>
    
            <address>
                <postal>
                    <street>660 York Street</street>
                    <street>M/S 40</street>
                    <city>San Francisco</city> <region>CA</region>
                    <code>94110</code>
                    <country>US</country>
                </postal>
    
                <phone>+1 415 695 3975</phone>
                <email>mrose@not.invisible.net</email>
                <uri>http://invisible.net/</uri>
            </address>
        </author>
    
        <date month="February" year="1999" />
    
        <area>General</area>
        <workgroup>RFC Beautification Working Group</workgroup>
        <keyword>RFC</keyword>
        <keyword>Request for Comments</keyword>
        <keyword>I-D</keyword>
        <keyword>Internet-Draft</keyword>
        <keyword>XML</keyword>
        <keyword>Extensible Markup Language</keyword>
        <abstract>
            <t>This memo presents a technique for using XML
            (Extensible Markup Language) as a source format
            for documents in the Internet-Drafts (I-Ds) and
            Request for Comments (RFC) series.</t>
        </abstract>
    </front>

    <front>
        <title>XML を使って I-D や RFC を書く</title>
    
        <author initials="M.T." surname="Rose"
                fullname="Marshall T. Rose">
            <organization>Invisible Worlds, Inc.</organization>
    
            <address>
                <postal>
                    <street>660 York Street</street>
                    <street>M/S 40</street>
                    <city>San Francisco</city> <region>CA</region>
                    <code>94110</code>
                    <country>US</country>
                </postal>
    
                <phone>+1 415 695 3975</phone>
                <email>mrose@not.invisible.net</email>
                <uri>http://invisible.net/</uri>
            </address>
        </author>
    
        <date month="February" year="1999" />
    
        <area>General</area>
        <workgroup>RFC 美化作業部会</workgroup>
        <keyword>RFC</keyword>
        <keyword>Request for Comments</keyword>
        <keyword>I-D</keyword>
        <keyword>Internet-Draft</keyword>
        <keyword>XML</keyword>
        <keyword>拡張マーク付け言語</keyword>
        <abstract>
            <t>このメモは、 XML (拡張マーク付け言語) を 
            Internet-Draft (I-D) や Request for Comments (RFC) 
            系列の文書の原形式として使用する手法を説明します。</t>
        </abstract>
    </front>

2.3. The Middle

 

The "middle" element contains all the sections of the document except for the bibliography and appendices:

"middle" 要素は参考文献と附属書を除く文書の全ての節から成ります。

    ...
    </front>
    <middle>
        <section ...>
        <section ...>
        <section ...>
    </middle>
    <back>
    ...

The "middle" element consists of one or more "section" elements.

"middle" 要素は1つ以上の "section" 要素から成ります。

2.3.1. The section Element

2.3.1. section 要素

 

Each "section" element contains a section of the document. There is a mandatory attribute, "title", that identifies the title of the section. There is also an optional attribute, "anchor", that is used for cross-referencing with the "xref" element , e.g.,

各 "section" 要素は文書の節から成ります。必須の属性 "title" は節の題を表します。省略可能の属性 "anchor" は "xref" 要素による交差参照に使います。 次の例を御覧下さい。

    <section anchor="intro" title="Introduction">
        ...
    </section>
 

The "section" element is recursive ―― each contains any number and combination of "t", "figure", and "section" elements, e.g.,

"section" 要素は再帰的で、各々任意の数・組合せで "t", "figure", "section" 各要素を次の例の如く使います。

    <section title="The Middle">
        ...
        <section title="The section Element">
            ...
            <section title="The t Element">...</section>
            <section title="The list Element">...</section>
            <section title="The figure Element">...</section>
            <section title="The xref Element">...</section>
            <section title="The eref Element">...</section>
            <section title="The iref Element">...</section>
        </section>
    </section>

2.3.1.1. The t Element

2.3.1.1. t 要素

The "t" element contains any number and combination of paragraphs, lists, and figures. If a cross-reference is needed to a section, figure, or reference, the "xref" element is used; similarly, if an external-reference is needed, the "eref" element is used. Indexing of text is provided by the the "iref" element .

"t" 要素は任意の数・組合せの段落・一覧・図から成ります。節・図・参考文献への交差参照が必要なら、 "xref" 要素 を使います。同様に外部参照が必要なら、 "eref" 要素を使います。文章の索引付けには "iref" 要素を使います。

2.3.1.2. The list Element

2.3.1.2. list 要素

 

The "list" element contains one or more items. Each item is a "t" element, allowing for recursion, e.g.,

"list" 要素は1つ以上の項目から成ります。各項目は "t" 要素で、繰り返し可能です。例を御覧あれ:

    <list style="numbers">
        <t>The first item.</t>
        <t>The second item, which contains two bulleted sub-items:
            <list style="symbols">
                <t>The first sub-item.</t>
                <t>The second sub-item.</t>
            </list>
        </t>
    </list>

    <list style="numbers">
        <t>最初の項目。</t>
        <t>2つの小項目がある二番目の項目
            <list style="symbols">
                <t>最初の小項目</t>
                <t>二番目の小項目</t>
            </list>
        </t>
    </list>

The "list" element has an optional attribute, "style", having the value "numbers" (for numeric lists), "symbols" (for bulleted lists), "hanging" (for hanging lists), or, "empty" (for indented text). If a "list" element is nested, the default value is taken from its closest parent; otherwise, the default value is "empty".

"list" 要素は省略可能な "style" 属性があって、 "numbers" (番号つき一覧), "symbols" (記号つき一覧), "hanging" (ぶら下がり一覧), "empty" (字下げ文) のいずれかの値を取ることが出来ます。 "list" 要素が入れ子になっている時、既定値は一番近い親から取られます。そうでない時は、既定値は "empty" です。

 

When nested within a "hanging list" element, the "t" element has an optional attribute, "hangText" that specifies the text to be inserted, e.g.,

「ぶら下がり一覧」 要素中で入れ子になっている時、 "t" 要素は省略可能な属性 "hangText" を持ち、挿入される文字列を指定します。次の例を参照して下さい。

    <list style="hanging">
        <t hangText="full2026:">indicating that the document is in
        full conformance with all the provisions of Section 10 of
        RFC 2026;</t>

        <t hangText="noDerivativeWorks2026:">indicating that the
        document is in full conformance with all the provisions of
        Section 10 of RFC 2026 except that the right to produce
        derivative works is not granted; or,</t>

        <t hangText="none:">indicating that the document is NOT
        offered in accordance with Section 10 of RFC 2026, and
        the author does not provide the IETF with any rights other
        than to publish as an Internet-Draft.</t>
    </list>

    <list style="hanging">
        <t hangText="full2026:">文書が RFC 2026 
        の第10章の全ての要件に完全に適合することを示します</t>

        <t hangText="noDerivativeWorks2026:">
        文書が、派生的作業の生成が認められていないことを除いて、
        RFC 2026 の第10章の全ての要件に完全に適合することを
        示します</t>

        <t hangText="none:">文書が RFC 2026 の第10章に従って
        *おらず*、著者は IETF に Internet-Draft
        として発行する以外のいかなる権利をも提供しないことを
        示します</t>
    </list>

2.3.1.3. The figure Element

2.3.1.3. figure 要素

The "figure" element groups an optional "preamble" element, an "artwork" element, and an optional "postamble" element together. The "figure" element also has an optional "anchor" attribute that is used for cross-referencing with the "xref" element . There is also an optional "title" attribute that identifies the title of the figure.

"figure" 要素は省略可能な "preamble" 要素, "artwork" 要素, 省略可能な "postable" 要素をひとまとめにします。 "figure" 要素は省略可能な "anchor" 属性も持っていて、 "xref" 要素による交差参照に使うことが出来ます。 省略可能な "title" 属性というのもあって、図の題を示します。

The "preamble" and "postamble" elements, if present, are simply text. If a cross-reference is needed to a section, figure, or reference, the "xref" element is used; similarly, if an external-reference is needed, the "eref" element is used. Indexing of text is provided by the the "iref" element .

"preamble" ・ "postamble" 両要素は、存在する場合、単純な文字列です。 節・図・参考文献への交差参照が必要な場合は、 "xref" 要素を使います。同様に、外部参照が必要なら、 "eref" 要素を使います。文章の索引付けには "iref" 要素を使います。

The "artwork" element, which must be present, contains "ASCII artwork". Unlike text contained in the "t", "preamble", or "postamble" elements, both horizontal and vertical whitespace is significant in the "artwork" element.

"artwork" 要素は、必ず存在しなければならず、「ASCII 絵」から成ります。 "t", "preamble", "postamble" 各要素中の文字列とは違って、水平・垂直どちらの空白間隔も "artwork" 要素中では意味を持ちます。

 

So, putting it all together, we have, e.g.,

ということで、全てまとめると、次の例の様になります。

    <figure anchor="figure_example">
        <preamble>So,
        putting it all together, we have, e.g.,</preamble>
        <artwork>
            ascii artwork goes here...
    
            be sure to use "&lt;" or "&amp;" instead of "<" and "&",
            respectively!
        </artwork>
        <postamble>which is a very simple example.</postamble>
    </figure>

    <figure anchor="figure_example">
        <preamble>ということで、全てまとめると、
        次の例の様になります。</preamble>
        <artwork>
            ascii 絵がここに入ります...
    
            "&lt;" とか "&amp;" をそれぞれ "<" と "&"
            の代わりに使うんだよ!
        </artwork>
        <postamble>非常に単純な例でした。</postamble>
    </figure>

which is a very simple example.

非常に単純な例でした。

 

If you have artwork with a lot of "<" characters, then there's an XML trick you can use:

沢山の "<" 文字が絵の中にある場合は、このような XML 魔法を使うことが出来ます。

    <figure>
        <preamble>If you have artwork with a lot of "&lt;"
        characters, then there's an XML trick you can
        use:</preamble>
        <artwork><![CDATA[
            ascii artwork goes here...
    
            just don't use "]]" in your artwork!
        ]]></artwork>
        <postamble>The "&lt;![CDATA[ ... ]]>" construct is called
        a CDATA block -- everything between the innermost brackets
        is left alone by the XML application.</postamble>
    </figure>

    <figure>
        <preamble>沢山の "&lt;" 文字が絵の中にある場合は、
        このような XML 魔法を使うことが出来ます。</preamble>
        <artwork><![CDATA[
            ascii がここに来ます...
    
            単に "]]" を絵の中で使わないだけです!
        ]]></artwork>
        <postamble>"&lt;![CDATA[ ... ]]>" 構造は CDATA
        塊と呼ばれます。一番内側の括弧の間のものは全て XML 
        応用に干渉されません。</postamble>
    </figure>

The "<![CDATA[ ... ]]>" construct is called a CDATA block ―― everything between the innermost brackets is left alone by the XML application.

「<![CDATA[ ... ]]>」 構造は CDATA 塊と呼ばれます。一番内側の括弧の間のものは全て XML 応用に干渉されません。

Because the "figure" element represents a logical grouping of text and artwork, an XML application producing a text version of the document should attempt to keep these elements on the same page. Because RFC 2223  [2] allows no more than 69 characters by 49 lines of content on each page, XML applications should be prepared to prematurely introduce page breaks to allow for better visual grouping.

"figure" 要素は文書と絵の論理的な集合を表現するので、文書の text 版を生成する XML 応用は各要素を同一頁中に入れるように策するべきです。 RFC 2223  [2] が各頁49行の内容で, 69文字を超えるのを認めていないので、 XML 応用はより良い視覚的集合化を行うために予め改頁する準備をしておくべきです。

Finally, the "artwork" element has two optional attributes: "name" and "type". The former is used to suggest a filename to use when storing the content of the "artwork" element, whilst the latter contains a suggestive data-typing for the content.

最後に、 "artwork" 要素は2つの省略可能な属性 "name", "type" を持ちます。前者は "artwork" 要素の内容を保管する時に使うファイル名の案を推すのに使います。後者は内容のデータ型を示すのに使います。

2.3.1.4. The xref Element

2.3.1.4. xref 要素

The "xref" element is used to cross-reference sections, figures, and references. The mandatory "target" attribute is used to link back to the "anchor" attribute of the "section", "figure", and "reference" elements. The value of the "anchor" and "target" attributes should be formatted according to the token syntax in section 2.1 .

"xref" 要素は節・図・参考文献の交差参照に使います。必須の "target" 属性は "section", "figure", "reference" 要素の "anchor" 属性に逆接続するのに使います。 "anchor" および "target" 両属性の値は 2.1節 の字句 (token) 構文に従い書式化されるべきです。

 

If used as an empty element, e.g.,

空要素として使う時は

    according to the token syntax in <xref target="xml_basics" />.

    <xref target="xml_basics" /> の字句 (token) 構文に従い

then the XML application inserts an appropriate phrase during processing, such as "Section 2.1" or "<a href="#xml_basics">XML Basics</a>".

の様になり、 XML 応用は 「2.1 節」「<a href="#xml_basics">XML の基礎</a>」 のように適切な文字列を処理により挿入します。

 

If used with content, e.g.,

内容ありで使う時は

    conforming to <xref target="refs.RFC2223">RFC 2223</xref>.

    <xref target="refs.RFC2223">RFC 2223</xref> に適合する

then the XML application inserts an appropriate designation during processing, such as "RFC 2223[2]" or "<a href="#refs.RFC2223">RFC 2223</a>". Although the XML application decides what "an appropriate designation" might be, its choice is consistent throughout the processing of the document.

の様になり、 XML 応用は 「RFC 2223[2]」「<a href="#refs.RFC2223">RFC 2223</a>」 のように適切な指示を処理により挿入します。「適切な指示」の内容は XML 応用が決めますが、選択は当該文書の処理を通じて固定です。

2.3.1.5. The eref Element

2.3.1.5. eref 要素

 

The "eref" element is used to reference external documents. The mandatory "target" attribute is a URI  [4] , e.g.,

"eref" 要素は、外部文書を参照するのに使います。必須の "target" 属性は URI  [4] で、次の様に使います。

    <eref target="http://metalab.unc.edu/xml/">Cafe con Leche</eref>
 

Note that while the "target" attribute is always present, the "eref" element may be empty, e.g.,

"target" 属性は常に必要であり、 "eref" 要素は空であり得ることに注意して下さい。

    <eref target="http://invisible.net/" />

and the XML application inserts an appropriate designation during processing such as "[9]" or "<a href="http://invisible.net/">http://invisible.net/</a>".

XML 応用は 「[9]」「<a href="http://invisible.net/">http://invisible.net/</a>」 の様に適切な指示を処理の過程で挿入します。

2.3.1.6. The iref Element

2.3.1.6. iref 要素

 

 The "iref" element is used to add information to an index. The mandatory "item" attribute is the primary key the information is stored under, whilst the optional "subitem" attribute is the secondary key, e.g.,

 "iref" 要素は索引に情報を追加するのに使います。必須の属性 "item" は情報が保管される主鍵で、省略可能な "subitem" 属性は副鍵です。

    <iref item="indexing" subitem="how to" />

    <iref item="索引付け" subitem="方法" />

Finally, note that the "iref" element is always empty ―― it never contains any text.

最後に、 "iref" 要素は常に空である――どんな文字列も含まないということに注意して下さい。

2.3.1.7. The vspace Element

2.3.1.7. vspace 要素

The "vspace" element, which may occur only inside the "t" element, is used by the author to provide formatting guidance to the XML application. There is an attribute, "blankLines", that indicates the number of blank lines that should be inserted. A physical linebreak is specified by using the default value, "0".

"vspace" 要素は、 "t" 要素の中にのみ現れることが出来て、著者が XML 応用に整形の手引きを与えるのに使います。 "blankLines" 属性があり、挿入されるべき空白行の数を示します。物理改行は既定値である "0" を使って表します。

 

In addition, the "vspace" element can be used to force a new physical paragraph within a list item, e.g.,

加えて、 "vspace" 要素は次に例示するように、新しい形式段落を一覧項目中に作り出すのに使うことが出来ます。

    <list style="numbers">
        <t>This is list item.
           <vspace blankLines="1" />
           This is part of the same list item,
           although when displayed, it appears
           as a separate physical paragraph.</t>
    </list>

    <list style="numbers">
        <t>これは一覧の項目です。
           <vspace blankLines="1" />
           これは同じ一覧項目です。
           しかし表示の際には別の形式段落に見えます。</t>
    </list>

An XML application producing a text version of the document should exercise care when encountering a value for "blankLines" that causes a pagebreak ―― in particular, if a "vspace" element causes a pagebreak, then no further blank lines should be inserted. This allows authors to "force" a pagebreak by using an arbitrarily large value, e.g., "blankLines='100'".

文書の text 版を生成する XML 応用は、改頁を起こすような "breakLines" の値であった時に注意するべきです。 "vspace" 要素が改頁を起こす時は、それ以上空白行を挿入するべきではありません。これにより、著者は任意の大きな値、例えば 「blankLines='100'」 で「強制」改頁させることが出来ます。

Finally, note that the "vspace" element is always empty ―― it never contains any text.

最後に、 "vspace" 要素は常に空である――文字列を含まないということに注意して下さい。

2.4. Back matter

 

Finally, the "back" element is used for references and appendices:

最後に、 "back" 要素は参考文献と附属書に使います。

        ...
        </middle>
        <back>
            <references>
                <reference ...>
                <reference ...>
            </references>
            <section ...>
            <section ...>
        </back>
    </rfc>

The "back" element consists of an optional "references" element, and, one or more optional "section" elements. The "back" element itself is optional, if your document doesn't have any references or appendices, you don't have to include it.

"back" 要素は省略可能な "references" 要素と、1つ以上の省略可能な "section" 要素から成ります。 "back" 要素自体は省略可能で、文書に参考文献も附属書もない場合は、含める必要はありません。

2.4.1. The references Element

2.4.1. references 要素

The "references" element contains the document's bibliography. It contains one or more "reference" elements.

"references" 要素は文書の参考文献から成ります。1つ以上の "reference" 要素から成ります。

Each "reference" element contains a "front" element and one or more optional "seriesInfo" elements.

各 "references" 要素は "front" 要素と1つ以上の省略可能な "seriesInfo" 要素から成ります。

We've already discussed the "front" element back in section 2.2 .

"front" 要素については 2.2節 で既に話しました。

The "seriesInfo" element has two attributes, "name" and "value" that identify the document series and series entry, respectively.

"seriesInfo" 要素は "name", "value" の2つの属性を持ち、それぞれ文書系列と系列項目を特定します。

 

The "reference" element has an optional "anchor" attribute that is used for cross-referencing with the "xref" element , e.g.,

"reference" 要素は省略可能な "anchor" 属性を持ち、 次の様に使い、 "xref" 要素で交差参照に使うことが出来ます。

    <reference anchor="refs.RFC2200">
        <front>
            <title>Internet Official Protocol Standards</title>
            <author initials="J." surname="Postel"
                    fullname="Jon Postel">
                <organization abbrev="ISI">
                USC/Information Sciences Institute
                </organization>
            </author>
    
            <date month="June" year="1997" />
        </front>
        <seriesInfo name="RFC" value="2200" />
        <seriesInfo name="STD" value="1" />
    </reference>

The "reference" element also has an optional "target" attribute that is used for external references (c.f., section 2.3.1.5 ). The XML application, if producing an HTML version of the document will use the "target" attribute accordingly; however, if the "name" attribute of the "seriesInfo" element has the value "RFC", then the XML application should automatically provide an appropriate default for the "target" attribute (e.g., "http://example.com/rfcs/rfc2200.txt").

"reference" 要素には省略可能な "target" 属性があり、外部参照に使います。 (cf. 2.3.1.5節) XML 応用は文書の HTML 版を生成する時に "target" 属性を使います。しかし、 "seriseInfo" 要素の "name" 属性が値 "RFC" を持つ場合、 XML 応用は自動的に適切な "target" 属性の既定値を用意するべきです。 (例えば 「http://example.com/rfcs/rfc2200.txt」)

2.4.2. Appendices

2.4.2. 附属書

To include appendices after the bibliography, simply add more "section" elements. (For an example, look at the example at the beginning of section 2.4 .)

参考文献の後に附属書を含めるには、単に "section" 要素を追加するだけです。 (例として、 2.4節 のはじめの例を御覧下さい。)

2.4.3. Copyright Status

2.4.3. 著作権状態

The copyright status for the document is not included in the document's markup ―― this is automatically inserted by an XML application that produces either a text or HTML version of the document.

文書の著作権状態は文書のマーク付けには含めません。 これは文書の text 版か HTML 版を生成する XML 応用により自動的に挿入されます。

3. Processing the XML Source File

3. XML 源ファイルの処理

This section concerns itself with applications that operate on an XML source file. A lot of XML tools are available, as are many lists of XML resources, e.g., Cafe con Leche.

この節は XML 源ファイルを処理する応用についてです。沢山の XML 工具が利用可能ですし、沢山の XML 資源の一覧も、例えば Cafe con Leche にあります。

There are two kinds of XML tools: validating and non-validating. Both check that the source file conforms to the rules given in section 2.1 . However, in addition to making sure that the source file is well-formed, a validating tool also reads the DTD referenced by the source file to make sure that they match. There are a number of both validating and non-validating tools available.

XML 工具には2種類あります: 検証するものと検証しないものです。両者共に、源ファイルが 2.1節 に挙げた規則に適合するかは確認します。しかし、加えて源ファイルが整形式であるかを確認するため、検証工具は現ファイルが参照している DTD も読んで一致しているか確認します。検証・非検証工具共に多数入手出来ます。

3.1. Editing

3.1. 編集

There are several XML editors available. Ideally, you want an editor that validates. This has two advantages:

XML エディターは幾つか入手可能です。理想的には、検証出来るエディターが良いでしょう。これには2つの利点があります。

  • the editor provides guidance in fleshing-out the document structure; and,

    エディターが文書構造に肉付けする手引きを示す

  • the editor validates that the source file matches the rules in the DTD.

    エディターが源ファイルが DTD の規則と一致しているか検証する

 

There are two major modes in Emacs that support XML: tdtd and psgml. The latter mode allows you to validate the source file (by calling an external program). If you visit the source file in Emacs and the major mode isn't "SGML" or "XML", then usually all it takes is adding these lines to your ".emacs" file:

Emacs では XML に対応した2つの大モード、 tdtdpsgml があります。後者のモードでは源ファイルを (外部プログラムを呼び出すことにより) 検証することが出来ます。源ファイルを Emacs でみて、大モードが 「SGML」 か 「XML」 にならない場合、通常は ".emacs" ファイルに次の行

    (setq auto-mode-alist
          (cons (cons "\\.xml$" 'sgml-mode) auto-mode-alist))

and then restarting Emacs. If this doesn't work, try one of the sources above.

を加えて、 Emacs を再起動します。これで上手くいかなければ、上記の情報源のいずれかを試してみて下さい。

The author uses both sgml-mode in Emacs, and a commercial validating editor, Clip! version 1.5, when editing source files.

著者は両 sgml-mode を Emacs で使っていて、商用検証エディター Clip! version 1.5 を源ファイルを編集するのに使っています。

3.1.1. Checking

3.1.1. 確認

If your editor doesn't validate, then you should run a program to validate the source file.

お使いのエディターが検証しないなら、源ファイルを検証するのにプログラムを動かす必要があります。

The author uses the AlphaWorks XML parser for this purpose. It requires that your system have a Java virtual machine. In addition to Java, there are validating parsers written in C, Perl, Python, and Tcl.

著者は the AlphaWorks XML parser をこの目的に使っています。これにはお使いの系統に Java 仮想機械が必要です。 Java に加え、 C, Perl, Python, Tcl で書かれた検証解析器があります。

3.2. Converting to Text Format

3.2. text 形式に変換する

The author has written the xml2rfc tool, which reads the source file and produces both a text and HTML version of the document. (This memo was produced using the xml2rfc tool.) Note that xml2rfc isn't a validating tool, so it's a good idea to use either a validating editor or run a stand-alone validating parser prior to using the tool.

著者は源ファイルを読んで文書の text 版と HTML 版の両者を生成する xml2rfc 工具を書きました。 (このメモは xml2rfc 工具を使って生成しました。) なお、 xml2rfc は検証工具ではないので、検証エディターや単独検証解析器をこの工具の前に使うのが良いでしょう。

3.3. Converting to HTML Format

3.3. HTML 形式に変換する

The XML Style Language (XSL) is used to describe transformations from the source file into some other structured file. So, ideally you should use an XSL-capable formatter to convert an XML source file to HTML.

XML スタイル言語 (XSL) を源ファイルから他の構造のファイルに変形するのを記述するのに使用出来ます。ですから、理想的には XSL が使える formatter を使って XML 源ファイルを HTML に変換するべきでしょう。

However, as of this writing XSL is still in considerable flux. (Hence, no reference was included in this memo, as by the time you read this section, the reference would be outdated.) So, in the interim, the author uses the xml2rfc tool for this purpose, even though this tool doesn't provide much flexibility in its HTML layout.

しかしながら、この XSL 書きはまだ流動的と考えられます。 (それ故、このメモには参照は含めませんでした。読者がこの節を読む時には参照はもう古いものになっているでしょうから。) ですが、その間、著者はこの目的に xml2rfc 工具を使います。 この工具はそれほど HTML 配置に柔軟性を持っていないのですが。

訳注:

rfc2629.xslt は、 xml2rfc 工具に含まれています。これを使って巷の XSLT formatter でも HTML に変換出来ます。

3.4. Viewing

3.4. 表示

Browsers that support either XSL or Cascading Style Sheets (CSS) are able to view the source file directly.

XSL か Cascading Style Sheets (CSS) に対応した閲覧器を源ファイルを直接見るのに使用出来ます。

At present, the author doesn't use any of these browsers, instead converting source files to either text or HTML.

現時点で、著者はその様な閲覧器を使っておらず、代わりに源ファイルを text か HTML に変換しています。

3.5. Searching

3.5. 検索

As with text editors, any text-oriented search tool (e.g., grep) can be used on the source file. However, there are search tools available that understand structured source.

text エディターと共に、どんな text 指向検索工具 (例 grep) をも源ファイルに対して使うことが出来ます。しかし、構造化された源を理解する検索道具もあります。

 

The author uses sgrep version 1.9 for this purpose, e.g.

著者は sgrep version 1.9 をこの目的で次の様に使っています。

    sgrep -g xml 'ELEMENTS("title") not in ELEMENTS("back")' \
        writing-rfcs.xml

which extracts the title element from the source file.

これは title 要素を源ファイルから取り出します。

4. Security Considerations

4. 安全性に関して

 

This memo raises no security issues; however, according to [2] , your document should contain a section near the end that discusses the security considerations of the protocol or procedures that are the main topic of your document, e.g.,

このメモは安全性問題を起こしません。しかし、 [2] によると、文書は終わり近くに、文書の主題であるプロトコルや処理の安全性に関しての議論の節を設けるべきです。例:

    <middle>
        ...
        <section title="Security Considerations">
            <t>This memo raises no security issues;
            however,
            according to <xref target="refs.RFC2223" />,
            your document should contain a section near the end
            that discusses the security considerations of the
            protocol or procedures that are the main topic of your
            document.</t>
        </section>
    </middle>

    <middle>
        ...
        <section title="安全性に関して">
            <t>このメモは安全性問題を起こしません。しかし、 
            <xref target="refs.RFC2223" /> によると、
            文書は終わり近くに、文書の主題であるプロトコルや
            処理の安全性に関しての議論の節を設けるべきです。</t>
        </section>
    </middle>

References

参考文献

[1]
Extensible Markup Language (XML) 1.0 』, W3C  XML ,  February  1998. , 1998年2月。
[2]
Instructions to RFC Authors 』, Postel, J., Reynolds, J., RFC  2223 ,  October  1997. , 1997年10月。
[3]
The Internet Standards Process ―― Revision 3 』, Bradner, S.O., RFC  2026, BCP  9 ,  October  1996. , 1996年10月。
[4]
Uniform Resource Identifiers (URI): Generic Syntax 』, Berners-Lee, T., Fielding, R.T., Masinter, L., RFC  2396 ,  August  1998. , 1998年8月。

Author's Address

著者の連絡先

A. The rfc Element

A. rfc 要素

 

The "<rfc>" tag at the beginning of the file, with only an "ipr" attribute , produces an Internet-Draft. However, when other attributes are added to this tag by the RFC editor, an RFC is produced, e.g.,

ファイルのはじめの "<rfc>" タグは、 "ipr" 属性だけを持つと、 Internet-Draft を生成します。しかし、このタグに RFC 編集者により他の属性が 付加されると、 RFC が生成されます。

    <rfc number="2200"
         obsoletes="2000, 1920, 1880, 1800, ..."
         category="std"
         seriesNo="1">

At a minimum, the "number" attribute should be present.

少なくても、 "number" 属性があるべきです。

The other attributes are:

この他の属性は、

  • "obsoletes", having a comma-separated list of RFC numbers, that the document obsoletes;

    "obsoleted" は、その文書が廃止する読点 (comma) 区切りの RFC 番号の一覧です。

  • "updates", having a comma-separated list of RFC numbers, that the document updates;

    "updates" は、その文書が更新する読点 (comma) 区切りの RFC 番号の一覧です。

  • "category", having one of these values:

    "category" は、次の値のいずれかを持ちます。

    1. "std", for a Standards-Track document;

      "std" は標準化過程文書用

    2. "bcp", for a Best Current Practices document;

      "bcp" は現状最善運用文書用

    3. "exp", for an Experimental Protocol document;

      "exp" は実験プロトコル文書用

    4. "historic", for a historic document; or,

      "exp" は歴史的文書用

    5. "info", the default, for an Informational document.

      "info" は既定値で参考文書用

  • "seriesNo", having the corresponding number in the STD (std), BCP (bcp), or FYI (info) series.

    "seriesNo" は、 STD (std), BCP (bcp), FYI (info) 各系列での対応番号を値に持ちます。

Finally, a special entity, "&rfc.number;", is available. Authors preparing an RFC should use this entity whenever they want to reference the number of the RFC within the document itself. In printed versions of the document, the appropriate substitution (or "XXXX") will occur.

最後に、特別な実体 "&rfc.number;" が使えます。 RFC を用意する著者はこの実体を文書自身の RFC 番号を参照したい時に使うべきです。文書の印刷版では、適切な代替 (または "XXXX") を使います。

(訳注:
 
実際に使う時は、
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [<!ENTITY rfc.number "1234">]>
のように、文書型宣言で当該 RFC 番号を示すことになるでしょう。
)

B. The RFC DTD

訳注:

この DTD のファイル rfc2629.dtd は、 xml2rfc 工具の中にも含まれています。

 

<!--
  DTD for the RFC document series, draft of 99-01-30
  -->


<!--
  Contents

    DTD data types

    The top-level

    Front matter

    The Body

    Back matter
  -->


<!--
  DTD data types:

        entity        description
        ======        ===============================================
        NUMBER        [0-9]+
        NUMBERS       a comma-separated list of NUMBER

        DAY           the day of the month, e.g., "1"
        MONTH         the month of the year, e.g., "January"
        YEAR          a four-digit year, e.g., "1999"

        URI           e.g., "http://invisible.net/"

        ATEXT/CTEXT   printable ASCII text (no line-terminators)

        TEXT          character data
  -->


<!ENTITY % NUMBER     "CDATA">
<!ENTITY % NUMBERS    "CDATA">

<!ENTITY % DAY        "CDATA">
<!ENTITY % MONTH      "CDATA">
<!ENTITY % YEAR       "CDATA">

<!ENTITY % URI        "CDATA">

<!ENTITY % ATEXT      "CDATA">
<!ENTITY % CTEXT      "#PCDATA">

<!ENTITY % TEXT       "#PCDATA">

<!ENTITY   rfc.number "2629">


<!--
  The top-level
  -->


<!--
  attributes for the "rfc" element are supplied by the RFC
  editor. when preparing drafts, authors should leave them blank.

  the "seriesNo" attribute is used if the category is, e.g., BCP.
  -->
<!ELEMENT rfc         (front,middle,back?)>
<!ATTLIST rfc
          number      %NUMBER;           #IMPLIED
          obsoletes   %NUMBERS;          ""
          updates     %NUMBERS;          ""
          category    (std|bcp|info|exp|historic)
                                         "info"
          seriesNo    %NUMBER;           #IMPLIED
          ipr         (full2026|noDerivativeWorks2026|none)
                                         #IMPLIED
          docName     %ATEXT;            #IMPLIED> 

<!--
  Front matter
  -->


<!ELEMENT front       (title,author+,date,area*,workgroup*,keyword*,
                       abstract?,note*)>

<!-- the "abbrev" attribute is used for headers, etc. -->
<!ELEMENT title       (%CTEXT;)>
<!ATTLIST title
          abbrev      %ATEXT;            #IMPLIED> 

<!ELEMENT author      (organization,address?)>
<!ATTLIST author
          initials    %ATEXT;            #IMPLIED
          surname     %ATEXT;            #IMPLIED
          fullname    %ATEXT;            #IMPLIED>

<!ELEMENT organization
                      (%CTEXT;)>
<!ATTLIST organization
          abbrev      %ATEXT;            #IMPLIED> 
 
<!ELEMENT address     (postal?,phone?,facsimile?,email?,uri?)>

<!-- at most one of each the city, region, code, and country
     elements may be present -->
<!ELEMENT postal      (street+,(city|region|code|country)*)>
<!ELEMENT street      (%CTEXT;)>
<!ELEMENT city        (%CTEXT;)>
<!ELEMENT region      (%CTEXT;)>
<!ELEMENT code        (%CTEXT;)>
<!ELEMENT country     (%CTEXT;)>
<!ELEMENT phone       (%CTEXT;)>
<!ELEMENT facsimile   (%CTEXT;)>
<!ELEMENT email       (%CTEXT;)>
<!ELEMENT uri         (%CTEXT;)>

<!ELEMENT date        EMPTY>
<!ATTLIST date
          day         %DAY;              #IMPLIED
          month       %MONTH;            #REQUIRED
          year        %YEAR;             #REQUIRED>

<!-- meta-data... -->
<!ELEMENT area        (%CTEXT;)>
<!ELEMENT workgroup   (%CTEXT;)>
<!ELEMENT keyword     (%CTEXT;)>

<!ELEMENT abstract    (t)+>
<!ELEMENT note        (t)+>
<!ATTLIST note
          title       %ATEXT;            #REQUIRED>


<!--
  The body
  -->


<!ELEMENT middle      (section)+>

<!ELEMENT section     (t|figure|section)*>
<!ATTLIST section
          anchor      ID                 #IMPLIED
          title       %ATEXT;            #REQUIRED>

<!ELEMENT t           (%TEXT;|list|figure|xref|eref|iref|vspace)*>
<!ATTLIST t
          hangText    %ATEXT;            #IMPLIED>

<!-- the value of the style attribute is inherited from the closest 
     parent -->
<!ELEMENT list        (t+)>
<!ATTLIST list
          style       (numbers|symbols|hanging|empty)
                                         "empty">

<!ELEMENT xref        (%CTEXT;)>
<!ATTLIST xref
          target      IDREF              #REQUIRED
          pageno      (true|false)       "false">

<!ELEMENT eref        (%CTEXT;)>
<!ATTLIST eref
          target      %URI;              #REQUIRED>

<!ELEMENT iref        EMPTY>
<!ATTLIST iref
          item        %ATEXT;            #REQUIRED
          subitem     %ATEXT;            "">

<!ELEMENT vspace      EMPTY>
<!ATTLIST vspace
          blankLines  %NUMBER;           "0">

<!ELEMENT figure      (preamble?,artwork,postamble?)>
<!ATTLIST figure
          anchor      ID                 #IMPLIED
          title       %ATEXT;            "">

<!ELEMENT preamble    (%TEXT;|xref|eref|iref)*>
<!ELEMENT artwork     (%TEXT;)*>
<!ATTLIST artwork
          xml:space   (default|preserve) "preserve">
<!ELEMENT postamble   (%TEXT;|xref|eref|iref)*>


<!--
  Back matter
  -->


<!-- sections, if present, are appendices -->
<!ELEMENT back        (references?,section*)>

<!ELEMENT references  (reference+)>
<!ELEMENT reference   (front,seriesInfo*)>
<!ATTLIST reference
          anchor      ID                 #IMPLIED
          target      %URI;              #IMPLIED>
<!ELEMENT seriesInfo  EMPTY>
<!ATTLIST seriesInfo
          name        %ATEXT;            #REQUIRED
          value       %ATEXT;            #REQUIRED>

<!--
  RFC 文書系列用 DTD, 99-01-30 の原案 (の注釈部分和訳)
  -->


<!--
  内容

    DTD データ型

    最上位

    Front matter

    The Body

    Back matter
  -->


<!--
  DTD データ型:

        実体          説明
        ======        ===============================================
        NUMBER        [0-9]+
        NUMBERS       読点(comma)区切りの NUMBER

        DAY           月中の日、例えば "1"
        MONTH         年中の月、例えば "January" (1月)
        YEAR          4桁年号、例えば "1999"

        URI           例 "http://invisible.net/"

        ATEXT/CTEXT   印字可能 ASCII 文字列 (行終端無し)

        TEXT          文字データ
  -->


<!ENTITY % NUMBER     "CDATA">
<!ENTITY % NUMBERS    "CDATA">

<!ENTITY % DAY        "CDATA">
<!ENTITY % MONTH      "CDATA">
<!ENTITY % YEAR       "CDATA">

<!ENTITY % URI        "CDATA">

<!ENTITY % ATEXT      "CDATA">
<!ENTITY % CTEXT      "#PCDATA">

<!ENTITY % TEXT       "#PCDATA">

<!ENTITY   rfc.number "2629">


<!--
  最上位
  -->


<!--
  "rfc" 要素の属性は RFC 編集者により埋められます。
  原案を用意する際には、著者は空欄にしておくべきです。

  "seriesNo" 属性は分類が例えば BCP の時に使います。
  -->
<!ELEMENT rfc         (front,middle,back?)>
<!ATTLIST rfc
          number      %NUMBER;           #IMPLIED
          obsoletes   %NUMBERS;          ""
          updates     %NUMBERS;          ""
          category    (std|bcp|info|exp|historic)
                                         "info"
          seriesNo    %NUMBER;           #IMPLIED
          ipr         (full2026|noDerivativeWorks2026|none)
                                         #IMPLIED
          docName     %ATEXT;            #IMPLIED> 

<!--
  Front matter
  -->


<!ELEMENT front       (title,author+,date,area*,workgroup*,keyword*,
                       abstract?,note*)>

<!-- "abbrev" 属性は頭とかに使います。 -->
<!ELEMENT title       (%CTEXT;)>
<!ATTLIST title
          abbrev      %ATEXT;            #IMPLIED> 

<!ELEMENT author      (organization,address?)>
<!ATTLIST author
          initials    %ATEXT;            #IMPLIED
          surname     %ATEXT;            #IMPLIED
          fullname    %ATEXT;            #IMPLIED>

<!ELEMENT organization
                      (%CTEXT;)>
<!ATTLIST organization
          abbrev      %ATEXT;            #IMPLIED> 
 
<!ELEMENT address     (postal?,phone?,facsimile?,email?,uri?)>

<!-- city, region, code, country 各要素がせいぜい1回出現可能 -->
<!ELEMENT postal      (street+,(city|region|code|country)*)>
<!ELEMENT street      (%CTEXT;)>
<!ELEMENT city        (%CTEXT;)>
<!ELEMENT region      (%CTEXT;)>
<!ELEMENT code        (%CTEXT;)>
<!ELEMENT country     (%CTEXT;)>
<!ELEMENT phone       (%CTEXT;)>
<!ELEMENT facsimile   (%CTEXT;)>
<!ELEMENT email       (%CTEXT;)>
<!ELEMENT uri         (%CTEXT;)>

<!ELEMENT date        EMPTY>
<!ATTLIST date
          day         %DAY;              #IMPLIED
          month       %MONTH;            #REQUIRED
          year        %YEAR;             #REQUIRED>

<!-- メタ・データ・・・ -->
<!ELEMENT area        (%CTEXT;)>
<!ELEMENT workgroup   (%CTEXT;)>
<!ELEMENT keyword     (%CTEXT;)>

<!ELEMENT abstract    (t)+>
<!ELEMENT note        (t)+>
<!ATTLIST note
          title       %ATEXT;            #REQUIRED>


<!--
  本体
  -->


<!ELEMENT middle      (section)+>

<!ELEMENT section     (t|figure|section)*>
<!ATTLIST section
          anchor      ID                 #IMPLIED
          title       %ATEXT;            #REQUIRED>

<!ELEMENT t           (%TEXT;|list|figure|xref|eref|iref|vspace)*>
<!ATTLIST t
          hangText    %ATEXT;            #IMPLIED>

<!-- style 属性の値は直近の親から継承する -->
<!ELEMENT list        (t+)>
<!ATTLIST list
          style       (numbers|symbols|hanging|empty)
                                         "empty">

<!ELEMENT xref        (%CTEXT;)>
<!ATTLIST xref
          target      IDREF              #REQUIRED
          pageno      (true|false)       "false">

<!ELEMENT eref        (%CTEXT;)>
<!ATTLIST eref
          target      %URI;              #REQUIRED>

<!ELEMENT iref        EMPTY>
<!ATTLIST iref
          item        %ATEXT;            #REQUIRED
          subitem     %ATEXT;            "">

<!ELEMENT vspace      EMPTY>
<!ATTLIST vspace
          blankLines  %NUMBER;           "0">

<!ELEMENT figure      (preamble?,artwork,postamble?)>
<!ATTLIST figure
          anchor      ID                 #IMPLIED
          title       %ATEXT;            "">

<!ELEMENT preamble    (%TEXT;|xref|eref|iref)*>
<!ELEMENT artwork     (%TEXT;)*>
<!ATTLIST artwork
          xml:space   (default|preserve) "preserve">
<!ELEMENT postamble   (%TEXT;|xref|eref|iref)*>


<!--
  Back matter
  -->


<!-- sections がある場合、それは附属書 -->
<!ELEMENT back        (references?,section*)>

<!ELEMENT references  (reference+)>
<!ELEMENT reference   (front,seriesInfo*)>
<!ATTLIST reference
          anchor      ID                 #IMPLIED
          target      %URI;              #IMPLIED>
<!ELEMENT seriesInfo  EMPTY>
<!ATTLIST seriesInfo
          name        %ATEXT;            #REQUIRED
          value       %ATEXT;            #REQUIRED>

C. Acknowledgements

C. 謝辞

The author gratefully acknowledges the contributions of: Alan Barrett, Brad Burdick, Brian Carpenter, Steve Deering, Patrik Faltstrom, Jim Gettys, Carl Malamud, Chris Newman, Kurt Starsinic, and, Frank Strauss.

著者は次の方々の貢献に謝意を表します: Alan Barrett, Brad Burdick, Brian Carpenter, Steve Deering, Patrik Faltstrom, Jim Gettys, Carl Malamud, Chris Newman, Kurt Starsinic, Frank Strauss。

Acknowledgement

謝辞

Funding for the RFC editor function is currently provided by the Internet Society.

RFC 編集者業務の資金援助は現在 Internet Society により行われています。

この翻訳文の形式について

この文書 (の原本) は、 RFC 2629 で定義された形式に、翻訳文用の要素を XML 名前空間を使って追加して用いています。詳しくは、 <http://suika.fam.cx/~wakaba/lang/rfc/translation/> を御覧下さい。

翻訳の変更履歴

2002-04-30 わかば
  • 翻訳完了。
2002-05-03 わかば
  • 訳注を幾つか追加。翻訳変更履歴の章を新設。