出版マニフェスト

4.2.4.1 ローカライズ可能な文字列

マニフェストのプロパティーが、その値としてローカライズ可能なテキスト文字列を想定している場合、値は次のいずれかで表さなければなりません(MUST)。

• [json]文字列の値。または、
• LocalizableString。

1つの文字列の値は、valueプロパティーが文字列のテキストであり、言語と基本書字方向がマニフェスト内のその他の情報から決定される暗黙的なオブジェクトを表します。

ローカライズ可能な文字列は、値の複数言語表現の促進を目的としているため、ローカライズ可能な文字列を受け入れるプロパティーは、常にこれらの値の配列を受け入れます。そのため、作成する文字列やオブジェクトは1つだけでなければなりませんが、処理の整合性を保つために、そのような値は配列に変換されます。

LocalizableStringは、次のプロパティーからなる[json]オブジェクトです。

基本書字方向の値の意味は次のとおりです。

• ltr: テキスト値の方向性が、明示的に左から右のテキストに設定されていることを示します。
• rtl: テキスト値の方向性が、明示的に右から左のテキストに設定されていることを示します。

基本書字方向の値の欠落は、テキストの値の方向性が、Unicode双方向アルゴリズム[bidi]の規則に従い、強い方向性を持つ最初の文字の方向に明示的に設定されていることを意味します。

4.2.4.2 エンティティー

マニフェストのプロパティーがエンティティー(つまり、作成の様々な側面に責任を有する個人や組織)を想定している場合、その値は次のいずれかで表さなければなりません(MUST)。

• [json]文字列の値、または
• Entity。

1つの文字列の値は、nameプロパティーが文字列のテキストであり、typeがPerson(人)[schema.org]であると想定されるEntityオブジェクトのインスタンスを表します。

エンティティーは、次の最小限のプロパティーの集合を持つ[schema.org]のPerson(人)かOrganization(組織)の型のインスタンスとして定義されています。

4.2.4.3 リンクされた資源

マニフェストのプロパティーは、1つ以上の資源にリンクする場合、次のいずれかで表さなければなりません(MUST)。

1. 資源のURLをエンコードした[json]文字列。または、
2. LinkedResourceのインスタンス。

文字列の値は、urlプロパティーを文字列の値に設定した暗黙のLinkedResourceオブジェクトを表します。

LinkedResourceオブジェクトは次のように定義されています。

integrityプロパティーに対するユーザ・エージェントのサポートはオプションですが(OPTIONAL)、このプロパティーを用いて暗号ハッシュ比較をサポートするユーザ・エージェントは、[sri]に従ってそれを行わなければなりません(MUST)。

この仕様では、代替形式からの選択用にalternateプロパティーのみを定義しています(つまり、encodingFormatに基づくか、URLを検査するか)。プロファイルは、この動作を拡張して、他の基準に基づく選択を可能にすることができます(MAY)。代替を選択するプロセスについては、§ B. 代替資源の選択で記述しています。

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

{
    "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"
        }
    ]
}

