出版物清单

摘要

本规范定义了一种通用清单格式，用于表达数字出版物的信息。它使用 [schema.org] 元数据，并对其进行扩充以包括关于出版物的各种结构属性，以 [json-ld11] 序列化，从而在适应需要表达的信息差异的同时，实现出版格式之间的互操作性。

4. 出版物清单

4.1 要求

清单中 MUST 设置以下属性：

context
conformsTo

以下属性为 RECOMMENDED：

type
id

所有其他属性和资源关系的优先级为 OPTIONAL，但 MAY 由清单格式的实现修改。

注

某些属性是隐式必需的，因为当未显式创作时，它们会从其他信息编译而来。更多信息见 § A. 内部表示数据模型。

4.2 值类别

本节描述可用于出版物清单属性的值类别。

4.2.1 字面量

当清单属性期望以字面文本字符串——即不依赖语言的值，例如代码值或日期——作为其值时，该值 MUST 表达为 [json] 字符串。

字面量值在清单处理期间不会被更改，不同于其他可能会例如被转换为对象的值。

4.2.2 数字

当清单属性期望以数字作为其值时，该值 MUST 表达为 [json] 数字。

4.2.3 布尔值

当清单属性期望以布尔值作为其值时，该值 MUST 表达为 [ecmascript] 布尔值（true 或 false）。

4.2.4 显式对象和隐含对象

各种清单属性预期表达为 [json] 对象。虽然通常建议使用显式对象，但以下各节标识了也可以使用字符串值的情况。这些字符串会在用户代理处理清单期间自动转换为对象（文本值到对象的确切映射包含在每个定义中）。

4.2.4.1 可本地化字符串

当清单属性期望以可本地化文本字符串作为其值时，该值 MUST 表达为以下之一：

一个 [json] 字符串值；或
一个 LocalizableString。

单个字符串值表示一个隐含对象，其 value 属性是该字符串的文本，其语言和基本方向由清单中的其他信息确定。

由于可本地化字符串旨在便于一个值的多语言表示，因此接受可本地化字符串的属性始终接受这些值的数组。因此，虽然只需创作单个字符串或对象，但为了处理的一致性，此类值会转换为数组。

LocalizableString 是一个 [json] 对象，由以下属性组成：

术语	描述	必需值	值类别	[schema.org] 映射
`value`	可本地化字符串的值。REQUIRED。	文本。	字面量	（无）
`language`	值的语言。OPTIONAL。	一个格式良好的语言标签 [bcp47]。	字面量	（无）
`direction`	值的基本方向。OPTIONAL。	`ltr` 或 `rtl`	字面量	（无）

基本方向值的含义为：

ltr：表示文本值被显式定向设置为从左到右文本。
rtl：表示文本值被显式定向设置为从右到左文本。

缺失基本方向值意味着文本值会被显式定向设置为第一个具有强方向性的字符的方向，遵循 Unicode 双向算法 [bidi] 的规则。

示例 1 ：设置字符串的语言

{
    "value"     : "孔子",
    "language"  : "zh"
}

示例 2 ：设置字符串的语言和基本方向

{
    "value"     : "HTML היא שפת סימון.",
    "language"  : "he",
    "direction" : "rtl"
}

注

如果在最后一个示例中未设置基本方向值，则由于字符串开头存在拉丁字符，文本将按照 Unicode 双向算法 [bidi] 显示为：

HTML היא שפת סימון.

但是，这将是不正确的。额外的 direction 值对于控制显示以产生以下结果是必需的：

HTML היא שפת סימון.

请注意，示例中的 value 字段表示文本在内存中的存储方式，因此它与此处描绘的两种渲染之间存在差异。文本编辑器也可能以不同方式显示 JSON 值（例如，仅使用 Unicode 双向算法）。

另请参阅 [string-meta] 文档以获取进一步说明和示例。

4.2.4.2 实体

当清单属性期望以实体（即负责创作各个方面的个人或组织）作为其值时，该值 MUST 表达为以下之一：

一个 [json] 字符串值；或
一个 Entity。

单个字符串值表示 Entity 对象的一个实例，其 name 属性是该字符串的文本，其 type 被假定为 Person [schema.org]。

Entity 被定义为 [schema.org] Person 或 Organization 类型的一个实例，具有以下最小属性集：

术语	描述	必需值	值类别	[schema.org] 映射
`type`	实体的类型。OPTIONAL	一个或多个 Text。序列 MUST 包含 "`Person`" 或 "`Organization`"。	数组，由字面量组成	（无）
`name`	实体名称。REQUIRED。	一个或多个 Text。	数组，由可本地化字符串组成	`name`
`id`	与实体关联的规范标识符。OPTIONAL。	URL 记录 [url]。	标识符	（无）
`url`	与实体关联的地址。OPTIONAL。	有效的 URL 字符串 [url]。	URL	`url`
`identifier`	与实体关联的标识符（例如 ORCID）。OPTIONAL。	一个或多个 Text。	数组，由字面量组成	`identifier`

注

此最小属性集不是限制性的。作者可以根据需要包含为 [schema.org] Person 或 Organization 类型定义的任何附加属性。用户代理同样不限于仅解释前述属性。

示例 3 ：使用字符串而不是 Person 对象。

以下作者姓名表达为字符串：

{
    …
    "author" : "Edgar Allen Poe",
    …
}

但在创建者的上下文中，它等同于：

{
    …
    "author" : {
        "type" : "Person",
        "name" : "Edgar Allen Poe"
    },
    …
}

（进一步详情见 § 4.7.1.5 创建者。）

4.2.4.3 链接资源

当清单属性链接到一个或多个资源时，它 MUST 表达为以下之一：

一个 [json] 字符串，编码资源的 URL；或
一个 LinkedResource 的实例。

字符串值表示一个隐含的 LinkedResource 对象，其 url 属性设置为该字符串值。

LinkedResource 对象定义如下：

术语	描述	必需值	值类别	[schema.org] 映射
`type`	资源的类型。OPTIONAL	一个或多个 Text。序列 MUST 包含 "`LinkedResource`"。	数组，由字面量组成	（无）
`url`	资源的位置。REQUIRED。	有效的 URL 字符串 [url]。请参阅接受此类型的属性定义，以了解附加限制。	URL	`url`
`encodingFormat`	资源的媒体类型（例如 `text/html`）。OPTIONAL。	MIME 媒体类型 [rfc2046]。	字面量	`encodingFormat`
`name`	项目名称。OPTIONAL。	一个或多个 Text。	数组，由可本地化字符串组成	`name`
`description`	项目描述。OPTIONAL。	一个或多个 Text。	数组，由可本地化字符串组成	`description`
`rel`	资源与出版物之间的关系。OPTIONAL。	一个或多个关系。关键词是 ASCII 大小写不敏感的 [infra]，并且 MUST 按此方式比较。	数组，由字面量组成	（无）
`integrity`	资源的密码学哈希，可用于验证其完整性。 OPTIONAL。	一个或多个以空白分隔的完整性元数据集合 [sri]。该值 MUST 符合元数据定义 [sri]。请参阅 [sri]，了解用户代理预期支持的密码学哈希函数列表。	字面量	（无）
`duration`	基于时间的媒体资源的总时长。OPTIONAL	由 [iso8601-1] 定义的时长值。	字面量	`duration`（Property）
`alternate`	对资源在替代格式中的一个或多个重述的引用，其中 `encodingFormat` 指定该重述的格式。 OPTIONAL。	以下一项或多项：一个字符串，表示替代格式中资源重述的 URL；或一个 `LinkedResource` 对象的实例字符串值表示一个隐含的 `LinkedResource` 对象，其 `url` 属性设置为该字符串值。	数组，由链接资源组成	（无）

虽然用户代理对 integrity 属性的支持为 OPTIONAL，但支持使用此属性进行密码学哈希比较的用户代理 MUST 按照 [sri] 执行。

本规范仅定义用于从替代格式中选择的 alternate 属性（即基于 encodingFormat 或通过检查 URL）。配置文件 MAY 扩展此行为，以允许基于其他标准进行选择。选择替代资源的过程见 § B. 选择替代资源。

注

定义 LinkedResource 对象时，建议始终使用 encodingFormat 属性指定资源的媒体类型。这样做可使用户代理更容易确定资源的可用性。

示例 4 ：带有其内容 SHA-256 哈希的资源。

{
    "type"           : "LinkedResource",
    "url"            : "chapter1.html",
    "encodingFormat" : "text/html",
    "name"           : "Chapter 1 - Loomings",
    "integrity"      : "sha256-13AE04E21177BABEDFDE721577615A638341F963731EA936BBB8C3862F57CDFC"
}

示例 5 ：带有其替代格式的资源。

{
    "type"           : "LinkedResource",
    "url"            : "chapter1.mp3",
    "encodingFormat" : "audio/mpeg",
    "name"           : "Chapter 1 - Loomings",
    "alternate"      : [
        "chapter1.html",
        {
            "type": "LinkedResource",
            "url": "chapter1.json",
            "encodingFormat": "application/vnd.syncnarr+json",
            "duration": "PT1669S"
        }
    ]
}

示例 6 ：资源列表，其中包含一个使用相对 URL 作为字符串（“datatypes.svg”）的链接，以及两个显示 LinkedResource 对象各种属性的链接。

{
    …
    "resources" : [
        "datatypes.svg",
        {
            "type"            : "LinkedResource",
            "url"             : "test-utf8.csv",
            "encodingFormat"  : "text/csv",
            "name"            : "Test Results",
            "description"     : "CSV file containing the full data set used."
        },
        {
            "type"            : "LinkedResource",
            "url"             : "terminology.html",
            "encodingFormat"  : "text/html",
            "rel"             : "glossary"
        }
    ],
    …
}

4.2.4.4 对象

当清单属性期望某种对象类型，而该对象类型未在本节中定义，也未由配置文件定义时，它 MUST 表达为 [json] 对象（即，该属性的值不会被处理以创建对象）。

4.2.5 URL

URL 用于标识与数字出版物关联的资源。当属性期望 URL 值时，它 MUST 是一个有效的 URL 字符串 [url]。

对于相对 URL 字符串，它们会使用基 URL [url] 解析为绝对 URL 字符串。

用于相对 URL 字符串的基 URL 按如下方式确定：

对于嵌入式清单，它是嵌入文档的文档基 URL [json-ld11]。
对于链接清单，它是清单资源的 URL。
对于使用另一种方式发现清单的数字出版物格式，它由该格式定义。

因此，嵌入式清单中的相对 URL 字符串会根据引用该清单的文档的 URL 解析，除非该文档声明了基 URL（即在其头部中使用 <base> 元素）。

4.2.6 标识符

标识符用于以持久且无歧义的方式指代数字出版物以及负责其创作的实体。URL、URN、DOI、ISBN 和 PURL 都是出版中经常使用的持久标识符示例。

标识符 MUST 表达为URL 记录 [url]

4.2.7 数组

当清单属性允许一个或多个相应类型的值（例如字面量、对象或 URL）时，这些值会表达为 [json] 数组。不过，当属性值为单个元素时，数组语法 MAY 被省略。

示例 7 ：使用文本字符串而不是数组。

由于数字出版物通常包含许多资源，因此这一单个资源声明：

{
    …
    "resources" : "datatypes.svg",
    …
}

等同于数组：

{
    …
    "resources" : ["datatypes.svg"],
    …
}

4.3 清单上下文

清单 MUST 使用以下两个组成部分按指定顺序设置其 JSON-LD 上下文 [json-ld11]：

[schema.org] 上下文：https://schema.org
出版物上下文： https://www.w3.org/ns/pub-context

注

虽然 Schema.org 通常使用 http URI 方案引用，但该词汇表正在迁移为默认使用安全的 https 方案。因此，在出版物清单上下文中只识别 https 方案。

示例 8 ：设置上下文声明。

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context"
    ],
    …
}

出版物上下文文档会向 Schema.org 中定义的属性添加特性（例如，要求 creator 属性保持顺序）。

本规范的配置文件 MAY 要求额外的上下文 URL，但这些 URL MUST 排在这两个组成部分之后。

可通过在出版物上下文之后的对象中包含额外参数来扩展上下文，例如全局语言和方向声明。

示例 9

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context",
        {
            "language" : "es"
        }
    ],
    …
}

4.4 清单语言和方向

