From d51756930583eb776703d1555273c87b810a9448 Mon Sep 17 00:00:00 2001 From: Ivan Herman Date: Wed, 23 Aug 2017 16:10:36 +0200 Subject: [PATCH 1/3] Attempt to document a possible consensus on TOC-s and default reading orders --- index.html | 49 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 47 insertions(+), 2 deletions(-) diff --git a/index.html b/index.html index 1170519..b1e6cb7 100644 --- a/index.html +++ b/index.html @@ -420,13 +420,58 @@

Resources

Default Reading Order

-

The default reading order MUST include at least one primary resource.

+

+ The default reading order MUST include at least one primary resource. +

+ +

+ If the default reading order is not specified in the manifest, but the table of content is available (either as part of the manifest or retrived from among the primary resources), the primary resources listed in the table of content also provide the default reading order (multiple references to the same primary resource in the table of content should be disregared in favour of the first occurence of that resource). +

+ +

+ The relationship between the default reading order and the table of content is the subject of several issues; see the list in the section on table of contents. +

+

Table of Contents

-
Placeholder for identifying table of contents - whether embedded or by reference.
+

If the table of content is not specified in the manifest, the user agent MUST make an attempt to retrive one as follows:

+ +
    +
  1. + Check, among the primary resources of the publication, a resource with basename index.html if it exists, and try to extract a TOC navigation element; +
    2. +
  2. + otherwise, locate the first HTML resource among the primary resources in the order provided by the default reading order that includes a TOC navigation element. +
    3. +
+ +

If such TOC navigation element is found, its content provides the table of content information for the Web Publication infoset. If several of those are found, only the first one is considered.

+ +

+ A TOC navigation element is an HTML nav element with the role attribute set to doc-toc [[!dpub-aria-1.0]]

. +

+ +

+ This process may not yield a table of content, which is in line with the fact that a table of content is not a required information in the WP infoset. +

+ +

+ This question arises only if this mechanism is accepted: the question is whether a TOC navigation element can refer, via links, to any resource that is not listed as a primary resource. +

+ +

+ The issue of using the HTML nav element as a possible encoding of the table of content is mentioned or explicitly addressed in a number of issues listed below. +

+ +

+

Define the primary resources of a WP to be the files referenced in the first

+

+

There is a consensus that a Web publication must have a reading order (a list of primary resources) and must/should have a table of contents (ToC) (the main navigation entry point).

+ +
From 3770041e06fe010b46ff70c9bbf8832f8a5f5bbe Mon Sep 17 00:00:00 2001 From: Ivan Herman Date: Wed, 23 Aug 2017 16:42:54 +0200 Subject: [PATCH 2/3] Use "table of contents" (plural) everywhere, plus minor adjustments. --- index.html | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/index.html b/index.html index b1e6cb7..364934e 100644 --- a/index.html +++ b/index.html @@ -425,11 +425,11 @@

Default Reading Order

- If the default reading order is not specified in the manifest, but the table of content is available (either as part of the manifest or retrived from among the primary resources), the primary resources listed in the table of content also provide the default reading order (multiple references to the same primary resource in the table of content should be disregared in favour of the first occurence of that resource). + If the default reading order is not specified in the manifest, but the table of contents is available (either as part of the manifest or retrived from among the primary resources), the primary resources listed in that table of contents also provide the default reading order (multiple references to the same primary resource in the table of contents should be disregared in favor of the first occurence of that resource).

- The relationship between the default reading order and the table of content is the subject of several issues; see the list in the section on table of contents. + The relationship between the default reading order and the table of contents is the subject of several issues; see the list in the section on table of contents.

@@ -437,25 +437,25 @@

Default Reading Order

Table of Contents

-

If the table of content is not specified in the manifest, the user agent MUST make an attempt to retrive one as follows:

+

If the table of contents is not specified in the manifest, the user agent MUST make an attempt to retrive one as follows:

  1. - Check, among the primary resources of the publication, a resource with basename index.html if it exists, and try to extract a TOC navigation element; + Check, among the primary resources of the publication, an HTML resource with basename index.html if it exists, and extract a TOC navigation element from the resource if present;
  2. - otherwise, locate the first HTML resource among the primary resources in the order provided by the default reading order that includes a TOC navigation element. + otherwise, locate the first HTML resource among the primary resources in the order provided by the default reading order that also includes a TOC navigation element, and extract it.
-

If such TOC navigation element is found, its content provides the table of content information for the Web Publication infoset. If several of those are found, only the first one is considered.

+

If such TOC navigation element is found, its content provides the table of contents information for the Web Publication infoset. If several of those are found, only the first one is considered.

A TOC navigation element is an HTML nav element with the role attribute set to doc-toc [[!dpub-aria-1.0]]

.

- This process may not yield a table of content, which is in line with the fact that a table of content is not a required information in the WP infoset. + This process may not yield a table of contents, which is in line with the fact that a table of contents is not a required information in the WP infoset.

@@ -463,7 +463,7 @@

Table of Contents

- The issue of using the HTML nav element as a possible encoding of the table of content is mentioned or explicitly addressed in a number of issues listed below. + The issue of using the HTML nav element as a possible encoding of the table of contents is mentioned or explicitly addressed in a number of issues listed below.

From fa23b0f77d15cff133d5792089071e443bb252c8 Mon Sep 17 00:00:00 2001 From: Ivan Herman Date: Thu, 24 Aug 2017 06:40:08 +0200 Subject: [PATCH 3/3] removed the table of contents changes, this branch is now only on the toc as fallback issue --- index.html | 38 +++++--------------------------------- 1 file changed, 5 insertions(+), 33 deletions(-) diff --git a/index.html b/index.html index 364934e..1787025 100644 --- a/index.html +++ b/index.html @@ -431,45 +431,17 @@

Default Reading Order

The relationship between the default reading order and the table of contents is the subject of several issues; see the list in the section on table of contents.

+

+

Define the primary resources of a WP to be the files referenced in the first

+

+

There is a consensus that a Web publication must have a reading order (a list of primary resources) and must/should have a table of contents (ToC) (the main navigation entry point).

Table of Contents

-

If the table of contents is not specified in the manifest, the user agent MUST make an attempt to retrive one as follows:

- -
    -
  1. - Check, among the primary resources of the publication, an HTML resource with basename index.html if it exists, and extract a TOC navigation element from the resource if present; -
    2. -
  2. - otherwise, locate the first HTML resource among the primary resources in the order provided by the default reading order that also includes a TOC navigation element, and extract it. -
    3. -
- -

If such TOC navigation element is found, its content provides the table of contents information for the Web Publication infoset. If several of those are found, only the first one is considered.

- -

- A TOC navigation element is an HTML nav element with the role attribute set to doc-toc [[!dpub-aria-1.0]]

. -

- -

- This process may not yield a table of contents, which is in line with the fact that a table of contents is not a required information in the WP infoset. -

- -

- This question arises only if this mechanism is accepted: the question is whether a TOC navigation element can refer, via links, to any resource that is not listed as a primary resource. -

- -

- The issue of using the HTML nav element as a possible encoding of the table of contents is mentioned or explicitly addressed in a number of issues listed below. -

- -

-

Define the primary resources of a WP to be the files referenced in the first

-

-

There is a consensus that a Web publication must have a reading order (a list of primary resources) and must/should have a table of contents (ToC) (the main navigation entry point).

+
Placeholder for identifying table of contents - whether embedded or by reference.