{
    …
    "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 オブジェクト

マニフェストのプロパティーが、この項やプロファイルで定義していない種類のオブジェクトを想定している場合、それは[json]オブジェクトで表さなければなりません(MUST)(つまり、プロパティーの値を処理してオブジェクトが作成されることはありません)。

4.7.1.1 要約版

abridgedプロパティーは、デジタル出版物が元の形式から短縮されているかどうかに関する情報を提供します。

{
    …
    "abridged" : true,
    …
}

4.7.1.2 アクセシビリティ

アクセシビリティのプロパティーは、望ましい読み上げ方式が多様なユーザによる利用に対するデジタル出版物の適合性に関する情報を提供します。このプロパティーは概して、[wcag21]で提供されているような確立されたアクセシビリティ基準に対する評価を補完するものです。

次のプロパティーを、アクセシビリティのプロパティーとして分類しています。

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

4.7.1.3 アドレス

アドレスは、デジタル出版物の発信元の位置を識別するURLです。これはurlプロパティーを用いて表します。

デジタル出版物に複数のアドレスを含むことができますが(MAY)、すべてのアドレスが同じドキュメントに対して解決されなければなりません(MUST)。

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

4.7.1.4 正規の識別子

デジタル出版物の正規の識別子のプロパティーは、デジタル出版物に一意の識別子を提供します。これはidプロパティーを用いて表します。

正規の識別子がマニフェストで提供されていなかったり、値が無効なURLであったりする場合は、デジタル出版物には正規の識別子がありません。ユーザ・エージェントは、マニフェストで提供されている他の識別子から正規の識別子を構築しようとしてはなりません(MUST NOT)。

正規の識別子の仕様は、identifierプロパティー[schema.org]やそのサブタイプを用いて追加の識別子の型を含めることによって補完できます(MAY)。

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

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

4.7.1.5 作成者

作成者は、デジタル出版物の作成に責任を有する個人や組織です。

次のプロパティーを、作成者として分類しています。

作成者は、次のいずれかで表さなければなりません(MUST)。

1. Person[schema.org]の名前をエンコードした[json]文字列。または、
2. PersonまたはOrganization[schema.org]のインスタンス。

1つの文字列の値は、nameプロパティーをその文字列の値に設定した[schema.org]のPersonの省略形です。(§ 4.2.4.2 エンティティーも参照。)

マニフェストには、各型の作成者を複数含むことができます(MAY)

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

{
    …
    "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プロパティーを用いて表します。

{
    …
    "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",
    …
}

4.7.1.7 最終修正日

最終修正日は、デジタル出版物が最後に更新された日付(つまり、マニフェストを含む出版物の任意の資源に最後に変更が加えられたとき)です。これはdateModifiedプロパティーを用いて表します。

最終修正日は、(デジタル出版物の形式でサード・パーティーのコンテンツに参照できるなどの場合)必ずしも出版物に対するすべての変更を反映したものではありません。ユーザ・エージェントは、個々の資源の最終修正日をチェックし、変更が行われていて更新が必要かどうかを判断すべきです(SHOULD)。

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

4.7.1.8 公開日

公開日は、デジタル出版物が最初に公開された日付です。これは、出版物のライフサイクルにおける静的なイベントを表し、その後の改訂を識別して比較できるようにします。これはdatePublishedプロパティーを用いて表します。

正確な出版時点に関しては、意図的に解釈の余地を残しています。それは、出版物が最初に利用可能になったとき、または出版物が出版前に最終的なものと見なされた時点でありえます。

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

4.7.1.9 出版言語

デジタル出版物には、(英語、フランス語、中国語などの)コンテンツが表現されている言語である自然言語が少なくとも1つあります。マニフェストには、この概念を設定するために次のプロパティーが含まれており、これは、例えば、(あらかじめ辞書やテキスト読み上げエンジンを読み込むなどの)ユーザ・エージェントの動作に影響を与える可能性があります。

自然言語は整形式の言語タグ[bcp47]でなければなりません(MUST)。

ユーザ・エージェントが出版言語を要求する場合で、マニフェストではそれを得られない、または得られた値が整形式[bcp47]でない場合、ユーザ・エージェントは、内部表現の生成時に出版言語を決定することができます(MAY)。この仕様では、そのような言語タグの作成方法を義務付けていません。ユーザ・エージェントは次のような方法を使用できます。

• マニフェストの言語宣言を用いる。
• デフォルトの読み上げ順序で、資源にある最初の言語宣言を用いる。または、
• 独自に設計したアルゴリズムを用いて言語を算出する。

ユーザ・エージェントが出版物の主要言語を要求する場合で、複数の言語が指定されていれば、inLanguage配列内の最初のエントリーを主要言語として認識しなければなりません(MUST)。

4.7.1.10 読み上げの進行方向

読み上げの進行方向は、デジタル出版物内のある資源から次の資源への読み上げ方向を確立します。これは、メニューの位置、タッチ・ジェスチャー、方向の切り替え、前後ページ用のタップ・ゾーンなどの出版物レベルの相互作用に適応するために用います。読み上げの進行方法は、readingDirectionプロパティーを用いて表します。

このプロパティーの値は、次のいずれかでなければなりません(MUST)。

• ltr: 左から右。または、
• rtl: 右から左。

デフォルト値はltrです。readingProgressionが設定されていなければ、ユーザ・エージェントは内部表現の生成時にこのデフォルト値を用いなければなりません(MUST)。

このプロパティーは、個々の主要な資源の表示には影響を与えず、ある資源から別の資源への進行方向にのみ関係します。

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

4.7.1.11 タイトル

タイトルは、デジタル出版物の人間が読める名前を提供します。これはnameプロパティーを用いて表します。

タイトルがマニフェストに含まれていなければ、ユーザ・エージェントはタイトルを作成しなければなりません(MUST)。タイトルを取得するプロセスは、§ 7.4.3 デフォルト値の追加で定義しています。

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

4.7.2.1 デフォルトの読み上げ順序

デフォルトの読み上げ順序は、一連のデジタル出版物資源を通じた特定の進行方法です。ユーザはコンテンツを介して別の経路をたどる可能性がありますが、そのような相互作用がなければ、デフォルトの読み上げ順序により、ある資源から次の資源への予想される進行方法が定まります。

デフォルトの読み上げ順序は、readingOrderプロパティーを用いて表します。

readingOrderプロパティーの各要素は、次のいずれかで表さなければなりません(MUST)。

• 資源のURLを表す[json]文字列。または、
• LinkedResourceオブジェクトのインスタンス。

1つの文字列の値は、urlプロパティーが文字列のテキストであるLinkedResourceオブジェクトのインスタンスを表します。

アイテムの順序は重要です。

読み上げ順序で表すURLにはフラグメント識別子を含むことができますが(MAY)、この仕様のプロファイルでは、その使用と、サポートされるスキームおよび機能の両方を制限できます(MAY)。(ユーザの移動先である開始位置や、読み上げ順序で次のアイテムに移動する前に表示するコンテンツの範囲などの)フラグメント識別子は、それぞれの仕様によって定義されているものとして解釈されます。

読み上げ順序に資源を複数掲載すべきではありません(SHOULD NOT)。これは、(資源へのリンクが読み上げ順序の正しいインスタンスに対して解決されないなど)ユーザ・エージェントに予測しない結果をもたらす可能性があるためです。

デジタル出版物がマニフェストにリンクされている資源のみで構成されている場合は、デフォルトの読み上げ順序を省略できます(MAY)。ユーザ・エージェントは、デフォルトの読み上げ順序がなければ、内部表現の編集時にリンク資源のエントリーを含めなければなりません(MUST)。詳細については、§ 7.4.3 デフォルト値の追加を参照してください。

デフォルトの読み上げ順序には、マニフェストの処理後に少なくとも1つの資源が含まれていなければなりません(MUST)。

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

{
    …
    "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プロパティーを用いて表します。

resourcesプロパティーの各要素は、次のいずれかで表さなければなりません(MUST)。

• 資源のURLを表す[json]文字列。または、
• LinkedResourceオブジェクトのインスタンス。

1つの文字列の値は、urlプロパティーが文字列のテキストであるLinkedResourceオブジェクトのインスタンスを表します。

アイテムの順序は重要ではありません。

資源に関する情報の競合を避けるために、特定の資源のURLを資源リスト内で繰り返すべきではありません(SHOULD NOT)。

資源リストで表示するURLにフラグメント識別子を含めるべきではありません(SHOULD NOT)。

資源リストの完全性は、(オフライン読み上げ機能などの)特定の読み上げシナリオにおけるデジタル出版物の使いやすさに影響を与える可能性があります。このため、デフォルトの読み上げ順序に掲載しているもののみでなく、出版物を構成するすべての資源の包括的なリストを提供することを強くお勧めします。

場合によっては、(情報源の深部から資源を参照するサード・パーティーのスクリプトなど)これらの資源の包括的なリストを容易に作成できない場合もありますが、ユーザ・エージェントは、(資源なしにオフラインになっているなどの場合)これらの資源の一部が出版物に属していると識別されない場合でも出版物を表示できるべきです(SHOULD)。

{
    …
    "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プロパティーを用いて表します。

linksプロパティーの各要素は、次のいずれかで表さなければなりません(MUST)

• 資源のURLを表す[json]文字列。または、
• LinkedResourceオブジェクトのインスタンス。

1つの文字列の値は、urlプロパティーが文字列のテキストであるLinkedResourceオブジェクトのインスタンスを表します。

アイテムの順序は重要ではありません。

LinkedResourceオブジェクトにrel値を設定して用いることをお勧めします(RECOMMENDED)。

リンクされた資源は通常、次のような処理や表示の増強・強化を行うために、ユーザ・エージェントに提供されます。

• ユーザ・エージェントが棚(shelf)からのリンク先として提供できるプライバシー方針やライセンス。
• ユーザ・エージェントが出版物に関する詳細情報を発見して表示するために使用できるメタデータ・レコード。または、
• ユーザ・エージェントが拡張された言語のヘルプを提供するために処理できる用語の辞書。

リンクは、出版物のオンライン表示で用いる資源の識別にも使用できますが、(サイズを最小化するためなどで)出版物をオフラインにしたりパッケージ化したりする場合には含める必要はありません。これには次のものが含まれます。

• 出版物の体裁を向上させるけれども、表示には不可欠ではない大規模なフォント・ファイル(つまり、フォールバック・フォントで事足りる)。または、
• (追跡用のスクリプトなどの)出版物をオフラインにしたりパッケージ化したりした場合に用いることを目的としていないサード・パーティーのスクリプト。

linksリストには、(スクリプト、画像、スタイルシートなどの)リンクされた資源を表示するために必要な資源を含めるべきです(SHOULD)。

linksリストに掲載されている資源をデフォルトの読み上げ順序や資源リストに掲載してはなりません(MUST NOT)。

ユーザ・エージェントはリンクされた資源を無視することができ(MAY)、出版物でそれをオフラインにする必要はありません。この資源は、出版物をパッケージ化する場合には含めるべきではありません(SHOULD NOT)。

4.7.3.1 リンクされたレコード

マニフェストは、LinkedResourceオブジェクトを用いて、ONIX[onix]やBibTeX[bibtex]などのメタデータ・レコードへのリンクによって拡張できます(MAY)。その場合、

• LinkedResourceのrelプロパティーには、関連する識別子を含みます(例えば、リンクされたレコードに記述メタデータが含まれていれば、describedby識別子[iana-link-relations]を使用できます)。
• 該当する場合、encodingFormatの値で、その特定の型のレコード用に定義されているMIMEメディア・タイプ[rfc2046]を識別します。

リンクされたレコードは、出版物の一部である場合は、資源リストに含まれます(つまり、単なるマニフェストの拡張性以上である場合に必要です)。そうでない場合は、リンク・リストに含まれます。

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

4.7.3.2 追加のマニフェスト・プロパティー

追加のプロパティーは、[schema.org]や[dcterms]などの公的なスキームを用いてマニフェストに直接含めることができます(MAY)。独自の用語を用いることもできますが(MAY)、そのような用語は、接頭辞をコンテキストの一部として定義した短縮IRI[json-ld11]を用いて含めることをお勧めします(RECOMMENDED)。

{
    "@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]は、ダブリン・コアの用語(dcterms)[dcterms]や要素セット(dc)[dc11]、FOAF語彙(foaf)[foaf]、書誌オントロジー(bibo)[bibo]など、一般的に用いられている語彙に対していくつかの接頭辞を定義しています。これらの語彙のプロパティーは、接頭辞を宣言しなくても使用できます。

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

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

4.8.1.1 表紙

表紙は、(ライブラリや本棚で、または最初に出版物を読み込む際などに)ユーザ・エージェントがデジタル出版物を提示するために使用できる資源です。

表紙は、coverというリンク関係で識別されます。

表紙へのリンクは、リンク・リストで指定してはなりません(MUST NOT)。

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

(HTML資源に組み込まれているかどうかに関係なく)表紙が画像であれば、代替テキストと拡張記述を提供するために、達成基準1.1.1[wcag21]に従うことを強くお勧めします。この情報を組み込めない画像形式の場合は、LinkedResourceのnameとdescriptionのプロパティーを用いて、それぞれ代替テキストと拡張記述を提供できます。その場合は、nameプロパティーを常に設定すべきです(SHOULD)(装飾的な画像の場合はプロパティーを空のままにしておくことができます。)

{
    …
    "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"
        },
        …
    ],
    …
}

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

ユーザ・エージェントでインターフェイスにアクセスできるようにするためには表紙画像の代替テキストが必要で、nameプロパティーが指定されていなければ、出版物のメタデータから代替テキストの構築を試みることができます(MAY)。この仕様では、そのような代替テキストの作成方法を義務付けていません。1つの方法は、画像が表紙であることを識別する文字列で代替テキストを構築し、その後に出版物のタイトルを続けることです。

表紙として識別できる(MAY)資源は1つだけですが、(代替の大きさや解像度を提供するなどのために)alternateプロパティーを用いて追加の表紙を指定することができます(MAY)。

{
    …
    "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というリンク関係で識別されます。

ページ・リストが含まれている資源として識別できる(MAY)のは1つのみです。複数のインスタンスが指定されていれば、ユーザ・エージェントは、読み上げ順序を優先して最初に検出されたインスタンスを用いなければなりません(MUST)。

ページ・リストへのリンクをリンク・リストで指定してはなりません(MUST NOT)。

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

4.8.1.3 目次

目次は、デジタル出版物の主要な構造部分へのリンクを提供するナビゲーション支援です。

目次が含まれている資源はcontentsというリンク関係[iana-link-relations]で識別されます。適切な目次は、§ C.2 HTML構造で定義しているように、roleの値であるdoc-tocを持つその資源内の最初の要素です。

目次が含まれている資源として識別できる(MAY)のは1つだけです。複数のインスタンスが指定されていれば、ユーザ・エージェントは、読み上げ順序内の資源を優先して最初に検出されたインスタンスを用いなければなりません(MUST)。

この仕様のプロファイルでは、contents関係で資源が識別できない場合に、目次が含まれている資源を指定する方法を定義することができます(MAY)。

リンク・リストで目次へのリンクを指定してはなりません(MUST NOT)。

推奨される(RECOMMENDED)目次の構造と処理モデルは、§ C. 機械処理可能な目次で定義しています。

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

4.8.2.1 アクセシビリティ報告書

アクセシビリティ報告書は、望ましい読み上げ方式が多様なユーザによる利用に対するデジタル出版物の適合性に関する情報を提供します。この報告書は通常、[wcag21]が提供しているような、確立されたアクセシビリティ基準に対する評価結果を識別するものであり、出版物のユーザビリティを決定する際の重要な情報源です。

アクセシビリティ報告書はaccessibility-reportというリンク関係で識別されます。

報告書を出版物の資源として含め、出版物をオフラインで読み上げるときなどに利用できるようにすると便利です。

{
    …
    "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)。

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

{
    …
    "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]で識別されます。

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

7.4.1.1 絶対URLへの変換

基底URLであるbaseを用いて絶対URLであるurlに変換するためには、次のステップを実行します。

1. urlまたはbaseが文字列ではない場合や、空の文字列である場合は、検証エラーとなり、失敗を返します。

   説明

   このステップでは、urlとbaseの両方が空でない文字列であることをチェックした後で、それらを用います。

2. 成功した場合は、urlを、urlを入力としてbaseを基底URLとして用いてURLパーサー[url]を実行した結果に設定します。失敗が返された場合は、検証エラーとなり、失敗を返します。

   説明

   このステップでは、処理するURLに対してURLパーサー関数を呼び出します。URLが絶対URLでなければ、パーサーは基底URLを用いてそれを変換します。

   解析で失敗が返された場合は、URLを削除するように指示するために、呼び出し元に失敗が返されます。

3. urlを返します。

7.4.2.1 グローバルなデータ・チェック

オプションのコンテキストであるcontextを用いてtermというプロパティーのvalueのグローバルなデータ・チェックを処理するためには、次のステップを実行します。

1. (§ 4.2 値のカテゴリ)termに既知の値のカテゴリがあれば、成功した場合は、valueを、term、value、contextという変数を条件として値のカテゴリの検証を呼び出した結果に設定します。失敗が返された場合は、失敗を返します。

   そうでない場合は、valueを返します。

   説明

   このステップでは、用語の値がその用語に必要な想定されるカテゴリと一致することを検証します。例えば、要約された用語にはブール値が必要であるため、この用語にその他の値を用いると失敗に終わります。

   関数の呼び出しで失敗が発生すれば、このステップでも失敗が返されるため、プロパティーは最終的なデータセットから削除されます。

   既知の値のカテゴリがない用語は処理されないため、入力値が返されます。

2. 最初にサブプロパティーをチェックするために、次のように再帰的にvalueへと降下します。

   1. valueがマップであれば、

      1. value["type"]に認識されている型が含まれていれば、key → valueのkeyValueごとに、成功した場合は、value[key]を、key、keyValueを条件として、value["type"]をコンテキストとして用いてグローバルなデータ・チェックを実行した結果に設定します。失敗が返された場合は、value[key]を削除します。

      2. そうでない場合は、何もしません。

   2. そうでない場合は、valueがリストであれば、valueのitemごとに、itemがマップであれば、

      1. item["type"]に認識されている型が含まれていれば、key → itemのkeyValue ごとに、成功した場合は、item[key]を、key、keyValueを条件として、item["type"]をコンテキストとして用いてグローバルなデータ・チェックを実行した結果に設定します。失敗が返された場合は、item[key]を削除します。

      2. そうでない場合は、何もしません。

   3. そうでない場合は、何もしません。

   説明

   マニフェスト内のすべてのプロパティーが確実に処理されるようにするために、このステップでは、処理する追加のマップのエントリーに関して各エントリーを再帰的にチェックします。値がリストであれば、各アイテムを検査し、処理可能なマップであるかどうかを判断します。

   これを置くことで、すべてのサブプロパティーが最初に確実にチェックされるため、無効な値が削除された後で、ステップの後半のより高レベルなチェックを行えます。

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. (§ 4.2.4.2 エンティティー)termがエンティティーの配列を想定していれば、valueのitemごとに、item["name"]が設定されているかどうかをチェックします。

   • そうでない場合は、検証エラーとなり、valueからitemを削除します。

   • そうである場合は、item["name"]のnameごとに、name["value"]が設定されていない場合や、空の文字列である場合は、item["name"]からnameを削除します。
   説明

   このステップでは、すべてのエンティティーに名前があることを確認します。名前のないエンティティーは削除されます。

5. (§ 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の用語に次の2つのチェックを実行します。

   1. URLが指定されていない場合や、無効である場合は、LinkedResourceを削除します。
   2. 資源の時間長が指定されている場合や、ISO 8601の時間長の値でない場合は、時間長のプロパティーを削除します。

6. valueを返します。

7.4.2.2 値のカテゴリの検証

コンテキストであるcontextでtermというプロパティーのvalueの値のカテゴリの検証を行うためには、次のステップを実行します。

1. contextに応じて、termが配列を想定していれば、

   1. valueがリストでなければ、検証エラーとなり、失敗を返します。

   2. そうでない場合は、valueのitemごとに、

      1. itemが配列の想定している値のカテゴリと一致しない場合は、検証エラーとなり、valueからitemを削除し、その後に続行します。

      2. itemがマップであれば、key → itemのkeyValueごとに、keyに想定している値のカテゴリがあれば、keyを、key、keyValueを条件として、item["type"]をコンテキストとして用いて値のカテゴリの検証を実行した結果に設定します。itemの処理結果が空のマップであれば、検証エラーとなり、valueからitemを削除します。

      valueの処理結果が空の配列であれば、検証エラーとなり、失敗を返します。

2. そうでない場合は、contextに応じて、termがマップを想定していれば、

   1. valueがマップでなければ、検証エラーとなり、失敗を返します。

   2. そうでない場合は、key → valueのkeyValueごとに、keyに想定している値のカテゴリがあれば、keyを、key、keyValueを条件として、value["type"]をコンテキストとして用いて値のカテゴリの検証を実行した結果に設定します。valueの処理結果が空のマップであれば、検証エラーとなり、失敗を返します。

   注

   このステップは現在、プロファイルで用いるためにのみ存在しています。この仕様で定義しているプロパティーはすべて、オブジェクトの配列を受け入れます。

3. そうでない場合は、contextに応じて、valueがtermの想定している値のカテゴリと一致しなければ、検証エラーとなり、失敗を返します。

4. valueを返します。

7.4.2.3 一意のURLの取得

resourcesから一意のURLを取得するためには、次のステップを実行します。

1. uniqueURLsを空の順序付き集合とします。

2. resourcesのresourceごとに、

   1. urlを、exclude fragment flagを設定してresource["url"]でURLシリアライザ[url]を実行した結果とします。

   2. uniqueURLsにurlが含まれていれば、検証エラーです。そうでない場合は、uniqueURLsにurlを追加します。

   3. resource["alternate"]が設定されていれば、resource["alternate"]のalternateごとに、

      1. alt_urlを、exclude fragment flagを設定してalternate["url"]でURLシリアライザ[url]を実行した結果とします。

      2. uniqueURLs にalt_urlが含まれていれば、検証エラーです。

      3. そうでない場合は、alt_urlをuniqueURLsに追加します。

3. uniqueURLsを返します。

7.4.2.4 空の配列の削除

termというプロパティーのvalueから空の配列を削除するためには、次のステップを実行します。

1. valueが空のリストであれば、失敗を返します。

2. そうでない場合は、valueがマップであれば、key → valueのkeyValueごとに、keyとkeyValueを条件として空の配列の削除を実行すると失敗を返す場合は、value[key]を削除します。