清单中的每个自然语言属性值（例如 title、creators）都有默认的自然语言，即它所使用的语言（例如英语、法语、中文）。它还具有书写时使用的自然基本方向—— 即显示方向，从左到右或从右到左。

数字出版物清单提供了将这两个概念全局设置以及在单个项目上设置的能力，以帮助用户代理解释和呈现元数据。

注

设置基本方向的能力是 JSON-LD 1.1 [json-ld11] 的特性。换句话说，Publication Manifest 依赖于 JSON-LD 规范的该版本（而不是更早的 1.0 [json-ld10] 版本）。

4.4.1 全局声明

自然语言清单属性的全局语言和基本方向声明会在上下文中使用 language 和 direction 关键词 [json-ld11] 分别设置。这些值用于在清单处理期间将简单字符串值扩展为可本地化字符串，也用于为省略语言或基本方向的可本地化字符串提供语言和基本方向。

language 的值 MUST 是一个格式良好的语言标签 [bcp47]。

direction 的值 MUST 是以下值之一：

"ltr"：表示文本值被显式定向设置为从左到右文本。
"rtl"：表示文本值被显式定向设置为从右到左文本。

全局语言和基本方向声明在存在时 MUST 跟随出版物上下文。

未为全局语言或基本方向指定默认值。

示例 10 ：声明法语为清单的默认语言。

{
    "@context": [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context", 
        {
            "language": "fr"
        }
    ],
    …
}

示例 11 ：声明阿塞拜疆语为默认语言，并将基本方向设为从右到左。

{
    "@context": [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context", 
        {
            "language": "az",
            "direction": "rtl"
        }
    ],
    …
}

4.4.2 特定项目声明

可以使用可本地化字符串，为清单中的任何自然语言值局部设置语言或基本方向：

示例 12 ：为中文出版物提供英文作者姓名。

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context",
        {
            "language": "zh"
        }
    ],
    "type"     : "Book",
    …
    "author" : {
        "type" : "Person"
        "name" : [
            "孔子",
            {
                "value" : "Confucius",
                "language" : "en"				
            }
        ]
    }
}

示例 13 ：阿拉伯语出版物，同时给出英文标题。

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context",
        {
            "language": "ar"
        }
    ],
    "type"     : "Book",
    …
    "name" : [
        {
            "value": "HTML و CSS: تصميم و إنشاء مواقع الويب",
            "direction": "rtl"
        },
        {
            "value"    : "HTML and CSS: Design and Build Websites",
            "language" : "en"
        }
    ]
}

阿拉伯语标题（即 HTML و CSS: تصميم و إنشاء مواقع الويب）的额外基本方向设置对于产生正确显示是必需的：

language 和 direction 关键词 [json-ld11] 的可能值与全局声明相同。此外，这两个值也可以是 null 的（JSON）值，表示分别没有设置显式语言或方向。

注

如果某个值（例如组织名称）通常在没有任何关联语言的情况下使用（例如“Google”），则将 language 的值设置为 null 会很有用。

语言或基本方向的局部声明优先于全局声明。

4.5 出版物类型

数字出版物的清单使用 type 关键词 [json-ld11] 定义其出版物类型。该类型 MAY 映射到任何 [schema.org] 类型，但如果未指定类型，则CreativeWork 会被假定为默认值。

示例 14 ：将出版物的类型设置为 CreativeWork。

{
    "@context" : ["https://schema.org", "https://www.w3.org/ns/pub-context"],
    "type"     : "CreativeWork",
    …
}

可使用 CreativeWork 的更具体子类型，例如 Article、Book、TechArticle 和 Course，来代替 CreativeWork，或与其同时使用。

示例 15 ：将出版物的类型设置为 Book。

{
    "@context" : ["https://schema.org", "https://www.w3.org/ns/pub-context"],
    "type"     : "Book",
    …
}

每个 Schema.org 类型都会定义一组可与其一起使用的有效属性。为确保清单可由感知 Schema.org 的处理器验证和处理，清单 SHOULD 只包含与所选类型关联的属性。

如果需要来自多个类型的属性，清单 MAY 包含多个类型声明。

示例 16 ：为结合了 Book 和 VisualArtwork 属性的出版物设置 type 属性。

{
    "@context" : ["https://schema.org", "https://www.w3.org/ns/pub-context"],
    "type"     : ["Book", "VisualArtwork"],
    …
}

用户代理 SHOULD NOT 因清单对其声明的 Schema.org 类型无效而处理失败。

注

请参阅 Schema.org 网站，获取 CreativeWork 子类型的完整列表。

4.6 配置文件一致性

数字出版物使用 conformsTo 属性指明其清单和内容所符合的配置文件。

术语	描述	必需值	值类别	[dcterms] 映射
`conformsTo`	配置文件的 URL。	一个带片段的绝对 URL 字符串 [url]。	数组，由字面量组成	conformsTo

用于配置文件的 URL 在其各自的规范中定义。

注

conformsTo 属性也可用于指示符合其他规范和标准（例如 [wcag21]）。

示例 17 ：标识数字出版物符合 W3C 有声书规范。

{
    …
    "conformsTo" : "https://www.w3.org/TR/audiobooks/",
    …
}

4.7 属性

4.7.1 描述性属性

4.7.1.1 删节版

abridged 属性提供关于数字出版物是否已从其原始形式缩短的信息。

术语	描述	必需值	值类别	[schema.org] 映射
`abridged`	指示该图书是否为删节版。	`true` 或 `false`。	布尔值	`abridged`（Book）

示例 18 ：设置出版物为删节版。

{
    …
    "abridged" : true,
    …
}

4.7.1.2 无障碍

无障碍属性提供关于数字出版物是否适合具有不同首选阅读方式的用户使用的信息。这些属性通常补充针对既定无障碍标准的评估，例如 [wcag21] 中提供的标准。

以下属性归类为无障碍属性：

术语	描述	必需值	值类别	[schema.org] 映射
`accessMode`	人可以通过其处理或感知信息的人类感觉感知系统或认知能力。	一个或多个 Text。	数组，由字面量组成	`accessMode`（CreativeWork）
`accessModeSufficient`	足以理解资源全部智力内容的单一或组合访问模式列表。	一个或多个 ItemList。	数组，由对象组成	`accessModeSufficient` （CreativeWork）
`accessibilityFeature`	资源的内容特性，例如无障碍媒体、替代内容以及支持无障碍的增强功能。	一个或多个 Text。	数组，由字面量组成	`accessibilityFeature` （CreativeWork）
`accessibilityHazard`	所描述资源中对某些用户在生理上有危险的特征。	一个或多个 Text。	数组，由字面量组成	`accessibilityHazard` （CreativeWork）
`accessibilitySummary`	特定无障碍特性或缺陷的人类可读摘要，与其他无障碍元数据保持一致。	Text。	数组，由可本地化字符串组成	`accessibilitySummary` （CreativeWork）

注

这些属性的详细描述，包括与其一起使用的预期值，可在 [webschemas-a11y] 中获得。

注

如果需要的信息多于这些属性所能表达的内容，也可以提供对详细无障碍报告的引用。

示例 19 ：为出版物设置无障碍元数据，该出版物为每个图像提供适当的替代文本和长描述，使其能够以纯文本形式阅读。

{
    …
    "accessMode"              : ["textual", "visual"],
    "accessibilityFeature"    : ["alternativeText", "longDescription"]
    "accessModeSufficient"    : [
        {
            "type"            : "ItemList",
            "itemListElement" : ["textual", "visual"]
        },
        {
            "type"            : "ItemList",
            "itemListElement" : ["textual"]
        }
    ],
    …
}

4.7.1.3 地址

地址是一个URL，用于标识数字出版物的源位置。它使用 url 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`url`	出版物的 URL。	有效的 URL 字符串 [url]。	数组，由URL组成	`url`（Thing）

数字出版物 MAY 具有多个地址，但所有地址 MUST 解析为同一文档。

注

出版物的地址也可以用作 identifier 链接关系 [link-relation] 的值。

示例 20 ：设置出版物的地址。

{
    …
    "url" : "https://publisher.example.org/frankenstein",
    …
}

4.7.1.4 规范标识符

数字出版物的规范标识符属性为数字出版物提供唯一标识符。它使用 id 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`id`	出版物的首选版本。	URL 记录 [url]。	标识符	（无）

注

确保规范标识符唯一性不在本规范范围内。实际可达到的唯一性取决于诸如所用标识符方案的约定以及对标识符分配的控制程度等因素。

如果清单中未提供规范标识符，或者该值是无效 URL，则数字出版物没有规范标识符。用户代理 MUST NOT 尝试从清单中提供的任何其他标识符构造规范标识符。

规范标识符的指定 MAY 通过使用 identifier 属性 [schema.org] 和/或其子类型包含其他类型的标识符来补充。

示例 21 ：将规范标识符和地址设置为 URL。

{
    …
    "id"  : "http://www.w3.org/TR/tabular-data-model/",
    "url" : "http://www.w3.org/TR/2015/REC-tabular-data-model-20151217/",
    …
}

示例 22 ：使用 URN 作为规范标识符。

{
    …
    "id"  : "urn:isbn:9780123456789",
    "url" : "https://publisher.example.org/wuthering-heights",
    …
}

4.7.1.5 创建者

创建者是负责创作数字出版物的个人或组织。

以下属性归类为创建者：

术语	描述	必需值	值类别	[schema.org] 映射
`artist`	出版物的主要艺术家，媒介不是铅笔或数字线稿。	一个或多个 `Person`。	数组，由实体组成	`artist`（VisualArtwork）
`author`	出版物的作者。	一个或多个 `Person` 和/或 `Organization`。	数组，由实体组成	`author`（CreativeWork）
`colorist`	为已描墨图画上色的个人。	一个或多个 `Person`。	数组，由实体组成	`colorist`（VisualArtwork）
`contributor`	其角色不适合本表其他角色之一的贡献者。	一个或多个 `Person` 和/或 `Organization`。	数组，由实体组成	`contributor`（CreativeWork）
`creator`	出版物的创建者。使用此属性可能导致用户代理中的结果不一致。它在 [schema.org] 中被标记为 author 的同义词，但没有关于哪一个优先或如何组合它们的指导。建议只使用其中之一，并优先使用更具体的 author 属性。	一个或多个 `Person` 和/或 `Organization`。	数组，由实体组成	`creator`（CreativeWork）
`editor`	出版物的编辑。	一个或多个 `Person`。	数组，由实体组成	`editor`（CreativeWork）
`illustrator`	出版物的插画师。	一个或多个 `Person`。	数组，由实体组成	`illustrator`（Book）
`inker`	用墨水描摹铅笔画的个人。	一个或多个 `Person`。	数组，由实体组成	`inker`（VisualArtwork）
`letterer`	向美术作品添加文字，包括对话气泡和音效的个人。	一个或多个 `Person`。	数组，由实体组成	`letterer`（VisualArtwork）
`penciler`	绘制主要叙事美术作品的个人。	一个或多个 `Person`。	数组，由实体组成	`penciler`（VisualArtwork）
`publisher`	出版物的出版者。	一个或多个 `Person` 和/或 `Organization`。	数组，由实体组成	`publisher`（CreativeWork）
`readBy`	朗读（表演）出版物的人（用于有声书）。	一个或多个 `Person`。	数组，由实体组成	`readBy`（Audiobook）
`translator`	出版物的译者。	一个或多个 `Person` 和/或 `Organization`。	数组，由实体组成	`translator`（CreativeWork）

创建者 MUST 表示为以下之一：

一个 [json] 字符串，编码某个 Person [schema.org] 的名称；或
Person 或 Organization [schema.org] 的实例。

单个字符串值是 [schema.org] Person 的简写，其 name 属性设置为该字符串值。（另见 § 4.2.4.2 实体。）

清单 MAY 包含每种类型的多个创建者。

示例 23 ：设置图书的作者。

{
    …
    "url"      : "https://publisher.example.org/alice-in-wonderland",
    "author"   : {
        "type"  : "Person",
        "name"  : "Lewis Carroll"
    }
}

示例 24 ：分离编辑、作者和出版者。部分人员以简单字符串而不是对象表达。

