Network Working Group T. Hardie
Request For Comments: 2656 Equinix
Category: Experimental August 1999
Network Working Group T. Hardie
Request For Comments: 2656 Equinix
Category: Experimental August 1999
Registration Procedures for SOIF Template Types
SOIF模板类型的注册程序
Status of this Memo
本备忘录的状况
This memo defines an Experimental Protocol for the Internet community. It does not specify an Internet standard of any kind. Discussion and suggestions for improvement are requested. Distribution of this memo is unlimited.
这份备忘录为互联网社区定义了一个实验性协议。它没有规定任何类型的互联网标准。要求进行讨论并提出改进建议。本备忘录的分发不受限制。
Copyright Notice
版权公告
Copyright (C) The Internet Society (1999). All Rights Reserved.
版权所有（C）互联网协会（1999年）。版权所有。
Abstract
摘要
The Summary Object Interchange Format [Ref. 1] was first defined by the Harvest Project [Ref 2.] in January 1994. SOIF was derived from a combination of the Internet Anonymous FTP Archives IETF Working Group (IAFA) templates [Ref 3.] and the BibTeX bibliography format [Ref 4.]. The combination was originally noted for its advantages of providing a convenient and intuitive way for delimiting objects within a stream, and setting apart the URL for easy object access or invocation, while still preserving compatibility with IAFA templates.
摘要对象交换格式[Ref.1]于1994年1月由Harvest项目[Ref.2]首次定义。SOIF源自互联网匿名FTP档案IETF工作组（IAFA）模板[Ref 3.]和BibTeX书目格式[Ref 4.]的组合。这种组合最初的优点是提供了一种方便直观的方式来划分流中的对象，并设置了URL以便于对象访问或调用，同时仍然保持了与IAFA模板的兼容性。
SOIF uses named template types to indicate the attributes which may be contained within a particular summary object. Within the context of a single application, private agreement on the definition of template types has been adequate. As SOIF objects are moved among applications, however, the need for standard, well-specified, and easily identifiable template types increases. This need is particularly intense in the context of query referral, where knowledge of an attribute's definition and the allowed data types for specific values is crucial. For a discussion of this in the context of the Common Indexing Protocol, see [Ref. 1].
SOIF使用命名模板类型来指示特定摘要对象中可能包含的属性。在单个应用程序的上下文中，关于模板类型定义的私人协议已经足够了。然而，随着SOIF对象在应用程序之间的移动，对标准、明确指定且易于识别的模板类型的需求也随之增加。在查询引用的上下文中，这种需求尤其强烈，在查询引用中，了解属性的定义和特定值允许的数据类型至关重要。有关在通用索引协议上下文中对此的讨论，请参见[参考文献1]。
The registration procedure described in this document is specific to SOIF template types. There is ongoing work within the IETF to specify a more generic schema registration facility[Ref. 5]. It is not yet clear whether the results of that work will encompass the ability to register entities like SOIF template types. If it does so, the registration of SOIF template types may be shifted to that method and registry. Should that occur, appropriate pointers will be created in cooperation with the Registrar to ensure that no registrations are lost.
本文档中描述的注册过程特定于SOIF模板类型。IETF内部正在进行工作，以指定更通用的模式注册设施[参考文献5]。目前尚不清楚这项工作的结果是否包括注册SOIF模板类型等实体的能力。如果这样做，SOIF模板类型的注册可能会转移到该方法和注册表。如果出现这种情况，将与注册官合作创建适当的指针，以确保注册不会丢失。
The initial registrar of SOIF template types will be the Internet Assigned Numbers Authority (IANA).
SOIF模板类型的初始注册机构将是互联网分配号码管理局（IANA）。
Each SOIF object is composed of 3 fundamental components: a template type IDENTIFIER, a URL, and zero or more ATTRIBUTE-VALUE pairs. See [Ref 1.] for the formal grammar of SOIF and a description of how these components interrelate. As part of the registration process, registrants must: propose a template type IDENTIFER; list the ATTRIBUTEs which the template may contain; identify whether each ATTRIBUTE is mandatory or optional; and specifiy the data type and encoding appropriate for the VALUEs associated with each ATTRIBUTE.
每个SOIF对象由3个基本组件组成：模板类型标识符、URL和零个或多个属性值对。有关SOIF的形式语法以及这些组件如何相互关联的描述，请参见[参考文献1]。作为注册过程的一部分，注册人必须：提出模板类型标识；列出模板可能包含的属性；确定每个属性是强制性的还是可选的；并指定与每个属性关联的值相应的数据类型和编码。
The IDENTIFIER for the template type is assigned at registration based on a proposal from the registrant. It is, however, at the sole discretion of the registrars to assign specific IDENTIFIERS. While they will normally assign the IDENTIFIERs proposed by registrants, they may choose to modify a proposed IDENTIFIER to avoid conflict with other existing or proposed template types.
模板类型的标识符在注册时根据注册人的建议分配。然而，注册人可自行决定是否分配特定标识符。虽然他们通常会分配注册人提议的标识符，但他们可以选择修改提议的标识符，以避免与其他现有或提议的模板类型冲突。
Because of the pre-installed base of servers using privately agreed upon template types, applications using SOIF need to be able to ascertain whether a referenced template type has been registered. In order to accomplish this, all template type IDENTIFIERS for template types registered with the IANA will begin with the ASCII string "IANA-". An IANA-registered template type based on the GILS specification, for example, might be registered as "IANA-GILS". Should other registrars emerge over time, similar strings must be established and used to compose template type IDENTIFIERS which they assign.
由于预先安装了大量使用私下商定的模板类型的服务器，因此使用SOIF的应用程序需要能够确定引用的模板类型是否已注册。为了实现这一点，向IANA注册的模板类型的所有模板类型标识符都将以ASCII字符串“IANA-”开头。例如，基于GILS规范的IANA注册模板类型可能注册为“IANA-GILS”。如果随着时间的推移出现了其他注册者，则必须建立类似的字符串，并将其用于组成他们分配的模板类型标识符。
The URL associated with a particular summary object is determined by the application generating the object. Applications must generate valid URLs according to the rules of [Ref 6.], but there is no restriction on what sorts of URLs may be associated with particular template types. The use of a particular template type indicates the type of information contained in the summary object, not how the inital resource being summarized was accessed. This aspect of SOIF summary objects is therefor not subject to registration.
与特定摘要对象关联的URL由生成该对象的应用程序确定。应用程序必须根据[Ref 6.]的规则生成有效的URL，但对与特定模板类型关联的URL类型没有限制。使用特定模板类型表示摘要对象中包含的信息的类型，而不是如何访问要摘要的初始资源。因此，SOIF摘要对象的这一方面不需要注册。
Where an ATTRIBUTE associated with a proposed template type exactly matches an ATTRIBUTE previously defined in a registered template type, the proposed ATTRIBUTE should be defined by reference to the existing, registered ATTRIBUTE. This allows query referral meshes to easily map queries against ATTRIBUTEs derived from different template types and provides an easy method for extending or restricting an existing template type to match an application's particular needs. In such cases, the ATTRIBUTE for the newly registered template type will have the same name, description, and allowed values as the ATTRIBUTE in the existing registered template type.
如果与建议的模板类型关联的属性与先前在注册的模板类型中定义的属性完全匹配，则应通过引用现有的注册属性来定义建议的属性。这允许查询引用网格轻松地将查询映射到从不同模板类型派生的属性，并提供了一种扩展或限制现有模板类型以匹配应用程序特定需要的简单方法。在这种情况下，新注册模板类型的属性将与现有注册模板类型中的属性具有相同的名称、描述和允许的值。
Where no existing ATTRIBUTE may be referenced, registrants must specify each ATTRIBUTE's name, description, and allowed values.
如果不能引用现有属性，注册者必须指定每个属性的名称、描述和允许值。
To handle multiple VALUEs for the same ATTRIBUTE, SOIF uses a naming convention, appending a hyphen and a positive integer to the base ATTRIBUTE name to create a unique ATTRIBUTE IDENTIFIER. For example, the ATTRIBUTE IDENTIFIERs "Publisher-1", "Publisher-2", and "Publisher-3" can be used to associate three VALUEs with the ATTRIBUTE named "Publisher". In order to provide for the unimpeded operation of this convention, ATTRIBUTE names may not terminate with a hyphen followed by an integer. ATTRIBUTE names are otherwise restricted only by the grammar defined in [Ref. 1].
为了处理同一属性的多个值，SOIF使用命名约定，在基本属性名称后添加连字符和正整数，以创建唯一的属性标识符。例如，属性标识符“Publisher-1”、“Publisher-2”和“Publisher-3”可用于将三个值与名为“Publisher”的属性相关联。为了使此约定的操作畅通无阻，属性名称不能以连字符后跟整数结尾。否则，属性名称仅受[参考文献1]中定义的语法的限制。
In general, registrants will probably wish to propose ATTRIBUTE names which are short, mnemonic, and intuitively associated with the characterstic that the ATTRIBUTE describes. While these may be generally laudable goals, it must be remembered that the application interface need not present the raw ATTRIBUTE name to the end user; indeed, in situations where the end user's language does not use the ASCII character set, the interface must map the ATTRIBUTE name to an appropriate local representation. Since ATTRIBUTE definitions are provided as part of the registration process, registrants should avoid attempting to overload the ATTRIBUTE name with information which belongs in the description.
一般来说，注册者可能希望提出属性名称，这些名称简短、易记，并且直观地与属性描述的特征相关联。虽然这些目标通常值得称赞，但必须记住，应用程序接口不需要向最终用户提供原始属性名称；实际上，在最终用户的语言不使用ASCII字符集的情况下，接口必须将属性名称映射到适当的本地表示形式。由于属性定义是作为注册过程的一部分提供的，因此注册人应避免试图用描述中的信息重载属性名称。
ATTRIBUTE descriptions for ATTRIBUTEs registered with the IANA must be in English, though mappings to other languages may be proposed as part of the ATTRIBUTE description. ATTRIBUTE descriptions should propose clear criteria for establishing whether an object posseses a particular ATTRIBUTE. Descriptions should also include at least two examples of how each attribute relates to an object being summarized,
向IANA注册的属性的属性描述必须使用英语，但可以建议将映射到其他语言作为属性描述的一部分。属性描述应该为确定对象是否拥有特定属性提出明确的标准。描述还应包括至少两个示例，说明每个属性如何与正在汇总的对象相关，
using, where possible, objects which are broadly available to a wide variety of audiences. If several ATTRIBUTEs within a template type inter-relate, the descriptions of each may reference the others; care must be taken, however, that the resulting descriptions are not circular. Where fully realized specifications of the ATTRIBUTEs have been created in other contexts, the salient text from those descriptions should be quoted and appropriate references cited.
在可能的情况下，使用广泛适用于各种受众的对象。如果模板类型中的多个属性相互关联，则每个属性的描述可以引用其他属性；但是，必须注意，结果描述不是循环的。如果在其他上下文中创建了完全实现的属性规范，则应引用这些描述中的突出文本，并引用适当的参考文献。
Each ATTRIBUTE registered for a template type must be marked either required or optional. Note that marking an ATTRIBUTE required does not imply that it may not have a null value; it implies only that it must appear in all templates of that registered template type.
为模板类型注册的每个属性都必须标记为必需或可选。注意，标记属性required并不意味着它可能没有空值；它只意味着它必须出现在该注册模板类型的所有模板中。
For each ATTRIBUTE, the registrant must specify the data format and, if appropriate, the language, character set, and encoding. Where possible, the registrant should include references to a precise and openly available specification of the format. The registrant must also specify the appropriate matching semantics for the ATTRIBUTE if these are not strictly implied by the data format and encoding. The registrant must also note whether null values are permitted.
对于每个属性，注册人必须指定数据格式，如果合适，还必须指定语言、字符集和编码。在可能的情况下，注册人应包括对精确且公开的格式规范的引用。注册人还必须为属性指定适当的匹配语义，如果数据格式和编码没有严格地暗示这些语义。注册人还必须注意是否允许使用空值。
Creating a revision of a template type is functionally similar to creating a new template type. A Registrant may propose as a name any derivative allowed under the rules of section 4.1 and [Ref. 1] to the new template type. ATTRIBUTEs retained across versions without modification should be referenced as described in section 4.3. Modified ATTRIBUTEs must be described as if new. A registrant may note a relationship between a proposed template type and an existing template type as part of the registration process. The following three relationships are currently defined:
创建模板类型的修订版在功能上与创建新模板类型类似。注册人可将第4.1节和[Ref.1]规则允许的任何衍生工具作为新模板类型的名称。如第4.3节所述，应参考未经修改的版本间保留的属性。必须将修改的属性描述为新属性。作为注册过程的一部分，注册人可能会注意到提议的模板类型和现有模板类型之间的关系。目前定义了以下三种关系：
Successor: for proposed template types intended to replace an existing template type.
继任者：用于替换现有模板类型的建议模板类型。
Variant: for proposed template types whose ATTRIBUTEs are either a superset or a subset of an existing template type.
变体：用于属性为现有模板类型的超集或子集的建议模板类型。
Alternate: for proposed template types which share a large number of ATTRIBUTEs with an existing template type but whose ATTRIBUTEs do not form a strict superset or subset of an existing template type.
备选：用于与现有模板类型共享大量属性但其属性不构成现有模板类型的严格超集或子集的建议模板类型。
Note that there may be relationships between ATTRIBUTEs of different template types without there being a named relationship between the template types themselves.
请注意，不同模板类型的属性之间可能存在关系，而模板类型本身之间不存在命名关系。
SOIF template types which are intended for applications which will pass summary objects over the global Internet should contain authentication ATTRIBUTEs. SOIF summary objects lacking authentication ATTRIBUTEs must be treated as unreliable indicators of the referenced resource's content and should only be used where other aspects of the environment provide sufficient security to prevent spoofing. Given, however, that particular template types may be intended for environments with such security, there is no requirement that registered template types contain authentication ATTRIBUTEs. The application developer must select or propose a template type appropriate for the intended appliation environment; if none is available with suitable authentication ATTRIBUTEs, the provisions of section 4.3 make it easy for the developer to propose an extension to an existing template type with the appropriate authentication ATTRIBUTEs.
用于通过全局Internet传递摘要对象的应用程序的SOIF模板类型应包含身份验证属性。缺少身份验证属性的SOIF摘要对象必须被视为引用资源内容的不可靠指标，并且只能在环境的其他方面提供足够的安全性以防止欺骗的情况下使用。但是，鉴于特定模板类型可能适用于具有此类安全性的环境，因此不要求注册的模板类型包含身份验证属性。应用程序开发人员必须选择或提出适合预期应用程序环境的模板类型；如果没有具有适当身份验证属性的模板，则第4.3节的规定使开发人员可以方便地使用适当身份验证属性对现有模板类型提出扩展。
[1] Hardie, T., Bowman, M., Hardy, D., Schwartz, M. and D. Wessels, "CIP Index Object Format for SOIF Objects", RFC 2655, August 1999.
[1] Hardie，T.，Bowman，M.，Hardy，D.，Schwartz，M.和D.Wessels，“SOIF对象的CIP索引对象格式”，RFC 2655，1999年8月。
[2] The Harvest Information Discovery and Access System: <URL:http://harvest.transarc.com/>.
[2] 收获信息发现和访问系统：<URL:http://harvest.transarc.com/>.
[3] D. Beckett, IAFA Templates in Use as Internet Metadata, 4th
Int'l WWW Conference, December 1995,
<URL:http://www.hensa.ac.uk/tools/www/iafatools/>
[3] D. Beckett, IAFA Templates in Use as Internet Metadata, 4th
Int'l WWW Conference, December 1995,
<URL:http://www.hensa.ac.uk/tools/www/iafatools/>
[4] L. Lamport, LaTeX: A Document Preparation System, Addison-Wesley, Reading, Mass., 1986.
[4] 兰波特，《乳胶：文件准备系统》，艾迪生·韦斯利，马萨诸塞州雷丁，1986年。
[5] IETF Schema Registration Working Group.
<URL:http://www.ietf.org/html.charters/wg.dir#Applications_Area>
[5] IETF Schema Registration Working Group.
<URL:http://www.ietf.org/html.charters/wg.dir#Applications_Area>
[6] Berners-Lee, T., Masinter, L. and M. McCahill, "Uniform Resource Locators (URL)", RFC 1738, December 1994.
[6] Berners Lee，T.，Masinter，L.和M.McCahill，“统一资源定位器（URL）”，RFC 17381994年12月。
Ted Hardie Equinix 901 Marshall Street Redwood City, CA 94063 USA
美国加利福尼亚州红木市马歇尔街901号Ted Hardie Equinix 94063
EMail: hardie@equinix.com
EMail: hardie@equinix.com
Appendix A.
附录A。
An Example Registration Form
登记表格范例
1. Registrant's Name ________________________________________
1. 注册人姓名________________________________________
2. Registrant's Organization ________________________________
2. 注册人组织________________________________
3. Registrant's email address _______________________________
3. 注册人的电子邮件地址_______________________________
4. Registrant's postal address ______________________________ ______________________________ ______________________________ ______________________________
4. 注册人的邮政地址______________________________
5. Registrant's telephone number ____________________________
5. 注册人的电话号码____________________________
6. Proposed Template Type IDENTIFIER: IANA-__________________
6. 建议的模板类型标识符：IANA-__________________
7. If this Template Type relates to an existing Template Type list the Template Type(s) and the relationship:
7. 如果此模板类型与现有模板类型相关，请列出模板类型和关系：
Template Type ___________________ Relationship ______________
Template Type ___________________ Relationship ______________
8. For each ATTRIBUTE in this Template type, provide the following information:
8. 对于此模板类型中的每个属性，请提供以下信息：
a) NAME _____________________________________________________
a) NAME _____________________________________________________
b) Reference Template Type __________________________________
b) Reference Template Type __________________________________
If there is no registered Template Type which has already specified this attribute, provide the following information:
如果没有已指定此属性的注册模板类型，请提供以下信息：
c) ATTRIBUTE Description ____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
c) ATTRIBUTE Description ____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
____________________________________
d) Required [] or Optional []?
d) 必需[]还是可选[]？
e) Data Type and ecoding for this VALUE _____________________
_____________________
_____________________
e) Data Type and ecoding for this VALUE _____________________
_____________________
_____________________
f) If a specific language and character set are expected, list
them here ___________________________________________________
f) If a specific language and character set are expected, list
them here ___________________________________________________
g) Is a null value permitted? Yes [] No []
g) 是否允许使用空值？是[]否[]
Copyright (C) The Internet Society (1999). All Rights Reserved.
版权所有（C）互联网协会（1999年）。版权所有。
This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English.
本文件及其译本可复制并提供给他人，对其进行评论或解释或协助其实施的衍生作品可全部或部分编制、复制、出版和分发，不受任何限制，前提是上述版权声明和本段包含在所有此类副本和衍生作品中。但是，不得以任何方式修改本文件本身，例如删除版权通知或对互联网协会或其他互联网组织的引用，除非出于制定互联网标准的需要，在这种情况下，必须遵循互联网标准过程中定义的版权程序，或根据需要将其翻译成英语以外的其他语言。
The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns.
上述授予的有限许可是永久性的，互联网协会或其继承人或受让人不会撤销。
This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
本文件和其中包含的信息是按“原样”提供的，互联网协会和互联网工程任务组否认所有明示或暗示的保证，包括但不限于任何保证，即使用本文中的信息不会侵犯任何权利，或对适销性或特定用途适用性的任何默示保证。
Acknowledgement
确认
Funding for the RFC Editor function is currently provided by the Internet Society.
RFC编辑功能的资金目前由互联网协会提供。