{
    …
    "author"     : [
        "Jeni Tennison",
        {
            "type"       : "Person",
            "name"       : "Gregg Kellogg",
        },
        {
            "type"       : "Person",
            "name"       : "Ivan Herman",
            "id"         : "https://www.w3.org/People/Ivan/"
            "identifier" : "0000-0003-0782-2704",
        }
    ],
    "editor"    : [
        "Jeni Tennison",
        {
            "type" : "Person",
            "name" : "Gregg Kellogg",
        }
    ],
    "publisher" : {
        "type" : "Organization",
        "name" : "World Wide Web Consortium",
        "id"   : "https://www.w3.org/"
    }
    …
}

4.7.1.6 时长

全局时长表示 基于时间的 数字出版物的总长度（例如有声书，或由一系列视频剪辑组成的图书）。它使用 duration 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`duration`	基于时间的出版物的总时长。	由 [iso8601-1] 定义的时长值。	字面量	`duration`（Property）

示例 25 ：以秒为单位设置全局时长。

{
    …
    "type"     : "Audiobook",
    "id"       : "https://example.org/flatland-a-romance-of-many-dimensions/",
    "url"      : "https://w3c.github.io/pub-manifest/experiments/audiobook/",
    "name"     : "Flatland: A Romance of Many Dimensions",
    …
    "duration" : "PT15153S",
    …
}

注

相关 Wikipedia 页面对 ISO 时长语法给出了简要描述。

4.7.1.7 最后修改日期

最后修改日期是数字出版物最后更新的日期（即最近一次对出版物的任何资源做出更改的时间，包括清单）。它使用 dateModified 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`dateModified`	出版物的最后修改日期。	`Date` 或 `DateTime` 值 [schema.org]，二者分别以 ISO 8601 日期或日期时间格式表达 [iso8601-1]。	字面量	`dateModified`（CreativeWork）

最后修改日期不一定反映出版物的所有更改（例如，如果某种数字出版物格式允许引用第三方内容）。用户代理 SHOULD 检查各个资源的最后修改日期，以确定它们是否已更改并需要更新。

示例 26 ：设置出版物的最后修改日期。

{
    …
    "dateModified" : "2015-12-17",
    …
}

4.7.1.8 发布日期

发布日期是数字出版物最初发布的日期。它表示出版物生命周期中的一个静态事件，并允许后续修订被识别和比较。它使用 datePublished 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`datePublished`	出版物的创建日期。	`Date` 或 `DateTime`，二者分别表达为 ISO 8601 日期或日期时间格式 [iso8601-1]。	字面量	`datePublished`（CreativeWork）

确切的发布时间有意留待解释：它可以是出版物首次可用的时间，也可以是发布前的某个时间点，即出版物被认为已定稿的时间。

示例 27 ：设置出版物的创建日期和修改日期。

{
    …
    "datePublished" : "2015-12-17",
    "dateModified"  : "2016-01-30",
    …
}

4.7.1.9 出版物语言

数字出版物至少有一种自然语言，即内容所表达使用的语言（例如英语、法语、中文）。清单包含以下属性来设置此概念，该概念可影响例如用户代理的行为（例如预加载词典或文本转语音引擎）。

术语	描述	必需值	值类别	[schema.org] 映射
`inLanguage`	出版物的默认语言。	一个或多个格式良好的语言标签 [bcp47]。	数组，由字面量组成	`inLanguage`（Property）

自然语言 MUST 是一个格式良好的语言标签 [bcp47]。

如果用户代理需要出版物语言，而清单中没有该语言，或者获得的值不是格式良好的 [bcp47]，则用户代理 MAY 在生成其内部表示时尝试确定出版物语言。本规范不强制规定如何创建此类语言标签。用户代理可以：

使用清单的语言声明；
使用在默认阅读顺序中的资源内找到的第一个语言声明；或
使用自行设计的算法计算语言。

如果用户代理需要出版物的主要语言，并且指定了多种语言，则 inLanguage 数组中的第一个条目 MUST 被识别为主要语言。

注

区分出版物的语言与构成它的各个资源的语言很重要。例如，如果这些资源是 HTML，则也需要在这些资源中设置语言。出版物的语言不会被继承。

4.7.1.10 阅读推进方向

阅读推进方向建立在数字出版物内从一个资源到下一个资源的阅读方向。它用于适配出版物级别交互，例如菜单位置、触摸手势、交换方向以及下一页和上一页的点击区域。阅读推进使用 readingDirection 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`readingProgression`	从一个资源到另一个资源的阅读推进方向。	以下之一：`ltr` 或 `rtl`。	字面量	（无）

此属性的值 MUST 是以下之一：

ltr：从左到右；或
rtl：从右到左。

默认值为 ltr。如果未设置 readingProgression，用户代理在生成其内部表示时 MUST 使用默认值。

此属性对单个主要资源的渲染没有影响；它只与从一个资源到另一个资源的推进方向相关。

示例 28 ：将阅读推进显式设置为 ltr （从左到右）。

{
    …
    "readingProgression" : "ltr",
    …
}

4.7.1.11 标题

标题提供数字出版物的人类可读名称。它使用 name 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`name`	出版物的人类可读标题。	一个或多个 Text。	数组，由可本地化字符串组成	`name`（Thing）

如果清单中未包含标题，用户代理 MUST 创建一个。获取标题的过程定义于 § 7.4.3 添加默认值。

注

当未指定标题时，不期望用户代理为出版物生成有意义的标题 [wcag21]。

示例 29 ：显式设置图书的标题。

{
    …
    "name" : "Heart of Darkness",
    …
}

4.7.2 资源分类属性

出版物资源通过默认阅读顺序、资源列表和链接指定，如本节所定义。这些列表包含对信息性资源的引用，例如隐私政策，以及结构性资源，例如目录。

注

无需在这些列表中的任何一个中包含对清单的引用。

4.7.2.1 默认阅读顺序

默认阅读顺序是穿过一组数字出版物资源的特定推进路径。用户可能沿替代路径浏览内容，但在没有此类交互的情况下，默认阅读顺序定义从一个资源到下一个资源的预期推进。

默认阅读顺序使用 readingOrder 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`readingOrder`	穿过数字出版物资源的推进顺序。	一个或多个 `LinkedResource`。	数组，由链接资源组成	（无）

readingOrder 属性的每个元素 MUST 表达为：

一个 [json] 字符串，表示资源的 URL；或
LinkedResource 对象的实例。

单个字符串值表示 LinkedResource 对象的一个实例，其 url 属性是该字符串的文本。

项目的顺序具有意义。

阅读顺序中表达的 URL MAY 包含片段标识符，尽管本规范的配置文件 MAY 限制其使用，以及支持哪些方案和特性。片段标识符应按其各自规范的定义解释（例如，要将用户移动到的起始位置，或在移动到阅读顺序中的下一个项目之前要渲染的内容范围）。

资源 SHOULD NOT 在阅读顺序中列出多次，因为这可能导致用户代理中出现意外结果（例如，指向该资源的链接可能无法解析为阅读顺序中的正确实例）。

当数字出版物仅由链接到清单的资源组成时，默认阅读顺序 MAY 被省略。当默认阅读顺序不存在时，用户代理在编译内部表示时 MUST 包含链接资源的条目。更多信息见 § 7.4.3 添加默认值。

默认阅读顺序在清单处理之后 MUST 至少包含一个资源。

示例 30 ：将阅读顺序表达为简单的 URL 列表。

{
    …
    "readingOrder" : [
        "html/title.html",
        "html/copyright.html",
        "html/introduction.html",
        "html/epigraph.html",
        "html/c001.html",
        …
    ],
    …
}

示例 31 ：将阅读顺序表达为 LinkedResource 对象，以提供更多信息。

{
    …
    "readingOrder" : [
        {
            "type"           : "LinkedResource",
            "url"            : "html/title.html",
            "encodingFormat" : "text/html",
            "name"           : "Title page"
        },
        {
            "type"           : "LinkedResource",
            "url"            : "html/copyright.html",
            "encodingFormat" : "text/html",
            "name"           : "Copyright page"
        },
        …
    ],
    …
}

4.7.2.2 资源列表

资源列表枚举在数字出版物的处理或渲染中使用、但尚未列在默认阅读顺序中的任何附加资源。它使用 resources 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`resources`	出版物处理或渲染中使用的附加出版物资源列表。	一个或多个 `LinkedResource`。	数组，由链接资源组成	（无）

resources 属性的每个元素 MUST 表达为以下之一：

一个 [json] 字符串，表示资源的 URL；或
LinkedResource 对象的实例。

单个字符串值表示 LinkedResource 对象的一个实例，其 url 属性是该字符串的文本。

项目的顺序不具有意义。

为避免有关资源的信息发生冲突，特定资源的 URL SHOULD NOT 在资源列表中重复。

资源列表中表达的 URL SHOULD NOT 包含片段标识符。

资源列表的完整性可能影响数字出版物在某些阅读场景中的可用性（例如离线阅读能力）。因此，强烈建议提供出版物所有组成资源的完整列表，超出默认阅读顺序中列出的那些资源。

在某些情况下，可能不容易获得这些资源的完整列表（例如，从其源代码深处引用资源的第三方脚本），但即使其中一些资源未被标识为属于出版物，用户代理 SHOULD 仍然能够渲染出版物（例如，如果它在没有这些资源的情况下被离线使用）。

示例 32 ：通过简单 URL 字符串和 LinkedResource 对象的组合表达资源列表。

{
    …
    "resources"  : [
        "datatypes.html",
        "datatypes.svg",
        "datatypes.png",
        "diff.html",
        {
            "type"           : "LinkedResource",
            "url"            : "test-utf8.csv",
            "encodingFormat" : "text/csv"
        },
        {
            "type"           : "LinkedResource",
            "url"            : "test-utf8-bom.csv",
            "encodingFormat" : "text/csv"
        },
        …
    ],
    …
}

4.7.2.3 链接

链接列表用于提供对数字出版物的处理和渲染不需要的资源列表（即，即使这些资源不可用，出版物的内容也不受影响）。链接使用 links 属性表达。

术语	描述	必需值	值类别	[schema.org] 映射
`links`	与出版物关联但其处理或渲染不需要的资源列表。	一个或多个 `LinkedResource`。	数组，由链接资源组成	（无）

links 属性的每个元素 MUST 表达为以下之一：

一个 [json] 字符串，表示资源的 URL；或
LinkedResource 对象的实例。

单个字符串值表示 LinkedResource 对象的一个实例，其 url 属性是该字符串的文本。

项目的顺序不具有意义。

RECOMMENDED 使用设置了 rel 值的 LinkedResource 对象。

链接资源通常提供给用户代理，用于增强或改进处理或渲染，例如：

用户代理可从书架提供链接的隐私政策或许可证；
用户代理可用来发现并显示有关出版物更多信息的元数据记录；或
用户代理可处理以提供增强语言帮助的术语词典。

链接也可用于标识在线渲染出版物时使用的资源，但当出版物被离线或打包时，这些资源不是必须包含的（例如，为了最小化大小）。这些包括：

增强出版物外观但对其显示并非至关重要的大型字体文件（即，后备字体即可满足需要）；或
不打算在出版物离线或打包时使用的第三方脚本（例如跟踪脚本）。

links 列表 SHOULD 包含渲染链接资源所需的资源（例如脚本、图像、样式表）。

links 列表中列出的资源 MUST NOT 列在默认阅读顺序或资源列表中。

用户代理 MAY 忽略链接资源，并且不要求将它们与出版物一起离线。这些资源 SHOULD NOT 在打包出版物时包含。

4.7.3 可扩展性

清单旨在为用户代理在呈现和渲染数字出版物时使用提供一组基本属性，但 MAY 通过以下方式扩展：

通过提供链接元数据记录；或
通过在清单中包含附加属性。

本规范未定义此类附加属性如何由用户代理编译、存储或公开在其清单的内部表示中。用户代理 MAY 忽略部分或全部扩展属性。

4.7.3.1 链接记录

清单 MAY 通过指向元数据记录的链接进行扩展，例如 ONIX [onix] 或 BibTeX [bibtex]，使用 LinkedResource 对象，其中：

LinkedResource 的 rel 属性包含相关标识符（例如，如果链接记录包含描述性元数据，则可使用 describedby 标识符 [iana-link-relations]）；
encodingFormat 的值标识为该特定记录类型定义的 MIME 媒体类型 [rfc2046]，如适用。

当链接记录属于出版物的一部分时（即，它们不仅仅用于清单可扩展性），会包含在资源列表中。否则，它们会包含在链接列表中。

示例 33 ：链接到外部 ONIX for Books 元数据记录。

{
    …
    "links"  : [
        {
            "type"            : "LinkedResource",
            "url"             : "https://www.publisher.example.org/time-machine/onix.xml",
            "encodingFormat"  : "application/onix+xml",
            "rel"             : "describedby"
        },
        …
    ],
    …
}

编辑者注

application/onix+xml MIME 类型在撰写本文档时尚未由 IANA 注册，示例中包含它仅用于说明目的。

4.7.3.2 附加清单属性

附加属性 MAY 直接包含在清单中，使用 [schema.org] 或 [dcterms] 等公共方案。专有术语 MAY 使用，但 RECOMMENDED 使用紧凑 IRI [json-ld11] 包含此类术语，并将前缀定义为上下文的一部分。

注

正确使用前缀和紧凑 IRI 是使用完整 JSON-LD 处理器处理清单所必需的，但不是本规范定义的处理算法的要求。如果预期进行完整 JSON-LD 处理，则必须单独执行前缀术语的验证。

示例 34 ：使用词汇表前缀声明扩展基本数据集。

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context",
        {
            "language" : "en",
            "ex"       : "https://example.org/vocab"
        }
    ],
    …
    "ex:region" : "North America",
    …
}

Schema.org 上下文文件 [schema.org] 为常用词汇表定义了多个前缀，例如 Dublin Core Terms（dcterms）[dcterms] 和 Element Set（dc） [dc11]、FOAF 词汇表（foaf）[foaf]，以及 Bibliographic Ontology（bibo）[bibo]。来自这些词汇表的属性可以使用，而无需声明其前缀。

示例 35 ：使用 Schema.org 的 “copyrightYear”和“copyrightHolder”术语扩展基本数据。

{
    …
    "copyrightYear"   : "2015",
    "copyrightHolder" : "World Wide Web Consortium",
    …
}

示例 36 ：使用 Dublin Core “subject”术语和 2012 ACM Classification 术语扩展基本数据集。

{
    …
    "dcterms:subject" : ["Web data description languages","Data integration","Data Exchange"],
    …
}

4.8 资源关系

4.8.1 结构性资源

4.8.1.1 封面

封面是用户代理可用于呈现数字出版物的资源（例如，在图书馆或书架中，或在最初加载出版物时）。

封面由 cover 链接关系标识。

指向封面的链接 MUST NOT 在链接列表中指定。

编辑者注

cover 术语目前尚未在 IANA 链接关系中注册，但工作组预计会添加它。

示例 37 ：标识 HTML 封面页。

{
    …
    "resources" : [
        {
            "type"           : "LinkedResource",
            "url"            : "cover.html",
            "encodingFormat" : "text/html",
            "rel"            : "cover"
        },
        …
    ],
    …
}

如果封面是图像（无论是否嵌入在 HTML 资源中），强烈建议遵循成功准则 1.1.1 [wcag21]，提供替代文本和扩展描述。对于无法嵌入此信息的图像格式，可使用name 和 description 属性（属于 LinkedResource）分别提供替代文本和扩展描述。在这些情况下，name 属性 SHOULD 始终设置——对于装饰性图像，该属性可以留空。

示例 38 ：标识封面图像。替代文本和描述分别在 name 和 description 属性中提供。

{
    …
    "resources" : [
        {
            "type"           : "LinkedResource",
            "url"            : "whale-image.jpg",
            "encodingFormat" : "image/jpeg",
            "rel"            : "cover",
            "name"           : "Moby Dick attacking hunters",
            "description"    : "A white whale is seen surfacing from the water to attack a small whaling boat"
        },
        …
    ],
    …
}

示例 39 ：装饰性封面。name 属性留空。

{
    …
    "resources" : [
        {
            "type"           : "LinkedResource",
            "url"            : "cover.jpg",
            "encodingFormat" : "image/jpeg",
            "rel"            : "cover",
            "name"           : "",
        },
        …
    ],
    …
}

如果用户代理需要封面图像的替代文本以使界面无障碍，而 name 属性未指定，则它 MAY 尝试从出版物元数据构造替代文本。本规范不强制规定如何创建此类替代文本。一种方法是将替代文本构造为一个字符串，标识该图像为封面，后跟出版物标题。

只有一个资源 MAY 被标识为封面，但附加封面 MAY 使用alternate 属性指定（例如，用于提供替代尺寸或分辨率）。

示例 40 ：以 JPEG 和 SVG 格式提供封面图像。

{
    …
    "resources" : [
        {
            "type"           : "LinkedResource",
            "url"            : "lilliput.jpg",
            "encodingFormat" : "image/jpeg",
            "rel"            : "cover"
            "alternate"      : [
                 {
                     "type"           : "LinkedResource",
                     "url"            : "lilliput.svg",
                     "encodingFormat" : "image/svg+xml",
                     "rel"            : "cover"
                 }
            ]
        },
        …
    ],
    …
}

4.8.1.2 页列表

页列表是一种导航辅助工具，包含数字出版物内静态页面分界点的列表。

页列表由 pagelist 链接关系标识。

编辑者注

pagelist 术语目前尚未在 IANA 链接关系中注册，但工作组预计会添加它。

只有一个资源 MAY 被标识为包含页列表。如果指定了多个实例，用户代理 MUST 使用遇到的第一个实例，并优先考虑阅读顺序中的实例。

指向页列表的链接 MUST NOT 在链接列表中指定。

示例 41 ：标识包含页列表的资源。

{
    …
    "resources" : [
        {
            "type" : "LinkedResource",
            "url"  : "toc_file.html",
            "rel"  : "pagelist"
        },
        …
    ],
    …
}

4.8.1.3 目录

目录是一种导航辅助工具，提供指向数字出版物主要结构章节的链接。

包含目录的资源由 contents 链接关系标识 [iana-link-relations]。目录本身是该资源中第一个 role 值为 doc-toc 的元素，如 § C.2 HTML 结构中所定义。

只有一个资源 MAY 被标识为包含目录。如果指定了多个实例，用户代理 MUST 使用遇到的第一个实例，并优先考虑阅读顺序中的资源。

本规范的配置文件 MAY 定义当没有资源由 contents 关系标识时，如何定位包含目录的资源。

指向目录的链接 MUST NOT 在链接列表中指定。

目录的 RECOMMENDED 结构和处理模型定义于 § C. 机器可处理的目录。

示例 42 ：标识包含目录的资源。

{
    …
    "resources" : [
        {
            "type" : "LinkedResource",
            "url"  : "toc_file.html",
            "rel"  : "contents"
        },
        …
    ],
    …
}

4.8.2 信息性资源

4.8.2.1 无障碍报告

无障碍报告提供关于数字出版物是否适合具有不同首选阅读方式的用户使用的信息。这些报告通常标识针对既定无障碍标准的评估结果，例如 [wcag21] 中提供的标准，并且是确定出版物可用性的重要信息来源。

无障碍报告使用 accessibility-report 链接关系标识。

编辑者注

accessibility-report 术语目前尚未在 IANA 链接关系中注册，但工作组预计会添加它。

将报告作为出版物的资源包含会很有帮助，这样它就可用，例如，在离线阅读出版物时。

注

以人类可读格式（例如 HTML [html]）提供无障碍报告，有助于确保它可被用户访问和理解。使用机器可处理的元数据（例如 Schema.org [schema.org] 中提供的元数据）扩充报告，还将有助于机器处理。

示例 43 ：设置指向无障碍报告的链接。

{
    …
    "resources" : [
        …
        {
            "type" : "LinkedResource",
            "url"  : "https://www.publisher.example.org/sherlock-holmes-accessibility.html",
            "rel"  : "accessibility-report"
        },
        …
    ],
    …
}

4.8.2.2 预览

并非所有数字出版物都会向所有用户开放（例如，它们可能仅限于网站的注册用户）。在这种情况下，出版者可能希望提供内容预览，以吸引用户访问完整版本。

预览使用 preview 链接关系标识 [iana-link-relations]。

预览 MAY 位于外部，也可以作为数字出版物的资源包含。

示例 44 ：将预览标识为数字出版物的音频资源。

{
    …
    "links" : [
        {
            "type"           : "LinkedResource",
            "url"            : "preview.mp3",
            "encodingFormat" : "audio/mpeg",
            "rel"            : "preview"
        },
        …
    ],
    …
}

示例 45 ：通过外部链接标识预览。

{
    …
    "links" : [
        {
            "type"           : "LinkedResource",
            "url"            : "https://publisher.example.org/jekyll-hyde-preview.html",
            "encodingFormat" : "text/html",
            "rel"            : "preview"
        },
    	…
    ],
    …
}

4.8.2.3 隐私政策

用户通常有法定权利知道并控制收集了哪些关于他们的信息、这些信息如何存储以及存储多久、它是否可用于个人识别，以及如何将其删除。因此，包含一份处理此类隐私关切的声明，是发布数字出版物的重要组成部分。即使没有收集任何信息，此类声明也会提高用户对内容的信任。

可以为此目的在清单中包含指向隐私政策的链接。将隐私政策作为出版物的资源包含会很有帮助，这样它就可用，例如，在离线阅读出版物时。

隐私政策使用 privacy-policy 链接关系标识 [iana-link-relations]。

示例 46 ：通过外部链接标识隐私政策。

{
    …
    "resources"  : [
        …
        {
            "type"           : "LinkedResource",
            "url"            : "https://www.w3.org/Consortium/Legal/privacy-statement-20140324",
            "encodingFormat" : "text/html",
            "rel"            : "privacy-policy"
        },
        …
    ],
    …
}

4.8.3 扩展

如果需要表达本规范定义之外的其他关系，rel 属性可以通过以下方式之一扩展：

使用关系词汇表中定义的关系（例如 IANA 链接注册表 [iana-link-relations] 和 microformats 现有 rel 值 [mfrel]）；或
使用扩展关系类型 [rfc8288]。

7. 处理清单

本节依赖于 Infra 标准 [infra]。

7.1 引言

本节为非规范性内容。

虽然数字出版物的清单以 [json-ld11] 创作，但本节描述的清单处理步骤详细说明了用户代理如何将清单转换为其数据的内部表示。该算法使用 [infra] 中定义的术语和数据类型描述该过程，并且如果成功，会返回一个 [infra] 映射形式的数据。

注

此算法的实际实现会使用所用语言中相应的构造和数据类型。

7.2 错误处理

处理算法中使用以下错误类型：

验证错误 — 一种非终止性错误，发生在键的值与其预期输入不匹配时。
致命错误 — 一种终止性错误，例如，当清单无法处理或不满足关键有效性约束时产生。

用户代理 SHOULD 暴露验证错误和致命错误，但本规范不规定这样做的方式。

对于验证错误，用户代理 SHOULD 区分错误的严重程度（即，违反的是必需实践还是推荐实践）。

7.3 处理上下文

处理算法中的某些步骤取决于术语的预期值类别，因此术语使用的上下文可能会影响处理（例如，只有当 url 是出版物清单的直接属性时，它才期望为数组形式的 URL）。为区分这些用法，会向某些函数调用提供一个上下文。该上下文设置为发起处理调用的对象类型。

识别类型的默认列表包括 Person、Organization 和 LinkedResource。配置文件 MAY 扩展此列表，以包含额外的对象类型。

如果没有向函数提供上下文，则正在处理的术语被认为属于全局上下文（即，它是清单的直接子项）。

注

扩展识别类型列表时，可能还需要扩展规范化数据函数，以确保所有对象都指定了其类型（例如，当字符串值自动扩展为对象时）。

7.4 生成内部表示

此算法接受以下参数：

text：表示清单的 UTF-8 字符串。
base：表示清单基 URL 的 URL 字符串。
document：在可用时，指HTML Document (DOM) Node [html]，即引用清单的文档。

注

此算法不描述如何发现和获取清单。执行这些操作的步骤由每种数字出版物格式定义。

要生成内部表示，运行以下步骤：

令 processed 为一个空映射，它将包含清单的内部表示。
令 manifest 为给定 text 后解析JSON 为 Infra 值的结果。如果 manifest 不是映射，则为致命错误，返回失败。

说明

出版物清单必须表达为 JSON 对象，而不是数组。将清单转换为 [infra] 类型之后，还会额外检查所得结构是否为映射。
（§ 4.3 清单上下文）如果 manifest["@context"] 未设置为列表，或者 manifest["@context"] 中的第一个和第二个项目不是字符串值 “https://schema.org”和“https://www.w3.org/ns/pub-context”，且按此顺序排列，则为致命错误，返回失败。

说明

如果上下文 URL 未按预期设置，则 JSON 数据不表示出版物清单。
（§ 4.6 配置文件一致性）令 processed["profile"] 为清单所符合的配置文件。按如下方式设置 processed["profile"]：
1. 如果 manifest["conformsTo"] 未设置，或未包含用户代理识别为能够处理和/或渲染的配置文件，则用户代理 SHOULD 检查阅读顺序中资源的媒体类型，以确定该出版物是否匹配其能够处理或渲染的配置文件。如果匹配，则为验证错误，将 processed["profile"] 设置为匹配的配置文件。否则，为致命错误，返回失败。
2. 否则，将 processed["profile"] 设置为 manifest["conformsTo"] 中用户代理能够处理和/或渲染的第一个 URL。
注

在处理过程的此步骤中，manifest["conformsTo"] 的值可能是字符串，也可能是列表。

说明

出版物所符合的配置文件决定在处理期间必须执行的任何附加扩展步骤。这些步骤由其各自的规范定义。

创建新术语 profile 是因为 conformsTo 不限于配置文件标识符（即，新术语在内部表示中提供配置文件的持久标识符）。
（§ 4.4.1 全局声明）令 lang 为全局语言， dir 为从此步骤获得的全局方向。最初将每个都设置为空字符串。

对于 manifest["@context"] 中的每个 context，从最后一个项目移动到第一个项目，如果 context 是映射：
1. 如果 lang 是空字符串且 context["language"] 已定义，则将 lang 设置为 context["language"]；
2. 如果 dir 是空字符串且 context["direction"] 已定义，则将 dir 设置为 context["direction"]；
3. 如果 lang 和 dir 都不是空字符串，则中断。
如果 lang 既不是空字符串也不是格式良好的 [bcp47] 语言标签，则为验证错误，将 lang 设置为空字符串。

如果 dir 既不是空字符串也不是“ltr”或“rtl”中的一个值，则为验证错误，将 dir 设置为空字符串。

说明

此处获得的全局语言和方向声明分别用于为没有声明的可本地化字符串设置语言和基本方向。

迭代器会反向遍历 @context，因为最后的语言和方向声明会覆盖任何较早的声明。
（§ 4.3 清单上下文）如果配置文件要求对清单上下文进行附加验证，则这些步骤在此处执行。

说明

此扩展步骤允许验证配置文件要求存在于清单上下文中的任何信息（例如，附加上下文 URL 或参数）。这些步骤必须在此时执行，因为 @context 术语会在下一步的数据规范化中被移除。用于处理配置文件数据的更通用步骤在后续步骤中提供。
对于 manifest 中的每个 term → value，当调用规范化数据并给定 term、value、lang、dir 和 base 成功时，将 processed[term] 设置为其结果。如果返回失败，则不要将 term 添加到 processed。

说明

数据规范化步骤会标准化传入的清单数据，以移除任何创作便利写法，例如在预期对象或数组时使用字符串的能力。所得的已处理数据会添加到 processed 变量中，并在后续步骤中对其进行操作。
将 processed 设置为在给定 processed 时运行数据验证的结果。

说明

数据验证检查会确保传入数据匹配其预期值类别。对预期值的任何限制也会在此步骤强制执行，并且任何无效数据都会从最终表示中移除。
如果配置文件指定了需要运行的附加处理函数，则这些步骤在此时执行。
在给定 processed 以及指定时的 document 后，当运行添加默认值成功时，将 processed 设置为其结果。否则，终止处理，返回失败。

说明

此步骤检查清单中缺失的任何信息是否可以从链接到该文档的 HTML 文档或其他来源获得。
返回 processed。

注

有关所得结构的可视化，请参阅 § A. 内部表示数据模型。

7.4.1 规范化数据

要为属性 term 的 value规范化数据，并带有全局语言 lang、全局方向 dir、基 URL base，以及可选上下文 context，运行以下步骤：

令 normalized 为 value 的值。

说明

数据规范化步骤在此步骤定义的 normalized 变量中保存的传入值副本上执行。此变量会在成功规范化过程结束时返回。
（§ 4.3 清单上下文）如果 term 是 @context，则返回失败。

说明

@context 为清单的初始处理提供信息，但不会保留在内部数据表示中。返回失败表示移除该术语。
（§ 4.2.7 数组）如果根据 context，term 预期为数组，且 value 不是列表，则将 normalized 设置为列表： « value »。
说明

各种术语要求其值为数组，但为了方便，作者允许使用单个值而不是单元素数组。例如，
示例 51
```
{
    …
    "name"   : "Et dukkehjem",
    "author" : "Henrik Ibsen",
    …
}
```
得到：
示例 52
```
«[
    …
    "name"   → « "Et dukkehjem" »,
    "author" → « "Henrik Ibsen" »,
    …
]»
```
（§ 4.2.4.2 实体）如果根据 context，term 预期为数组形式的实体，则对于 normalized 中的每个 entity：
1. 如果 entity 是字符串，则将 entity 设置为映射：
```
«[
    "type" → « "Person" »,
    "name" → entity
]»
```
2. 否则，如果 entity 不是映射，则为验证错误，从 normalized 中移除 entity。
3. 否则，如果 entity["type"] 未设置，则将其设置为列表： « "Person" »。如果 entity["type"] 已设置但不包含值 Person 或 Organization，则将值 Person 追加到该列表。
说明

创建者（作者、编辑等）预期显式定义为对象，但为了方便，清单中只需指定其名称。例如：
示例 53
```
{
    …
    "author": "Ralph Ellison",
    …
}
```
此规则会将此类字符串值转换为默认类型为 Person 的映射，对前述示例产生如下结果：
示例 54
```
«[
    …
    "author" → « 
        «[
            "type" → « "Person" »
            "name" → "Ralph Ellison"
        ]»
    »,
    …
]»
```
为简单起见，将 name 转换为可本地化字符串的过程由后续步骤描述。

（§ 4.2.4.1 可本地化字符串）如果根据 context，term 预期为数组形式的可本地化字符串，则对于 normalized 中的每个 item：

如果 item 是字符串，则将 item 设置为映射：
```
«[
    "value" → item,
    "language" → lang,
    "direction" → dir
]»
```
如果 lang 或 dir 未设置，或为空字符串，则分别移除 item["language"] 或 item["direction"]。
否则，如果 item 不是映射，则为验证错误，从 normalized 中移除 item。
否则，按如下方式处理 item 中的映射：
1. 如果 item["language"] 未设置，则当 lang 已设置且不是空字符串时，将其设置为 lang 的值。
  
  否则，如果 item["language"] 为null，则移除 item["language"]。
2. 如果 item["direction"] 未设置，则当 dir 已设置且不是空字符串时，将其设置为 dir 的值。
  
  否则，如果 item["direction"] 为null，则移除 item["direction"]。

说明

自然语言文本值预期显式定义为可本地化字符串对象，但为了方便，在清单中可以是简单字符串。例如，如果没有通过全局语言声明提供语言信息，则：

示例 55

{
    "@context" : ["https://schema.org", "https://www.w3.org/ns/pub-context"],
    "name"     : ["La Comédie humaine"],
    …
}

得到：

示例 56

«[
    "name"     → «
        «[
            "value" → "La Comédie humaine"
        ]»
    »,
    …
]»

但是，如果清单中提供了显式语言，则该语言会添加到可本地化字符串对象。例如，

示例 57

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context",
        {"language": "fr"}
    ],
    "name"     : ["La Comédie humaine"],
    …
}

得到：

示例 58

{
    "name"     → «
        «[
            "value"    → "La Comédie humaine"
            "language" → "fr"
        ]»
    »,
    …
}

局部设置或局部 null 值会阻止全局值生效。

示例 59

{
    "@context" : [
        "https://schema.org",
        "https://www.w3.org/ns/pub-context", 
        {"language":"fr"}
    ],
    …
    "name" : [{
        "value" : "La Comédie humaine"
    }],
    "publisher" : [{
        "type":["Organization"],
        "name":[{
            "value": "Hachette",
            "language": null
        }]
    }],
    …
}

得到：

示例 60

{
    "name"     → «
        «[
            "value"    → "La Comédie humaine"
            "language" → "fr"
        ]»
    »,
    "publisher"    → «
        «[
            "type" → « "Organization" »,
            "name" → «
                «[
                    "value" → "Hachette",
                ]»
        ]»
    »,
    …
}

（§ 4.2.4.3 链接资源）如果根据 context，term 预期为数组形式的LinkedResources，则对于 normalized 中的每个 resource：
1. 如果 resource 是字符串，则将 resource 转换为映射：
```
«[
    "type" → « "LinkedResource" »,
    "url" → resource
]»
```
2. 否则，如果 resource 不是映射，则为验证错误，从 normalized 中移除 resource。
3. 否则，如果 resource["type"] 未设置，则将其设置为列表： « "LinkedResource" »。如果 resource["type"] 已设置但不包含值 LinkedResource，则将该值追加到列表。
说明

资源链接预期显式设计为类型为 LinkedResource 的对象，但为了方便，只需在清单中指定其绝对或相对 URL。例如，
示例 61
```
{
    …
    "resources" : [
        "css/book.css",
        …
    ],
    …
}
```
此步骤会将字符串值转换为对象，对前述示例产生如下结果：
示例 62
```
«[
    …
    "resources" → «
        «[
            "type" → « "LinkedResource" »,
            "url"  → "css/book.css"
        ]»,
        …
    »,
    …
]»
```
为简单起见，将相对路径转换为绝对路径的过程由后续步骤描述。
（§ 4.2.5 URL）如果根据 context，term 预期为 URL 或数组形式的 URL：
1. 如果 normalized 是字符串，则在给定 normalized 后，当运行转换为绝对 URL成功时，将 normalized 设置为其结果。如果返回失败，则返回失败。
2. 否则，如果 normalized 是列表，则对于 normalized 中的每个 item，在给定 normalized 后，当运行转换为绝对 URL成功时，将 item 设置为其结果。如果返回失败，则从 normalized 中移除 item。
3. 否则，为验证错误，返回失败。
说明

清单中的相对 URL 会根据基值解析，以获得绝对 URL。例如：
```
"url": "chapter01.html"
```
对于托管在 https://example.org/publications/wuthering-heights 的出版物，将得到：
```
"url" → "https://example.org/publications/wuthering-heights/chater01.html"
```
（§ 8. 模块化扩展，扩展点）如果配置文件为配置文件特定术语定义了处理步骤，则这些步骤在此时执行。
按如下方式递归检查 normalized，以确保所有属性都得到规范化：
1. 如果 normalized 是列表，则对于 normalized 中每个作为映射的 item：
  1. 如果 item["type"] 已设置并包含识别类型，则对于 item 中的每个 key → keyValue，在给定 key、keyValue、lang、 dir、base 并使用 item["type"] 作为上下文时，当运行规范化数据成功时，将 key 设置为其结果。如果返回失败，则从 item 中移除 key。
  2. 否则，不执行任何操作。
2. 否则，如果 normalized 是映射：
  1. 如果 normalized["type"] 已设置并包含识别类型，则对于 normalized 中的每个 key → keyValue，在给定 key、keyValue、lang、 dir、base 并使用 normalized["type"] 作为上下文时，当运行规范化数据成功时，将 key 设置为其结果。如果返回失败，则从 normalized 中移除 key。
  2. 否则，不执行任何操作。
3. 否则，不执行任何操作。
说明

为了确保清单中的所有属性都得到处理，此步骤递归检查 normalized，查找需要处理的附加映射条目。如果 normalized 是列表，则检查每个项目以确定它是否为可处理的映射。

如果返回失败，则从映射中移除该项目。
返回 normalized。

7.4.1.1 转换为绝对 URL

要将 url转换为绝对 URL，并带有基 URL base，运行以下步骤：

如果 url 或 base 不是字符串，或是空字符串，则为验证错误，返回失败。

说明

此步骤检查 url 和 base 在尝试使用前都是非空字符串。
当以 url 作为输入、base 作为基 URL 运行URL 解析器 [url] 成功时，将 url 设置为其结果。如果返回失败，则为验证错误，返回失败。

说明

此步骤对要处理的 url 调用 URL 解析器函数。如果该 url 不是绝对 URL，解析器会使用基 URL 将其转换为绝对 URL。

如果解析返回失败，则向调用者返回失败，以指示移除该 URL。
返回 url。

7.4.2 数据验证

要对映射 data 执行数据验证，运行以下步骤：

对于 data 中的每个 term → value，在给定 term 和 value 时，当运行全局数据检查成功时，将 term 设置为其结果。如果返回失败，则移除 data[term]。

说明

此步骤将每个条目传递给一组需要在值上运行的全局验证检查，并递归地在值内的任何属性上运行这些检查。

如果属性无效且必须移除，则返回失败。
如果配置文件指定了数据验证检查，则这些步骤在此时执行。

说明

配置文件验证步骤优先于默认步骤，因此如果配置文件例如有不同的默认值要应用，这些值会被应用。
（§ 4.5 出版物类型）如果 data["type"] 未设置或是空列表，则为验证错误，设置为 « "CreativeWork" »。
（§ 4.7.1.2 无障碍）如果 data["accessModeSufficient"] 已设置，则对于 data["accessModeSufficient"] 中的每个 item，如果 item["type"] 未设置或不包含 “ItemList”，则从 data["accessModeSufficient"] 中移除 item。
（§ 4.7.1.4 规范标识符）如果 data["id"] 未设置或是空字符串，则为验证错误。
（§ 4.7.1.6 时长）如果 data["duration"] 已设置且不是有效的时长值，按 [iso8601-1]，则为验证错误，移除 data["duration"]。
（§ 4.7.1.7 最后修改日期）如果 data["dateModified"] 已设置且按 [iso8601-1] 不是有效的日期或日期时间，则为验证错误，移除 data["dateModified"]。
（§ 4.7.1.8 发布日期）如果 data["datePublished"] 已设置且按 [iso8601-1] 不是有效的日期或日期时间，则为验证错误，移除 data["datePublished"]。
（§ 4.7.1.9 出版物语言）如果 data["inLanguage"] 已设置，则对于 data["inLanguage"] 中的每个 item，如果 item 不是格式良好的 [bcp47]，则为验证错误，从 data["inLanguage"] 中移除 item。
（§ 4.7.1.10 阅读推进方向）如果 data["readingProgression"] 未设置，则设置为“ltr”。否则，如果它不是必需的方向值之一，则为验证错误，设置为“ltr”。
（§ 5. 出版物资源）按如下方式获取并验证出版物边界内的唯一 URL：
1. 如果 readingOrder 已设置，则令 readingOrderURLs 为在给定 readingOrder 后运行获取唯一 URL的结果。否则，令 readingOrderURLs 为空有序集。
2. 如果 resources 已设置，则令 resourcesURLs 为在给定 resources 后运行获取唯一 URL的结果。否则，令 resourcesURLs 为空有序集。
3. 将 data['uniqueResources'] 设置为 readingOrderURLs 和 resourceURLs 的并集。
说明

此步骤获取阅读顺序和资源列表中的唯一 URL 列表。然后它将 data['uniqueResources'] 设置为这两个集合的并集，表示出版物边界内唯一资源的完整列表。

如果 readingOrder 或 resources 包含重复资源声明，此步骤也会发出警告。验证错误会作为从每个列表中获取唯一 URL 的一部分发出。
（§ 4.7.2.3 链接）如果 data["links"] 已设置，则对于 data["links"] 中的每个 link：
1. 令 url 为在 link["url"] 上运行URL 序列化器 [url]，并设置 exclude fragment flag 后所得的结果。
2. 如果 data["uniqueResources"] 包含 url，则为验证错误，从 data["links"] 中移除 link，然后继续。
3. 如果 link["rel"] 未设置或是空列表，则为验证错误，然后继续。
4. 如果 link["rel"] 包含以下任一 ASCII 大小写不敏感值：“contents”、“pagelist”或 “cover”，则为验证错误，从 data["links"] 中移除 link。
说明

在前一步获得唯一出版物资源列表之后，会检查 links 属性，以确保任何链接资源不会也被列为出版物资源。

如果链接未指定 rel 值，则发出警告。如果其 rel 属性指定结构性资源，则移除该链接，因为结构性资源必须位于出版物边界内。
（§ 4.8.1 结构性资源）按如下方式验证结构性关系的使用：
1. 将 resources 设置为 data["readingOrder"] 的值（如果已定义），否则设置为空列表。当 data["resources"] 已定义时，使用其扩展 resources。
2. 如果 resources 中有多个项目的 rel 条目包含 ASCII 大小写不敏感值“contents”，则为验证错误。
3. 如果 resources 中有多个项目的 rel 条目包含 ASCII 大小写不敏感值“pagelist”，则为验证错误。
4. 如果 resources 中有多个项目的 rel 条目包含 ASCII 大小写不敏感值“cover”，则为验证错误。
  
  如果封面具有指定图像媒体类型（image/*）的 encodingFormat 条目，且没有 name 条目，则为验证错误。
说明

此步骤检查阅读顺序和资源列表中指定的资源，以验证仅指定了一个目录、页列表和封面实例。

对于封面，它还会检查基于图像的格式是否已设置名称，以满足无障碍目的。
对于 data 中的每个 term → value，如果在给定变量 term 和 value 后运行移除空数组返回失败，则移除 data["term"]。

说明

由于清单处理会在各个阶段移除无效值，最终数据结构可能会出现一些不再包含任何值的列表。此步骤会重新遍历数据并移除任何此类空列表。
返回 data。

7.4.2.1 全局数据检查

要对属性 term 的 value 处理全局数据检查，并带有可选上下文 context，运行以下步骤：

（§ 4.2 值类别）如果 term 具有已知值类别，则在给定变量 term、 value 和 context 后，当调用验证值类别成功时，将 value 设置为其结果。如果返回失败，则返回失败。

否则，返回 value。

说明

此步骤验证术语的值是否匹配该术语所需的预期类别。例如，abridged 术语要求布尔值，因此与该术语一起使用的任何其他值都会导致失败。

如果调用该函数时发生失败，此步骤也会返回失败，以便从最终数据集中移除该属性。

没有已知值类别的术语不会被处理，因此会返回传入值。
按如下方式递归下降到 value 中，以先检查任何子属性：
1. 如果 value 是映射：
  1. 如果 value["type"] 包含识别类型，则对于 value 中的每个 key → keyValue，在给定 key、 keyValue 并使用 value["type"] 作为上下文时，当运行全局数据检查成功时，将 value[key] 设置为其结果。如果返回失败，则移除 value[key]。
  2. 否则，不执行任何操作。
2. 否则，如果 value 是列表，则对于 value 中的每个 item，如果 item 是映射：
  1. 如果 item["type"] 包含识别类型，则对于 item 中的每个 key → keyValue，在给定 key、 keyValue 并使用 item["type"] 作为上下文时，当运行全局数据检查成功时，将 item[key] 设置为其结果。如果返回失败，则移除 item[key]。
  2. 否则，不执行任何操作。
3. 否则，不执行任何操作。
说明

为了确保清单中的所有属性都得到处理，此步骤递归检查每个条目，查找需要处理的附加映射条目。如果值是列表，则检查每个项目以确定它是否为可处理的映射。

其位置还确保所有子属性首先被检查，因此步骤后面的较高级别检查会在任何无效值被移除后进行测试。
（§ 4.4.1 全局声明和 § 4.4.2 特定项目声明）如果 term 预期为数组形式的LocalizableStrings，则对于 value 中的每个 item：
- 如果 item["value"] 未设置，则从 value 中移除 item。
- 如果 item["language"] 已设置且其值不是格式良好的 [bcp47]，则为验证错误，移除 item["language"]。
- 如果 item["direction"] 已设置且其值不是 “ltr”或“rtl”之一，则为验证错误，移除 item["direction"]。
说明

此步骤检查可本地化字符串是否具有值、其语言声明是否格式良好，以及其方向声明是否具有 “ltr”或“rtl”的值。
（§ 4.2.4.2 实体）如果 term 预期为数组形式的实体，则对于 value 中的每个 item，检查 item["name"] 是否已设置：
- 如果没有，则为验证错误，从 value 中移除 item。
- 如果已设置，则对于 item["name"] 中的每个 name，如果 name["value"] 未设置或为空字符串，则从 item["name"] 中移除 name。
说明

此步骤确保所有实体都有名称。没有名称的实体会被移除。
（§ 4.2.4.3 链接资源）如果 term 预期为数组形式的LinkedResources，则对于 value 中的每个 resource：
- 如果 resource["url"] 未设置，或其值为空字符串，则为验证错误，从 value 中移除 resource，然后继续。
  
  否则，如果 resource["url"] 不是有效 URL [url]，则为验证错误，从 value 中移除 resource，然后继续。
- 如果resource["duration"] 已设置且不是有效的时长值，按 [iso8601-1]，则为验证错误，移除 resource["duration"]。
说明

此步骤对 LinkedResource 的术语执行以下两项检查：
1. 如果未指定 URL 或 URL 无效，则移除 LinkedResource。
2. 如果指定了资源的时长，且不是 ISO 8601 时长值，则移除 duration 属性。
返回 value。

7.4.2.2 验证值类别

要为属性 term 的 value验证值类别，并带有上下文 context，运行以下步骤：

如果根据 context，term 预期为数组：
1. 如果 value 不是列表，则为验证错误，返回失败。
2. 否则，对于 value 中的每个 item：
  1. 如果 item 不匹配数组的预期值类别，则为验证错误，从 value 中移除 item，然后继续。
  2. 如果 item 是映射，则对于 item 中的每个 key → keyValue，如果 key 具有预期值类别，则在给定 key、 keyValue 并使用 item["type"] 作为上下文时，将 key 设置为运行验证值类别的结果。如果处理 item 的结果是空映射，则为验证错误，从 value 中移除 item。
  如果处理 value 的结果是空数组，则为验证错误，返回失败。
否则，如果根据 context，term 预期为映射：
1. 如果 value 不是映射，则为验证错误，返回失败。
2. 否则，对于 value 中的每个 key → keyValue，如果 key 具有预期值类别，则在给定 key、keyValue 并使用 value["type"] 作为上下文时，将 key 设置为运行验证值类别的结果。如果处理 value 的结果是空映射，则为验证错误，返回失败。
注

此步骤目前仅供配置文件使用。本规范中定义的属性均接受数组形式的对象。
否则，如果根据 context，value 不匹配 term 的预期值类别，则为验证错误，返回失败。
返回 value。

说明

此函数检查正在处理的术语的值是否匹配其预期值类别。当值是列表或映射时，会递归调用该函数，以确保清单中的所有属性都得到检查。

7.4.2.3 获取唯一 URL

要从 resources 中获取唯一 URL，运行以下步骤：

令 uniqueURLs 为空有序集。
对于 resources 中的每个 resource：
1. 令 url 为在 resource["url"] 上运行URL 序列化器 [url]，并设置 exclude fragment flag 后所得的结果。
2. 如果 uniqueURLs 包含 url，则为验证错误。否则，将 url追加到 uniqueURLs。
3. 如果 resource["alternate"] 已设置，则对于 resource["alternate"] 中的每个 alternate：
  1. 令 alt_url 为在 alternate["url"] 上运行URL 序列化器 [url]，并设置 exclude fragment flag 后所得的结果。
  2. 如果 uniqueURLs 包含 alt_url，则为验证错误。
  3. 否则，将 alt_url追加到 uniqueURLs。
返回 uniqueURLs。

说明

此函数接受LinkedResource 对象列表 ——来自阅读顺序或资源列表——并返回唯一 URL 集合。如果遇到重复项，则发出警告。

7.4.2.4 移除空数组

要从属性 term 的 value 中移除空数组，运行以下步骤：

如果 value 是空列表，返回失败。
否则，如果 value 是映射，则对于 value 中的每个 key → keyValue，如果在给定 key 和 keyValue 后运行移除空数组返回失败，则移除 value[key]。

说明

此函数检查正在处理的术语的值不是空列表。最初具有列表的术语可能会随着处理而丢失条目（即，当列表项目无效时）。

7.4.3 添加默认值

要为映射 data 中缺失的属性添加默认值，并带有可选HTML Document (DOM) Node [html] document，运行以下步骤：

（§ 4.7.1.11 标题）如果 data["name"] 未设置：
- 令 title 为空映射。按如下方式设置其值：
  - 如果 document 已设置，且 document 的title 元素 [html] 已设置且不为空，则将 title["value"] 设置为 title 元素的文本内容。
    
    如果可用，则将 title["language"] 设置为语言 [html]；如果该值可用且其值为 “ltr”或“rtl”，则将 title["direction"] 设置为基本方向 [html]。
  - 否则，为验证错误，为 title["value"] 生成一个值（见单独注释了解详情）。根据生成的标题适当地设置 title["language"] 和 title["direction"]。
- 将 data["name"] 设置为列表： « title »。
说明

当清单中未指定 name 属性时，此步骤添加 document 的 title 元素内容。例如：
示例 63
```
<html>
<head lang="en">
    <title>The Golden Bough</title>
    …
    <script type="application/ld+json">
    {
        "@context" : ["https://schema.org","https://www.w3.org/ns/pub-context"],
        …
    }
    </script>
```
得到：
示例 64
```
«[
    …
    "name" → «
        «[
            "value"    → "The Golden Bough",
            "language" → "en"
        ]»
    »,
    …
]»
```
（§ 4.7.2.1 默认阅读顺序和 § 6.1 链接）如果 data["readingOrder"] 未设置：
- 如果 document 或document.URL 未设置，则为致命错误，返回失败。
- 将 data["readingOrder"] 设置为空列表，并追加映射 «[ "url" → document.URL ]»。
- 将 document.URL 追加到 data["uniqueResources"]。
说明

如果数字出版物仅由引用文档组成，则默认阅读顺序可以省略；它会自动由该单个资源组成。
如果配置文件指定了用户代理必须生成的默认值，则这些步骤在此时执行。
（§ 6.1 链接）如果document.URL 已设置，且 data["uniqueResources"] 不包含 document.URL，则为验证错误。

说明

如果链接到清单的页面在处理核心和扩展默认值规则后未列为出版物的唯一资源，则会引发错误，因为它必须是出版物资源。
返回 data。

C. 机器可处理的目录

C.1 引言

本节为非规范性内容。

为了促进页面内和站点间的导航，HTML 使用nav 元素 [html] 表达链接列表。虽然默认情况下性质上是通用的，但 nav 元素的用途可以通过使用 role 属性 [html] 更具体地标识。特别是， [dpub-aria-1.0] 词汇表中的 doc-toc 角色将 nav 元素标识为数字出版物的目录。

包含可识别的目录是生成任何数字出版物的一种无障碍方式，但由于 HTML 标记的灵活性，它也会给试图提取有意义链接层级的用户代理带来挑战（例如，提供可从任意页面访问的自定义视图）。为避免为不同用途重复目录，本节定义了一种既对人友好且常用、又仍然为用户代理提取提供足够结构的语法。

作者可以选择列表（有序或无序）来构造其目录。通过在这些列表中使用锚标记（a 元素）标记每个链接，用户代理可以轻松区分它们需要的信息与也已添加的任何外围内容（旁注）或样式性标记。目录可以同时包含活动链接（带有 href 属性）和非活动链接（不包含 href 属性），从而为目录的构造方式提供额外灵活性（例如，在预览中省略指向某些标题的链接，或仅链接到某些内容）。

不过，请注意，不要求用户代理保留目录的呈现方面（即，用户代理通常是在提取信息，以便以所有出版物通用的方式呈现它）。例如，只期望用户代理保留链接元素的文本内容，因此文本样式、内联图像和其他非文本内容可能会丢失。同样，列表样式甚至显示多少层级的链接也由用户代理自行决定。因此，建议链接到呈现性目录，以免用户只能使用机器处理的目录。

C.2 HTML 结构

目录通过 [html] 元素表达（通常是nav 元素）。此元素 MUST 由 role 属性 [html] 值“doc-toc” [dpub-aria-1.0] 标识，并且 MUST 是文档中按文档树顺序 [dom] 第一个具有该 role 值的元素。该元素 MAY 对用户隐藏。

清单 SHOULD 标识包含目录的资源。

虽然 nav 元素的内容模型不受限制，但只有在遵循以下标记指南时，用户代理才能提取可用的目录：

目录标题

虽然目录标题是可选的，但为了避免在需要标题时由用户代理生成占位标题，建议添加一个标题。标题使用 [html] h1 到 h6 元素中的任意元素指定。请注意，仅第一个此类元素会被识别为标题。如果在链接列表之前未找到标题元素，用户代理将假定未指定标题。

链接列表

在 nav 元素中遇到的第一个 [html] ol 或 ul 列表元素被假定为包含定义指向内容链接的列表。即使该列表嵌套在例如 div 元素中，也会找到它，因为算法会忽略与其处理无关的元素。但是，该列表不能出现在任何跳过的元素中，因为不会评估这些元素的内部内容。

如果 nav 元素不包含这些元素之一，则用户代理不会将该数字出版物登记为包含可用目录（例如，机器渲染的选项将不可用）。

分支

如果将目录视为链接树，则li 元素中位于链接列表内的每个列表项表示一个分支。为了呈现给用户，这些分支都必须有名称和可选目的地，而这些信息从列表项中找到的第一个 a 元素获得，无论其嵌套在何处（同样，排除任何位于跳过的元素中的 a 元素。）

分支的链接目的地在指定时从 a 元素的 href 属性获得。如果链接不可用（例如在预览中）或不相关（例如分组标题），可以省略此属性。在提供指向内容的链接时，还可以指定被链接文档的关系（在 rel 属性中）以及被链接资源的媒体类型（在 type 属性中）。

找到为分支标注标签的 a 元素之后，用户代理将继续检查标记中是否存在另一个列表元素（即子分支）。如果找到列表，则同样处理该列表以提取其链接，如此继续，直到没有更多嵌套分支需要处理。

跳过的元素

解析目录时会忽略一小组元素，以避免误解。这些是 [html] 分节内容元素和分节根元素。它们被忽略的原因是它们可以定义自己的大纲（即，它们可以表示自包含且不一定与内容链接结构相关的嵌入内容）。

任何设置了hidden 属性的元素也会被跳过，因为隐藏元素并不旨在由用户直接访问。

虽然这些元素可以包含在 nav 元素中，但必须小心不要将重要内容嵌入其中（例如，不要用 section 元素包裹包含所有指向内容链接的列表项）。

忽略的元素

所有与提取目录无关且未被跳过的元素都会被忽略。与跳过元素不同，忽略意味着用户代理将继续在它们内部搜索相关内容，从而允许在可使用的标记方面具有更大的灵活性。

C.2.1 示例

本节为非规范性内容。

示例 65 ：基本的多级目录。

请注意，不同级别可以使用不同的列表类型。

<nav role="doc-toc">
   <h2>Contents</h2>

   <ol>
      <li>
        <a href="discourses.html">ZARATHUSTRA'S DISCOURSES.</a>
         <ul>
            <li><a href="discourses.html#s01">THE THREE METAMORPHOSES.</a></li>
            <li><a href="discourses.html#s02">THE ACADEMIC CHAIRS OF VIRTUE.</a></li>
            <li><a href="discourses.html#s03">BACKWORLDSMEN.</a></li>
            …
         </ul>
      </li>
      …
   </ol>
</nav>

示例 66 ：带有被忽略内容的目录。

补充性描述信息会被用户代理忽略。

<nav role="doc-toc">
   <h2>Contents</h2>

   <ol>
      <li>
         <div class="title"><a href="c01.html">CHAPTER I</a></div>
         <div class="description">Biographical and Introductory.</div>
      </li>
      <li>
         <div class="title"><a href="c02.html">CHAPTER II</a></div>
         <div class="description">A New System of Alternating Current Motors and Transformers.</div>
      </li>
      …
   </ol>
</nav>

示例 67 ：用于预览的目录。

链接到用户无权访问的内容的 a 元素不包含 href 属性。

<nav role="doc-toc">
   <h2>Contents</h2>

  <ol>
     <li><a href="xmas_carol.html">Marley's Ghost</a></li>
     <li><a>The First of Three Spirits</a></li>
     <li><a>The Second of Three Spirits</a></li>
     <li><a>The Last of the Spirits</a></li>
     <li><a>The End of It</a></li>
  </ol>

   …
</nav>

示例 68 ：带有未链接标题的目录。

在此示例中，作者姓名不是相关链接位置，因此其包围的 a 元素上不包含 href 属性。

<nav role="doc-toc">
   <h2>Contents</h2>

   <ol>
      <li>
         <a>Faraday, Michael</a>
         <ol>
            <li><a href="faraday.html#s01">Experimental Researches in Electricity</a></li>
            <li><a href="faraday.html#s02">The Chemical History of a Candle</a></li>
         </ol>
      </li>
      <li>
         <a>Forel, Auguste</a>
         <ol>
            <li><a href="forel.html">The Senses of Insects</a></li>
         </ol>
      </li>
      …
   </ol>
</nav>

C.3 用户代理处理

本节依赖于 Infra Standard [infra]。

本节定义了从 nav 元素提取目录的算法。它以按树顺序 [dom] 遍历 DOM 树节点的方式定义，每个节点在遍历期间被进入和退出时都会被访问。每次访问节点时，都可以视为触发了进入或退出事件。在某些步骤中，用户代理可选择如何处理内容，以便为不同呈现模型提供灵活性。

注

此算法不是以纯事件驱动术语定义的，因为并非总是需要检查所有后代节点才能从 DOM 中获得所需信息。在某些情况下，某个元素及其所有后代会在进入时处理后立即被跳过。可以应用事件方法，但这将需要修改算法以处理/忽略被跳过的节点。

注

用户代理可以使用任何能够表示最终数据形式的语言来处理并内部化所得结构。

就此算法而言，列表元素定义为 [html] ol 或 ul 元素。

以下算法 MUST 应用于以文档顺序中第一个 role 属性值为 doc-toc 的元素为根的 DOM 子树遍历，无论该元素是否已被声明式隐藏 [html]，或通过 CSS 样式设置为不可见：

注

定位包含目录元素的资源的规则定义于 § 4.8.1.3 目录。

如果未找到目录元素，则该出版物没有可用于机器渲染目的的目录。

令 toc 为表示目录的映射 «[ "name" → "", "entries" → « » ]»。
说明

此步骤初始化将存储目录标题和分支的映射。在此映射中：
1. toc["name"] 表示目录标题。
2. toc["entries"] 表示目录分支。
初始化栈 branches，以在创建目录分支时保存这些分支。

说明

该栈用于保存尚未完成的分支。当遇到新的子分支时，父分支会被压入栈中，以便稍后取回。
令 current_toc_node 为设置为null的变量。

说明

current_toc_node 用于保存表示当前正在处理的目录分支的映射。
从正在构建目录的元素开始，按树顺序 [dom]遍历 DOM，并在遍历进入和退出每个元素时，触发下面第一个相关步骤。
1. 进入标题内容元素时：
  
  运行以下步骤：
  1. 如果 branches 为空，且 toc["name"] 是空字符串，则将 toc["name"] 设置为以下之一：
    - 该元素的后代内容（以保留任何 HTML 标签）；
    - 从后代内容获得的文本字符串（例如，通过计算该元素的无障碍名称 [accname-1.1]）。
    如果 toc["name"] 的结果值为空字符串（例如，在移除任何呈现性元素并裁剪所有前导和尾随空白之后），则将 toc["name"] 设置为占位值或 null。
  2. 跳过该元素的进一步处理并继续到下一个。
  说明
  
  此步骤标识目录的标题。只有当 toc["name"] 的值为空字符串（即尚未遇到任何标题）时，才处理标题。
  
  用户代理将 name 设置为标题元素的后代内容，还是从中生成文本字符串，取决于它是否会在呈现中重用任何后代标记（例如，保留图像、MathML、ruby 以及其他不容易转换为文本的内容）。
  示例 69 ：带有标题的 toc 对象可视化。
```
«[
    "name"    → "Contents",
    "entries" → « »
]»
```
  如果 name 不是空字符串，或为 null，则说明先前已经遇到标题，或已遇到表明 nav 元素没有标题的内容（例如，已处理列表，因为标题不应跟在链接列表之后）。
  示例 70 ：没有标题的 toc 对象可视化。
```
«[
    "name"    → null,
    "entries" → « »
]»
```
  如果未指定标题，用户代理可以为后续使用提供自己的标题。
2. 进入列表元素时：
  
  运行以下步骤：
  1. 如果 toc["name"] 是空字符串，则将 toc["name"] 设置为 null。
  2. 如果 current_toc_node 不是null：
    1. 如果 current_toc_node["entries"] 为null或非空列表，则跳过该元素的进一步处理并继续到下一个。
    2. 否则，将 current_toc_node压入 branches，然后将 current_toc_node 设置为 null。
  3. 否则，如果 branches 为空：
    1. 如果 toc["entries"] 为null或非空列表，则跳过该元素的进一步处理并继续到下一个。
    2. 否则，不执行任何操作。
  说明
  
  此算法不处理单个分支或 nav 元素根部中的多个列表，因此如果已经遇到列表（entries 属性包含一个或多个分支或设置为 null），则此列表会被跳过。
  
  如果遇到列表，而目录（toc）仍然没有名称（即尚未遇到标题元素），则假定该目录没有标题（即目录标题不能出现在第一个条目列表之后）。 name 属性的值会从空字符串更改为 null，因为后续遇到的任何标题也都不适用。
3. 退出列表元素时：
  1. 如果 branches 非空，则从 branches 中弹出顶部映射，并将 current_toc_node 设置为它。
  2. 否则，如果 toc.entries 包含空列表，则将其设置为 null。
  说明
  
  此步骤在所有子分支处理完毕后，将 current_toc_node 重置回父对象。
  
  如果栈中没有分支，且 toc.entries 不包含任何项目，则将其设置为 null（以避免在根级别处理任何进一步列表）。
4. 进入列表项元素时，将 current_toc_node 设置为以下映射：
```
«[
    "name" → null,
    "url"  → null,
    "type" → null,
    "rel"  → null,
    "entries" → « »
]»
```
  说明
  
  每个列表项表示目录中可能的新分支，因此每当遇到一个列表项时，都会在 current_toc_node 中创建一个新的空对象。
  
  随着遇到后代 a 元素和列表，此对象会被填充信息。
5. 退出列表项元素时：
  
  运行以下步骤：
  1. 如果 current_toc_node["entries"] 包含空列表，则将其设置为 null。
  2. 如果 current_toc_node["name"] 是null或空字符串：
    1. 如果 current_toc_node["entries"] 不是null，则将 current_toc_node["name"] 设置为占位值或 null；
    2. 否则，将 current_toc_node 设置为null并退出此处理步骤。
  3. 如果 branches 非空，则将 current_toc_node追加到 branches 顶部映射的 entries 属性。否则，将 current_toc_node追加到 toc["entries"]。
  4. 将 current_toc_node 设置为null。
  说明
  
  退出列表项表示当前分支的处理已完成。在将此分支添加到其父级的 entries 数组之前，需要测试该分支是否具有名称和/或任何子分支。如果它没有名称但有子分支，则保留该分支。用户代理可以提供自己创建的占位值，或将该值设置为 null。如果它既没有名称也没有任何分支，则它无效并被丢弃。
  
  为确定将分支合并到何处，会检查栈。如果栈中没有项目，则将其添加到根 toc 对象的 entries 属性中（即，它是顶级分支）。否则，它会被添加到栈中紧邻其前的对象的 entries 属性中。
  
  作为最后一步，current_toc_node 会重置回 null。
  示例 71 ：分支合并的可视化。
  
  如果 branches 中有以下映射：
```
«[
    "name"    → "Section 1",
    "url"     → "http://example.com/contents.html#s1",
    "type"    → "text/html",
    "rel"     → null,
    "entries" → « »
]»
```
  并且 current_toc_node: 中有以下映射：
```
«[
    "name"    → "Section 1.1",
    "url"     → "http://example.com/contents.html#s1.1",
    "type"    → "text/html",
    "rel"     → null,
    "entries" → null
]»
```
  则合并后只剩下以下单个对象：
```
«[
    "name"    → "Section 1",
    "url"     → "http://example.com/contents.html#s1",
    "type"    → "text/html",
    "rel"     → null,
    "entries" → «
        «[
            "name"    → "Section 1.1",
            "url"     → "http://example.com/contents.html#s1.1",
            "type"    → "text/html",
            "rel"     → null,
            "entries" → null
        ]»
    »
]»
```
6. 进入锚点元素且 current_toc_node 不是null时：
  
  运行以下步骤：
  1. 如果 current_toc_node["name"] 不是null，则不执行任何操作。
  2. 否则：
    1. 将 current_toc_node["name"] 设置为以下之一：
      - 锚点元素的后代内容（以保留任何 HTML 标签）；
      - 从后代内容获得的文本字符串（例如，通过计算该元素的无障碍名称 [accname-1.1]）。
    2. 如果该元素具有 href 属性，且该属性中的 URL 解析为 uniqueResources 中的资源，则将 current_toc_node["url"] 设置为该值。
    3. 如果该元素具有 type 属性，并且该属性值在裁剪前导和尾随空白后不是空字符串，则将 current_toc_node["type"] 设置为裁剪后的值。
    4. 如果该元素具有 rel 属性，并且该属性值在裁剪前导和尾随空白后不是空字符串，则按空白拆分裁剪后的值，并将 current_toc_node["rel"] 设置为所得的列表标记。
    跳过该元素的进一步处理并继续到下一个。
  说明
  
  此步骤处理锚点标签，以获得分支的 name 和 url 属性值。
  
  如果当前分支的名称已经定义，则终止对此元素的处理（即，为避免为单个分支处理多个链接）。
  
  用户代理将条目的 name 设置为 a 元素的后代内容，还是从中生成文本字符串，取决于它是否会在呈现中重用任何后代标记（例如，保留图像、MathML、ruby 以及其他不容易转换为文本的内容）。
  
  除了指定 href 属性外，还需要它解析为属于数字出版物的资源，以满足本规范的要求。如果不是，该分支会被保留，但该条目将不可链接。
  
  关于链接目标的附加信息——资源类型及其关系——也会被保留。
  示例 72 ：指向 SVG 图像的链接的可视化。
```
«[
    "name"    → "In the Beginning",
    "url"     → "http://example.com/page1.svg",
    "type"    → "image/svg",
    "rel"     → null,
    "entries" → « »
]»
```
7. 进入分节内容元素、分节根元素，或带有hidden 属性的元素时：
  
  跳过该元素的进一步处理并继续到下一个。
  
  说明
  
  由于分节和分节根元素可以定义自己的大纲，进入其中会给生成目录造成问题（即，它们可能包含不直接相关的内容）。因此，遇到它们时会跳过，以防止处理其子内容。
8. 否则：不执行任何操作。
  
  说明
  
  对于所有其他元素，此步骤允许继续处理其后代元素。
完成 DOM 遍历后，如果 toc["entries"] 包含非空列表，则返回 toc。否则，返回 null。

说明

如果根 toc 对象中的 entries 数组不包含任何分支（可能是因为 nav 元素中未找到列表，或该列表不包含任何符合要求的列表项），则该算法未产生可用的目录。

名称	出版物清单
`abridged`	§ 4.7.1.1 删节版
`accessMode`	§ 4.7.1.2 无障碍
`accessModeSufficient`	§ 4.7.1.2 无障碍
`accessibilityFeature`	§ 4.7.1.2 无障碍
`accessibilityHazard`	§ 4.7.1.2 无障碍
`accessibilitySummary`	§ 4.7.1.2 无障碍
`artist`	§ 4.7.1.5 创建者
`author`	§ 4.7.1.5 创建者
`conformsTo`	§ 4.6 配置文件一致性
`@context`	§ 4.3 清单上下文
`contributor`	§ 4.7.1.5 创建者
`creator`	§ 4.7.1.5 创建者
`dateModified`	§ 4.7.1.7 最后修改日期
`datePublished`	§ 4.7.1.8 发布日期
`direction`	§ 4.4.1 全局声明
`duration`	§ 4.7.1.6 时长
`editor`	§ 4.7.1.5 创建者
`id`	§ 4.7.1.4 规范标识符
`illustrator`	§ 4.7.1.5 创建者
`inker`	§ 4.7.1.5 创建者
`inLanguage`	§ 4.7.1.9 出版物语言
`language`	§ 4.4.1 全局声明
`letterer`	§ 4.7.1.5 创建者
`link`	§ 4.7.2.3 链接
`name`	§ 4.7.1.11 标题
`penciler`	§ 4.7.1.5 创建者
`publisher`	§ 4.7.1.5 创建者
`readBy`	§ 4.7.1.5 创建者
`readingOrder`	§ 4.7.2.1 默认阅读顺序
`readingProgression`	§ 4.7.1.10 阅读推进方向
`resources`	§ 4.7.2.2 资源列表
`translator`	§ 4.7.1.5 创建者
`type`	§ 4.5 出版物类型
`url`	§ 4.7.1.3 地址

名称	出版物清单
`accessibility-report`	§ 4.8.2.1 无障碍报告
`contents`	§ 4.8.1.3 目录
`cover`	§ 4.8.1.1 封面
`pagelist`	§ 4.8.1.2 页列表
`privacy-policy`	§ 4.8.2.3 隐私政策
`preview`	§ 4.8.2.2 预览

出版物清单

W3C 推荐标准 2020年11月10日

摘要

本文档状态

1. 引言

1.1 范围

1.2 清单格式

1.3 JSON-LD 创作和 处理

1.4 与 Schema.org 的关系

2. 术语

3. 一致性

4. 出版物清单

4.1 要求

4.2 值类别

4.2.1 字面量

4.2.2 数字

4.2.3 布尔值

4.2.4 显式对象和隐含 对象

4.2.4.1 可本地化字符串

4.2.4.2 实体

4.2.4.3 链接资源

4.2.4.4 对象

4.2.5 URL

4.2.6 标识符

4.2.7 数组

4.3 清单上下文

4.4 清单语言和 方向

4.4.1 全局声明

4.4.2 特定项目 声明

4.5 出版物类型

4.6 配置文件一致性

4.7 属性

4.7.1 描述性属性

4.7.1.1 删节版

4.7.1.2 无障碍

4.7.1.3 地址

4.7.1.4 规范标识符

4.7.1.5 创建者

4.7.1.6 时长

4.7.1.7 最后修改 日期

4.7.1.8 发布日期

4.7.1.9 出版物语言

4.7.1.10 阅读 推进方向

4.7.1.11 标题

4.7.2 资源 分类属性

4.7.2.1 默认阅读顺序

4.7.2.2 资源列表

4.7.2.3 链接

4.7.3 可扩展性

4.7.3.1 链接记录

4.7.3.2 附加 清单属性

4.8 资源关系

4.8.1 结构性资源

4.8.1.1 封面

4.8.1.2 页列表

4.8.1.3 目录

4.8.2 信息性资源

4.8.2.1 无障碍报告

4.8.2.2 预览

4.8.2.3 隐私政策

4.8.3 扩展

5. 出版物资源

6. 清单发现

6.1 链接

6.2 嵌入

6.3 其他发现方法

7. 处理清单

7.1 引言

7.2 错误处理

7.3 处理上下文

7.4 生成内部 表示

7.4.1 规范化数据

7.4.1.1 转换为绝对 URL

7.4.2 数据验证

7.4.2.1 全局数据检查

7.4.2.2 验证值类别

7.4.2.3 获取唯一 URL

7.4.2.4 移除空数组

7.4.3 添加默认值

8. 模块化扩展

1.3 JSON-LD 创作和处理

4.2.4 显式对象和隐含对象

4.4 清单语言和方向

4.4.2 特定项目声明

4.7.1.7 最后修改日期

4.7.1.10 阅读推进方向

4.7.2 资源分类属性

4.7.3.2 附加清单属性

7.4 生成内部表示

9. 安全和隐私考虑事项

A. 内部表示数据模型

A.1 `PublicationManifest` 字典

A.1.1 `LinkedResource` 字典

A.1.2 `Entity` 字典

A.1.3 `LocalizableString` 字典

E.1 链接关系类型注册