@@ -1077,153 +1101,130 @@ Accessibility
as those provided in [[WCAG20]]. (For linking to a detailed accessibility report, see The following are categorized as accessibility properties:
-
-
- accessModeaccessModeSufficientaccessibilityAPIaccessibilityControlaccessibilityFeatureaccessibilityHazardaccessibilitySummary
-
- The more detailed descriptions of these properties, as well as the possible values, are described
- on the WebSchemas Wiki site .
-
-
- Infoset Requirements
-
- Values SHOULD be drawn from the preferred
- vocabulary for each accessibility property, but user agents MUST NOT omit values
- from the infoset that are not included in the lists.
-
-
-
- Manifest Expression
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- accessMode
- The human sensory perceptual system or cognitive faculty through which a person
- may process or perceive information.
- One or more text(s). Expected values .
-
- accessModeCreativeWork )
-
-
-
- accessModeSufficient
- A list of single or combined accessModes that are sufficient to understand all
- the intellectual content of a resource.
- One or more ItemList . Expected values .
-
- accessModeSufficientCreativeWork )
-
-
-
- accessibilityAPI
- Indicates that the resource is compatible with the referenced accessibility
- APIs.
- One or more text(s).Expected values .
-
- accessibilityAPICreativeWork )
-
-
-
- accessibilityControl
- Identifies input methods that are sufficient to fully control the described
- resource.
- One or more text(s). Expected values .
-
- accessibilityControlCreativeWork )
-
-
-
- accessibilityFeature
- Content features of the resource, such as accessible media, alternatives and
- supported enhancements for accessibility.
- One or more text(s). Expected values .
-
- accessibilityFeatureCreativeWork )
-
-
-
- accessibilityHazard
- A characteristic of the described resource that is physiologically dangerous to
- some users.
- One or more text(s).Expected values .
-
- accessibilityHazardCreativeWork )
-
-
-
- accessibilitySummary
- A human-readable summary of specific accessibility features or deficiencies,
- consistent with the other accessibility metadata but expressing subtleties such
- as “short descriptions are present but long descriptions will be needed for
- non-visual users” or “short descriptions are present and no long descriptions
- are needed.”
- Text.
-
- accessibilitySummaryCreativeWork )
-
-
-
-
- Note that the author MAY also provide a reference to a more detailed Accessibility Report , beyond the accessibility
- information expressed by these properties.
+ The following properties are categorized as accessibility properties:
+
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ accessMode
+ The human sensory perceptual system or cognitive faculty through which a person may
+ process or perceive information.
+ One or more text(s). Expected values .
+
+ accessModeCreativeWork )
+
+
+
+ accessModeSufficient
+ A list of single or combined accessModes that are sufficient to understand all the
+ intellectual content of a resource.
+ One or more ItemList . Expected values .
+
+ accessModeSufficientCreativeWork )
+
+
+
+ accessibilityAPI
+ Indicates that the resource is compatible with the referenced accessibility APIs.
+ One or more text(s).Expected values .
+
+ accessibilityAPICreativeWork )
+
+
+
+ accessibilityControl
+ Identifies input methods that are sufficient to fully control the described
+ resource.
+ One or more text(s). Expected values .
+
+ accessibilityControlCreativeWork )
+
+
+
+ accessibilityFeature
+ Content features of the resource, such as accessible media, alternatives and
+ supported enhancements for accessibility.
+ One or more text(s). Expected values .
+
+ accessibilityFeatureCreativeWork )
+
+
+
+ accessibilityHazard
+ A characteristic of the described resource that is physiologically dangerous to
+ some users.
+ One or more text(s).Expected values .
+
+ accessibilityHazardCreativeWork )
+
+
+
+ accessibilitySummary
+ A human-readable summary of specific accessibility features or deficiencies,
+ consistent with the other accessibility metadata but expressing subtleties such as
+ “short descriptions are present but long descriptions will be needed for non-visual
+ users” or “short descriptions are present and no long descriptions are needed.”
+ Text.
+
+ accessibilitySummaryCreativeWork )
+
+
+
+
+ Detailed descriptions of these properties are available on the WebSchemas Wiki site .
+
+ Values SHOULD be drawn from the preferred
+ vocabulary for each accessibility property, but user agents MUST NOT omit values from
+ that are not included in the lists when generating the canonical
+ manifest .
+
+ The author can also provide a reference to a detailed Accessibility Report if more information is needed than can
+ be expressed by these properties.
-
+
partial dictionary WebPublicationManifest {
sequence<DOMString> accessMode;
sequence<DOMString> accessModeSufficient;
@@ -1234,7 +1235,7 @@ Manifest Expression
LocalizableString accessibilitySummary;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "CreativeWork",
@@ -1255,7 +1256,6 @@ Manifest Expression
}
-
@@ -1266,64 +1266,57 @@ Address
represents the primary entry page for the Web Publication. It is expressed using the
url property.
-
- Infoset Requirements
-
- If the address does not resolve to an HTML
- document [[!html]], user agents SHOULD NOT provide access to it to users. A Web
- Publication MAY have more than one address, but all the addresses MUST resolve to the same
- document.
-
- The referenced document SHOULD be a resource of the Web Publication. It can be any resource,
- including one that is not listed in the default reading order . This document MUST
- include a link to the manifest to ensure a bidirectional linking
- relationship (i.e., that user agents can also locate the manifest from the document at the
- address).
-
- If the document is not a Web Publication resource, user agents SHOULD load the first document
- in the default reading order when initiating the Web Publication.
-
- To improve the usability of Web Publications, particularly in user agents that
- do not support Web Publications, authors are encouraged to include navigation aids in the
- referenced document that facilitate consumption of the content, (e.g., provide a table of
- contents or a link to one).
-
- The Web Publication's address can also be used as value for an identifier link
- relation [[link-relation]].
-
-
-
- Manifest Expression
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- url
- URL of the primary entry page.
- A URL [[!url]].
-
- urlThing )
-
-
-
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ url
+ URL of the primary entry page.
+ A URL [[!url]].
+
+ urlThing )
+
+
+
+
+ If the address does not resolve to an HTML
+ document [[!html]], user agents SHOULD NOT provide access to the resource to users. A Web
+ Publication MAY have more than one address, but all the addresses MUST resolve to the same
+ document.
+
+ The referenced document SHOULD be a resource of the Web Publication. It can be any resource,
+ including one that is not listed in the default reading order . This document MUST include
+ a link to the manifest to ensure a bidirectional linking
+ relationship (i.e., that user agents can also locate the manifest from the document at the
+ address).
+
+ If the document is not a Web Publication resource, user agents SHOULD load the first document in
+ the default reading order when initiating the Web Publication.
+
+ To improve the usability of Web Publications, particularly in user agents that do
+ not support Web Publications, authors are encouraged to include navigation aids in the
+ referenced document that facilitate consumption of the content, (e.g., provide a table of
+ contents or a link to one).
+
+ The Web Publication's address can also be used as value for an identifier link
+ relation [[link-relation]].
-
+
partial dictionary WebPublicationManifest {
required DOMString url;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -1332,7 +1325,6 @@ Manifest Expression
…
}
-
@@ -1342,6 +1334,27 @@ Canonical Identifier
canonical identifier is a unique identifier that resolves to the preferred version of
the Web Publication. It is expressed using the id property.
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ id
+ Preferred version of the Web Publication.
+ A URL [[!url]].
+ (None)
+
+
+
+
Ensuring uniqueness of canonical identifiers is outside the scope of this
specification. The actual achievable uniqueness depends on such factors as the conventions of
the identifier scheme used and the degree of control over assignment of identifiers.
@@ -1355,55 +1368,23 @@ Canonical Identifier
intended to provide a means of identifying instances of the same Web Publication hosted at
different URLs.
-
- Infoset Requirements
-
- The canonical identifier MUST be a URL [[!url]].
+ If a URL is not provided in the manifest, or the value is an invalid URL, the Web Publication
+ does not have a canonical identifier. User agents MUST NOT attempt to construct a canonical
+ identifier from any other identifiers provided in the manifest for the canonical manifest.
- If a URL is not provided in the manifest, or the value is an invalid URL, the Web Publication
- does not have a canonical identifier. User agents MUST NOT attempt to construct a canonical
- identifier from any other identifiers provided in the manifest.
-
- Is a canonical identifier necessary to call out explicitly in
- the infoset , or can it be handled by other
- metadata.
-
-
-
- Manifest Expression
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- id
- Preferred version of the Web Publication.
- A URL [[!url]].
- (None)
-
-
-
+ Is a canonical identifier necessary to call out explicitly, or can
+ it be handled by other metadata.
- The specification of the canonical identifier MAY be complemented by the inclusion of
- additional types of identifiers for the Web Publication using the identifier
- property
+ The specification of the canonical identifier MAY be complemented by the inclusion of additional
+ types of identifiers for the Web Publication using the identifier property
-
+
partial dictionary WebPublicationManifest {
DOMString id;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "TechArticle",
@@ -1414,7 +1395,7 @@ Manifest Expression
}
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -1425,237 +1406,212 @@ Manifest Expression
}
-
Creators
- A creator is an individual or entity responsible for the creation of the Web
- Publication . Creators are represented in one of the following two ways:
-
-
- as a string encoding the name of a Person; or
- as an instance of a PersonOrganization
-
-
- In other words, a single string value is a shorthand for a Person object whose
- name property is set to that string value. (See also
+ A creator is an individual or entity responsible for the creation of the Web
+ Publication .
The following properties are categorized as creators:
-
- artistauthorcontributorcreatoreditorillustratorinkerlettererpencilerpublisherreadBytranslator
-
-
- Infoset Requirements
-
- When compiling each set of creator information from a
- [[!schema.org]] PersonOrganization
-
-
-
- type
-
- One or more strings that identifies the type of creator. This sequence SHOULD include
- "Person" or "Organization".
-
- name
-
- One or more localizable strings for the name of the creator.
-
- id
-
- A canonical identifier of the creator as a URL. [[!url]]
-
-
- url
-
- An address for the creator in the form of a URL. [[!url]]
-
-
- Note that user agents MAY interpret a wider range of creator properties defined by schema.org
- than the ones in the preceding list.
+
+
+ Creators are represented in one of the following two ways:
- The infoset MAY include more than one of each type of creator.
-
+
+ as a string encoding the name of a Person
+ as an instance of a PersonOrganization
+
-
- Manifest Expression
+ In other words, a single string value is a shorthand for a [[!schema.org]] Person
+ whose name property is set to that string value. (See also
-
+ When compiling each set of creator information from a
+ [[!schema.org]] PersonOrganization
+
+
+
+ type
+
+ One or more strings that identifies the type of creator. This sequence SHOULD include
+ "Person" or "Organization".
+
+ name
+
+ One or more localizable strings for the name of the creator.
+
+ id
+
+ A canonical identifier of the creator as a URL. [[!url]]
+
+
+ url
+
+ An address for the creator in the form of a URL. [[!url]]
+
+
+ Note that user agents MAY interpret a wider range of creator properties defined by Schema.org
+ than the ones in the preceding list.
+
+ The manifest MAY include more than one of each type of creator.
-
+
partial dictionary WebPublicationManifest {
sequence<CreatorInfo> artist;
sequence<CreatorInfo> author;
@@ -1680,7 +1636,7 @@ Manifest Expression
DOMString url;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -1692,7 +1648,7 @@ Manifest Expression
}
}
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "TechArticle",
@@ -1725,7 +1681,6 @@ Manifest Expression
…
}
-
@@ -1733,68 +1688,110 @@ Language and Base Direction
The Web Publication has a natural language value (e.g., English, French, Chinese), as well
as a natural base writing direction (the display direction, either left-to-right or
- right-to-left). The infoset
-
- Similarly, each natural language property value in the Web Publication's
- infoset title , creators ) is
+
+ Similarly, each natural language property value in the Web Publication's manifest (e.g.,
+ title , creators ) is localizable [[string-meta]], meaning that the same information is available for
each.
- As a result, the infoset
+ As a result, the manifest has entries to set:
the natural language , and
the base direction
- of both the Web Publication (inLanguage and inDirection) and the
- natural language properties values of the infoset
-
+ of both the Web Publication and the natural language properties values of the
+ manifest.
-
- Infoset Requirements
+ If a user agent requires the language and one is not available in the authored manifest (either
+ globally or specifically for that property), or the obtained value is invalid, the user agent
+ MAY attempt to determine the language when generating the
+ canonical manifest . This specification does not mandate how such a language tag is
+ created. The user agent might:
- The infoset MAY contain global language and base
- direction declarations for the Web Publication. The natural language MUST be a tag that
- conforms to [[!bcp47]], while the base language
- direction MUST have one of the following values:
+
+ use the non-empty language declaration of the manifest;
+ use the first non-empty language declaration found in a resource in the default reading
+ order ;
+ calculate the language using its own algorithm.
+
-
- ltr rtl auto
+ No default values are specified for the language or the default base direction .
- When specified, these properties are also used as defaults for textual values in the infoset .
+ Proposal for handling localizable texts (writeup of the F2F
+ discussions)
- It is important to differentiate the language of the publication from
- the language and the base direction of the individual resources that compose it. If such
- resources are, for example, in HTML, the language and direction need to be set in those
- resources, too. The language and base direction of the publication are not inherited.
+
+ Global Language and Direction
- The global language information MAY be overridden by individual values.
+ The manifest MAY include global language and base direction declarations for the Web
+ Publication using the following properties.
- When using Web Publication manifests with bidirectional text, user agents SHOULD identify the
- base direction of any given natural language value by scanning the text for the first strong
- directional character. Once the base direction has been identified, user agents MUST
- determine the appropriate rendering and display of natural language values according to the
- Unicode Bidirectional Algorithm [[!bidi]]. This could require wrapping additional
- control characters or markup around the string prior to display, in order to apply the base
- direction. (See
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ inLanguage
+ Default language for the Web Publication as well as the textual
+ manifest values
+ language code as defined in [[!bcp47]]
+
+ inLanguageProperty )
+
+
+
+
+
+ inDirection
+ Default base direction for the Web Publication as well as the
+ textual manifest values
+ ltr, rtl, or auto(None)
+
+
+
+
+ The natural language MUST be a tag that conforms to [[!bcp47]], while the base language direction MUST have one of the following
+ values:
+
+
+ ltr rtl auto
- This section, in particular the features related to text directions, must be
- reviewed by I18N experts.
+ When specified, these properties are also used as defaults for textual values in the
+ manifest.
+
+ It is important to differentiate the language of the publication from
+ the language and the base direction of the individual resources that compose it. If such
+ resources are, for example, in HTML, the language and direction need to be set in those
+ resources, too. The language and base direction of the publication are not inherited.
+
+ The global language information MAY be overridden by individual values .
If the manifest is embedded in the primary entry page via a
script element, and the manifest does not set the global language and/or
@@ -1810,74 +1807,12 @@
Infoset Requirements
It is to be discussed whether this last paragraph, i.e., inheriting values from
script, should be kept.
- If a user agent requires the language and one is not available in the infoset (globally, or specifically for that property), or
- the obtained value is invalid, the user agent MAY attempt to determine the language. This
- specification does not mandate how such a language tag is created. The user agent might:
-
-
- use the non-empty language declaration of the manifest;
- use the first non-empty language declaration found in a resource in the default
- reading order ;
- calculate the language using its own algorithm.
-
-
- No default values are specified for the language or the default base
- direction .
-
-
-
-
-
- Manifest Expression
-
- As this infoset item refers to several aspects of setting language and direction, these are
- treated separately.
-
-
- Global Language and Direction
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- inLanguage
- Default language for the Web Publication as well as the
- textual infoset values
- language code as defined in [[!bcp47]]
-
- inLanguageProperty )
-
-
-
-
-
- inDirection
- Default base direction for the Web Publication as well as the
- textual infoset values
- ltr, rtl, or auto(None)
-
-
-
-
- If authors intend to use a manifest, or a manifest template, both as
- embedded manifest and as a separate resource, they are strongly encouraged to set these
- properties explicitly to avoid interference of the containing script
- element in case of embedding.
+ If authors intend to use a manifest, or a manifest template, both as embedded
+ manifest and as a separate resource, they are strongly encouraged to set these properties
+ explicitly to avoid interference of the containing script element in case of
+ embedding.
-
+
partial dictionary WebPublicationManifest {
DOMString inLanguage;
TextDirection inDirection;
@@ -1889,19 +1824,18 @@ Global Language and Direction
"auto"
};
-
+
-
- Item-specific Language
+
+ Item-specific Language
- It is possible to set the language for any textual value in the manifest. This
- information MUST be set as a localizable string ,
- i.e., using the value and language terms
+ It is possible to set the language for any textual value in the manifest. This information
+ MUST be set as a localizable string , i.e., using the
+ value and language terms
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -1915,17 +1849,16 @@ Item-specific Language
}
}
- The value of the language
+ The value of the language
- When used in a context of localizable texts, a simple string value is a shorthand for a
- localizable string , with the value inLanguage
+ When used in a context of localizable texts, a simple string value is a shorthand for a
+ localizable string , with the value inLanguage
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -1934,21 +1867,28 @@ Item-specific Language
"author" : "Marcel Proust",
}
- (See also
+ (See also
- It is not possible to set the direction explicitly for a value.
+ It is not possible to set the direction explicitly for a value.
- Setting the direction for a natural text value is currently not possible in
- JSON-LD [[json-ld]]. In case the JSON-LD community, as well as the schema.org
- community, introduces such a feature, future versions of this specification may extend
- the ability of Web Publication Manifests to include this.
+ Setting the direction for a natural text value is currently not possible in
+ JSON-LD [[json-ld]]. In case the JSON-LD community, as well as the schema.org
+ community, introduces such a feature, future versions of this specification may extend the
+ ability of Web Publication Manifests to include this.
-
+ When using Web Publication manifests with bidirectional text, user agents SHOULD identify the
+ base direction of any given natural language value by scanning the text for the first strong
+ directional character. Once the base direction has been identified, user agents MUST
+ determine the appropriate rendering and display of natural language values according to the
+ Unicode Bidirectional Algorithm [[!bidi]]. This could require wrapping additional
+ control characters or markup around the string prior to display, in order to apply the base
+ direction. (See
+
+
dictionary LocalizableString {
required DOMString value;
DOMString language;
};
-
@@ -1960,50 +1900,43 @@ Last Modification Date
including the manifest ). It is expressed using the dateModified
property.
-
- Infoset Requirements
-
- The last modification date does not necessarily reflect all changes to the Web Publication
- (e.g., third-party content could change without the author being aware). User agents SHOULD
- check the last modification date of individual resources to determine if they have changed
- and need updating.
-
-
-
- Manifest Expression
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- dateModified
- Last modification date of the publication.
- A DateDateTime
-
- dateModifiedCreativeWork )
-
-
-
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ dateModified
+ Last modification date of the publication.
+ A DateDateTime
+
+ dateModifiedCreativeWork )
+
+
+
+
+ The last modification date does not necessarily reflect all changes to the Web Publication (e.g.,
+ third-party content could change without the author being aware). User agents SHOULD check the
+ last modification date of individual resources to determine if they have changed and need
+ updating.
-
+
partial dictionary WebPublicationManifest {
DOMString dateModified;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "TechArticle",
@@ -2015,7 +1948,6 @@ Manifest Expression
}
-
@@ -2026,48 +1958,41 @@ Publication Date
subsequent revisions to be identified and compared. It is expressed using the
datePublished property.
-
- Infoset Requirements
-
- The exact moment of publication is intentionally left open to interpretation: it could be
- when the Web Publication is first made available online or could be a point in time before
- publication when the Web Publication is considered final.
-
-
-
- Manifest Expression
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- datePublished
- Creation date of the publication.
- A DateDateTime
-
- datePublishedCreativeWork )
-
-
-
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ datePublished
+ Creation date of the publication.
+ A DateDateTime
+
+ datePublishedCreativeWork )
+
+
+
+
+ The exact moment of publication is intentionally left open to interpretation: it could be when
+ the Web Publication is first made available online or could be a point in time before
+ publication when the Web Publication is considered final.
-
+
partial dictionary WebPublicationManifest {
DOMString datePublished;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "TechArticle",
@@ -2079,7 +2004,6 @@ Manifest Expression
…
}
-
@@ -2089,55 +2013,47 @@ Reading Progression Direction
direction from one resource to the next within a Web Publication . It is expressed using
the readingDirection property.
-
- Infoset Requirements
-
- The value of this property may be:
-
-
- ltr rtl
-
- The default value is ltr.
-
- This infoset item has no effect on the rendering of the individual primary
- resources; it is only relevant for the progression direction from one resource to the
- other.
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ readingProgression
+ Reading direction from one resource to the other.
+ ltr or rtl(None)
+
+
+
+
+ The value of this property MUST be either:
+
+
+ ltr rtl
- The reading progression of a Web Publication is used to adapt such
- publication level interactions as menu position, swap direction, defining tap zones to lead
- the user to the next and previous pages, touch gestures, etc.
-
+ The default value is ltr.
-
- Manifest Expression
+ This property has no effect on the rendering of the individual primary resources; it is
+ only relevant for the progression direction from one resource to the other.
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- readingProgression
- Reading direction from one resource to the other.
- ltr or rtl(None)
-
-
-
+ The reading progression of a Web Publication is used to adapt such
+ publication level interactions as menu position, swap direction, defining tap zones to lead the
+ user to the next and previous pages, touch gestures, etc.
- If the readingProgression is not set, user agents MUST use the default value is
- ltr.
+ If the readingProgression is not set, user agents MUST use the default value
+ ltr when generating the canonical manifest.
-
+
partial dictionary WebPublicationManifest {
ProgressionDirection readingProgression = "ltr";
};
@@ -2147,7 +2063,7 @@ Manifest Expression
"rtl"
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2156,7 +2072,6 @@ Manifest Expression
"readingProgression" : "ltr"
}
-
@@ -2165,68 +2080,58 @@ Title
The title provides the human-readable name of the Web Publication . It is expressed using
the name property.
-
- Infoset Requirements
-
- The title is specified by the manifest expression , when
- present. If not included in the manifest, user agents MAY use the value of the title elementprimary
- entry page (if present) .
-
- Relying on the title element could be semantically problematic if
- the Web Publication consists of several HTML resources (e.g., one per chapter of a book),
- because the HTML definition defines this element as "metadata" for the enclosing HTML document,
- not for a collection of resources. Using this element is, on the other hand, preferred in
- the case of a publication consisting of a single HTML document (e.g., a scholarly journal
- article).
-
- When specified in the infoset non-empty .
-
- If a user agent requires a title and one is not available in the infoset , it MAY create one (e.g., provide a
- language-specific placeholder title or use the URL of the manifest).
-
- A user agent is not expected to produce a meaningful
- title [[wcag20]] for a Web Publication when one is not specified.
-
-
-
- Manifest Expression
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- name
- Human-readable title of the Web Publication.
- One or more text items for the title.
-
- nameThing )
-
-
-
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ name
+ Human-readable title of the Web Publication.
+ One or more text items for the title.
+
+ nameThing )
+
+
+
+
+ The title is specified by the manifest expression , when present. If not
+ included in the manifest, user agents MAY use the value of the title elementprimary entry
+ page (if present) when generating the canonical manifest.
+
+ Relying on the title element could be semantically problematic if the
+ Web Publication consists of several HTML resources (e.g., one per chapter of a book), because
+ the HTML
+ definition defines this element as "metadata" for the enclosing HTML document, not for a
+ collection of resources. Using this element is, on the other hand, preferred in the case of a
+ publication consisting of a single HTML document (e.g., a scholarly journal article).
+
+ When specified in the manifest, the title MUST be non-empty .
+
+ If a user agent requires a title and one is not available in the manifest, it MAY create one
+ (e.g., provide a language-specific placeholder title or use the URL of the manifest).
+
+ A user agent is not expected to produce a meaningful
+ title [[wcag20]] for a Web Publication when one is not specified.
-
+
partial dictionary WebPublicationManifest {
sequence<LocalizableString> name;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2235,7 +2140,6 @@ Manifest Expression
"name" : "Moby Dick"
}
-
@@ -2251,73 +2155,66 @@ Resource Categorization Properties
Note that a particular resource's URL MUST NOT appear in more than one of these lists, and a URL MUST
NOT be repeated within a list.
- The manifest itself MUST NOT include a reference to itself, i.e., the reference to the manifest MUST
- NOT appear within these lists.
+ The manifest itself MUST NOT include a reference to itself, i.e., the reference to the manifest MUST
+ NOT appear within these lists.
Default Reading Order
The default reading order is a specific progression through a set of Web
- Publication resources. It is expressed using the readingOrder property.
-
- A user might follow alternative pathways through the content, but in the absence of such
- interaction the default reading order defines the expected progression from one resource to the
- next.
-
-
- Infoset Requirements
-
- The default reading order MUST include at least one resource.
-
- The default reading order is specified directly in the manifest, but MAY be omitted when it
- only consists of the primary entry page . When the default reading order is absent,
- user agents MUST include an entry for the primary entry page when compiling the infoset.
-
-
-
- Manifest Expression
-
- If present in the Web Publication Manifest, this item MUST be mapped on the
- readingOrder term, defined specifically for Web Publications.
+ Publication resources. A user might follow alternative pathways through the content, but
+ in the absence of such interaction the default reading order defines the expected progression
+ from one resource to the next.
+
+ The default reading order is expressed using the readingOrder property.
+
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ readingOrder
+
+ An array of:
+
+ a string, representing the URL [[url]] of the resource; or
+ an instance of a PublicationLink
+
+ The order in the array is significant . The URLs MUST NOT include
+ fragment identifiers. Non-HTML resources SHOULD be expressed as
+ PublicationLink objects with their encodingFormat
+ values set.
+
+ (None)
+
+
+
+
+ The default reading order MUST include at least one resource.
+
+ The default reading order is specified directly in the manifest, but MAY be omitted when it only
+ consists of the primary entry page . When the default reading order is absent, user agents
+ MUST include an entry for the primary entry page when compiling the canonical manifest.
+
+ If present in the Web Publication Manifest, this item MUST be mapped on the
+ readingOrder term, defined specifically for Web Publications.
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- readingOrder
-
- An array of:
-
- a string, representing the URL [[url]] of the resource; or
- an instance of a PublicationLink
-
- The order in the array is significant . The URLs MUST NOT include
- fragment identifiers. Non-HTML resources SHOULD be expressed as
- PublicationLink objects with their
- encodingFormat values set.
-
- (None)
-
-
-
-
-
+
partial dictionary WebPublicationManifest {
required sequence<PublicationLink> readingOrder;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2334,7 +2231,7 @@ Manifest Expression
]
}
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2356,7 +2253,6 @@ Manifest Expression
}]
}
-
@@ -2366,65 +2262,54 @@ Resource List
in the processing and rendering of a Web Publication that are not already listed in the
default reading order . It is expressed using the resources property.
-
- Infoset Requirements
-
- The completeness of the resource list will affect the usability of the Web Publication in
- certain reading scenarios (e.g., the ability to read the Web Publication offline). For this
- reason, it is strongly RECOMMENDED to provide a comprehensive list of all of the Web
- Publication's constituent resources beyond those listed in the default reading
- order .
-
- In some cases, a comprehensive list of these resources might not be easily achieved (e.g.,
- third-party scripts that reference resources from deep within their source), but a user
- agent SHOULD still be able to render a Web Publication even if some of these resources are
- not identified as belonging to the Web Publication (e.g., when it is taken offline without
- them).
-
-
-
- Manifest Expression
-
- If present in the Web Publication Manifest, this item MUST be mapped on the
- resources term, defined specifically for Web Publications.
-
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- resources
-
- An array of:
-
- a string, representing the URL [[url]] of the resource; or
- an instance of a PublicationLink
-
- The order in the array is not significant . The URLs MUST NOT include
- fragment identifiers. It is RECOMMENDED to use PublicationLink
- objects with their encodingFormat values set.
-
- (None)
-
-
-
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ resources
+
+ An array of:
+
+ a string, representing the URL [[url]] of the resource; or
+ an instance of a PublicationLink
+
+ The order in the array is not significant . The URLs MUST NOT include
+ fragment identifiers. It is RECOMMENDED to use PublicationLink
+ objects with their encodingFormat values set.
+
+ (None)
+
+
+
+
+ The completeness of the resource list will affect the usability of the Web Publication in certain
+ reading scenarios (e.g., the ability to read the Web Publication offline). For this reason, it
+ is strongly RECOMMENDED to provide a comprehensive list of all of the Web Publication's
+ constituent resources beyond those listed in the default reading order .
+
+ In some cases, a comprehensive list of these resources might not be easily achieved (e.g.,
+ third-party scripts that reference resources from deep within their source), but a user agent
+ SHOULD still be able to render a Web Publication even if some of these resources are not
+ identified as belonging to the Web Publication (e.g., when it is taken offline without
+ them).
-
+
partial dictionary WebPublicationManifest {
sequence<PublicationLink> resources = [];
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "TechArticle",
@@ -2453,7 +2338,6 @@ Manifest Expression
}
-
@@ -2462,7 +2346,38 @@ Links
Links provide a list of resources that are not
required for the processing and rendering of a Web Publication (i.e., the content of the Web
Publication remains unaffected even if these resources are not available). They are expressed
- using the link property.
+ using the links property.
+
+
+
+
+ Term
+ Description
+ Required Value
+ [[!schema.org]] Mapping
+
+
+
+
+
+ links
+
+ An array of:
+
+ a string, representing the URL [[url]] of the resource; or
+ an instance of a PublicationLink
+
+ The order in the array is not significant . It is RECOMMENDED to use
+ PublicationLink objects with their encodingFormat
+ and rel values set.
+
+ (None)
+
+
+
Linked resources are typically made available to user agents to augment or enhance the processing
or rendering of it, such as:
@@ -2485,60 +2400,21 @@ Links
packaged (e.g., tracking scripts).
-
- Infoset Requirements
-
- The links list SHOULD include resources necessary to render a linked resource
- (e.g., scripts, images, style sheets).
-
- Resources listed in the links list MUST NOT be listed in the default reading order or resource list .
-
- User agents MAY ignore linked resources, and are not required to take them offline with a Web
- Publication. These resources SHOULD NOT be included when packaging a Web Publication.
-
+ The links list SHOULD include resources necessary to render a linked resource (e.g.,
+ scripts, images, style sheets).
-
- Manifest Expression
+ Resources listed in the links list MUST NOT be listed in the default reading order or resource
+ list .
-
-
-
- Term
- Description
- Required Value
- [[!schema.org]] Mapping
-
-
-
-
-
- links
-
- An array of:
-
- a string, representing the URL [[url]] of the resource; or
- an instance of a PublicationLink
-
- The order in the array is not significant . It is RECOMMENDED to use
- PublicationLink objects with their
- encodingFormat and rel values set.
-
- (None)
-
-
-
+ User agents MAY ignore linked resources, and are not required to take them offline with a Web
+ Publication. These resources SHOULD NOT be included when packaging a Web Publication.
-
+
partial dictionary WebPublicationManifest {
sequence<PublicationLink> links = [];
};
-
@@ -2557,37 +2433,29 @@ Accessibility Report
An accessibility report is identified using the
https://www.w3.org/ns/wp#accessibility-report link relationship.
-
- Infoset Requirements
-
- The infoset
-
- It is also RECOMMENDED that the accessibility report be provided in a human-readable format,
- such as HTML [[html]]. Augmenting these
- reports with machine-processable metadata, such as provided in Schema.org [[schema.org]], is
- also RECOMMENDED.
-
+ The manifest SHOULD include a link to an accessibility report when one is available for a Web
+ Publication. It is RECOMMENDED that the report be included as a resource of the Web
+ Publication.
-
- Manifest Expression
+ It is also RECOMMENDED that the accessibility report be provided in a human-readable format, such
+ as [[!html]]. Augmenting these reports with machine-processable metadata, such as provided in
+ Schema.org [[!schema.org]], is also RECOMMENDED.
- If present in the manifest, the accessibility report PublicationLinkrel
- value of the PublicationLinkhttps://www.w3.org/ns/wp#accessibility-report identifier.
+ If present in the manifest, the accessibility report PublicationLinkrel value
+ of the PublicationLinkhttps://www.w3.org/ns/wp#accessibility-report identifier.
- The Working Group will attempt to define the accessibility-report
- term with IANA, to avoid using a URL.
+ The Working Group will attempt to define the accessibility-report
+ term with IANA, to avoid using a URL.
-
+
partial dictionary WebPublicationManifest {
PublicationLink accessibilityReport;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2604,7 +2472,6 @@ Manifest Expression
…
}
-
@@ -2618,35 +2485,27 @@ Privacy Policy
A privacy policy is identified using the privacy-policy link relationship.
-
- Infoset Requirements
-
- A link to a privacy policy can be included in the infoset
-
- It is RECOMMENDED that the privacy policy be provided in a human-readable format, such as
- HTML [[html]].
+ A link to a privacy policy can be included in the manifest. It is RECOMMENDED that the privacy
+ policy be included as a resource of the Web Publication.
- Refer to
-
+ It is RECOMMENDED that the privacy policy be provided in a human-readable format, such as HTML [[html]].
-
- Manifest Expression
+ Refer to
- If present in the manifest, the privacy policy PublicationLinkrel
- value of the PublicationLinkprivacy-policy identifier [[!iana-link-relations]].
+ If present in the manifest, the privacy policy PublicationLinkrel value of
+ the PublicationLinkprivacy-policy identifier [[!iana-link-relations]].
-
+
partial dictionary WebPublicationManifest {
PublicationLink privacyPolicy;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "TechArticle",
@@ -2665,7 +2524,6 @@ Manifest Expression
…
}
-
@@ -2676,49 +2534,42 @@ Structural Properties
Cover
The cover is a resource that user agents can use to present the Web Publication
- (e.g., in a library or bookshelf, or when initially loading the Web Publication). It is
- identified by the https://www.w3.org/ns/wp#cover link relationship.
+ (e.g., in a library or bookshelf, or when initially loading the Web Publication).
+
+ The cover is identified by the https://www.w3.org/ns/wp#cover link relationship.
The working group has not reached consensus on whether the cover
should be any resource or should be limited to images.
-
- Infoset Requirements
+ The manfiest SHOULD include a reference to a cover.
- The infoset
+ More than one cover MAY be referenced from the manifest (e.g., to provide alternative formats and
+ sizes for different device screens). If multiple covers are specified, each instance MUST define
+ at least one unique property to allow user agents to determine its usability (e.g., a different
+ format, height, width or relationship).
- More than one cover MAY be referenced from the infoset (e.g., to provide alternative formats
- and sizes for different device screens). If multiple covers are specified, each instance
- MUST define at least one unique property to allow user agents to determine its usability
- (e.g., a different format, height, width or relationship).
-
-
-
- Manifest Expression
-
- If present in the manifest, the cover PublicationLinkurl term MUST NOT include a fragment identifier.
+ If present in the manifest, the cover PublicationLinkurl term MUST
+ NOT include a fragment identifier.
- The rel value of the PublicationLinkhttps://www.w3.org/ns/wp#cover identifier.
+ The rel value of the PublicationLinkhttps://www.w3.org/ns/wp#cover identifier.
- If the cover is in an image format, a title and description SHOULD
- be provided. User agents can use these properties to provide alternative text and
- descriptions when necessary for accessibility.
+ If the cover is in an image format, a title and description SHOULD be
+ provided. User agents can use these properties to provide alternative text and descriptions when
+ necessary for accessibility.
- The Working Group will attempt to define the cover term by IANA,
- to avoid using a URL.
+ The Working Group will attempt to define the cover term by IANA, to
+ avoid using a URL.
-
+
partial dictionary WebPublicationManifest {
sequence<PublicationLink> cover;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2737,7 +2588,7 @@ Manifest Expression
}
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2758,7 +2609,7 @@ Manifest Expression
}
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2781,72 +2632,64 @@ Manifest Expression
…
}
-
Page List
The pagelist property identifies the resource that contains the Web Publication's page list . It is identified by the
- https://www.w3.org/ns/wp#pagelist link relationship.
-
-
- Infoset Requirements
-
- User agents MUST compute the pagelist as follows:
+ href="#wp-pagelist">page list.
-
- Identify the page list resource:
-
- If the page list resource contains an HTML element with the
- role [[!html]] value
- doc-pagelist [[!dpub-aria-1.0]], the user agent MUST use that element
- as the page list. If there are several such HTML elements the user agent MUST use the
- first in document tree
- order [[!dom]].
-
+ The page list is identified by the https://www.w3.org/ns/wp#pagelist link
+ relationship.
- If this process does not result in a link to the page list, the Web Publication does not have
- a page list and this property MUST NOT be included in the infoset.
+ User agents MUST compute the pagelist as follows:
- The Working Group will attempt to define the pagelist term by
- IANA, to avoid using a URL.
+
+ Identify the page list resource:
+
+ If the page list resource contains an HTML element with the
+ role [[!html]] value doc-pagelist [[!dpub-aria-1.0]],
+ the user agent MUST use that element as the page list. If there are several such HTML
+ elements the user agent MUST use the first in document tree
+ order [[!dom]].
+
-
+ If this process does not result in a link to the page list, the Web Publication does not have a
+ page list and this property MUST NOT be included in the canonical manifest.
-
- Manifest Expression
+ The Working Group will attempt to define the pagelist term by IANA,
+ to avoid using a URL.
- If present in the manifest, the page list PublicationLinkurl term MUST NOT include a fragment identifier.
+ If present in the manifest, the page list PublicationLinkurl term MUST NOT include a fragment identifier.
- The rel value of the PublicationLinkhttps://www.w3.org/ns/wp#pagelist identifier.
+ The rel value of the PublicationLinkhttps://www.w3.org/ns/wp#pagelist identifier.
- The link to the page list MAY be specified in either the default reading order or resource-list , but MUST NOT
- be specified in both.
+ The link to the page list MAY be specified in either the default
+ reading order or resource-list , but MUST NOT be specified
+ in both.
-
+
partial dictionary WebPublicationManifest {
HTMLElement pagelist;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2863,74 +2706,66 @@ Manifest Expression
…
}
-
Table of Contents
The table of contents property identifies the resource that contains the Web Publication's table of contents . It is identified by the
- contents link relationship.
+ href="#wp-table-of-contents">table of contents.
-
- Infoset Requirements
+ The table of contents is identified by the contents link relationship.
- User agents MUST compute the toc as follows:
-
-
- Identify the table of contents resource:
-
- If the table of contents resource contains an HTML element with the
- role [[!html]] value doc-toc [[!dpub-aria-1.0]], the
- user agent MUST use that element as the table of contents. If there are several such
- HTML elements the user agent MUST use the first in document tree
- order [[!dom]].
-
+ User agents MUST compute the toc as follows:
- If this process does not result in a link to the table of contents, the Web Publication does
- not have a table of contents and this property MUST NOT be included in the infoset.
+
+ Identify the table of contents resource:
+
+ If the table of contents resource contains an HTML element with the
+ role [[!html]] value doc-toc [[!dpub-aria-1.0]], the
+ user agent MUST use that element as the table of contents. If there are several such HTML
+ elements the user agent MUST use the first in document tree
+ order [[!dom]].
+
- Depending on the resolution to this issue, the infoset might
- contain a separate entry for a machine-processable table of contents, restrictions could be
- placed on the HTML structure of the referenced table of contents, or parsing rules for
- extracting a table of contents could be added.
-
+ If this process does not result in a link to the table of contents, the Web Publication does not
+ have a table of contents and this property MUST NOT be included in the canonical manifest.
-
- Manifest Expression
+ Depending on the resolution to this issue, the manifest might
+ contain a separate entry for a machine-processable table of contents, restrictions could be
+ placed on the HTML structure of the referenced table of contents, or parsing rules for
+ extracting a table of contents could be added.
- If present in the manifest, the table of contents PublicationLinkurl term MUST NOT include a fragment identifier.
+ If present in the manifest, the table of contents PublicationLinkurl term MUST
+ NOT include a fragment identifier.
- The rel value of the PublicationLinkcontents
- identifier [[!iana-link-relations]].
+ The rel value of the PublicationLinkcontents
+ identifier [[!iana-link-relations]].
- The link to the table of contents MAY be specified in either the default reading order or resource-list , but MUST NOT be specified in both.
+ The link to the table of contents MAY be specified in either the default reading order or resource-list , but MUST NOT be
+ specified in both.
-
+
partial dictionary WebPublicationManifest {
HTMLElement toc;
};
-
+
{
"@context" : ["https://schema.org","https://www.w3.org/ns/wp-context"],
"type" : "Book",
@@ -2948,7 +2783,7 @@ Manifest Expression
}
-
+
<head>
…
<script type="application/ld+json">
@@ -2971,16 +2806,14 @@ Manifest Expression
…
</body>
-
Extensibility
- The infoset Web Publication , but MAY be
- extended in the following ways:
+ The manifest is designed to provide a basic set of properties for use by user agents in presenting
+ and rendering a Web Publication , but MAY be extended in the following ways:
by the provision of linked metadata records .
@@ -2988,10 +2821,10 @@ Extensibility
the manifest;
- Although both methods are valid, the use of linked records to extend the infoset is RECOMMENDED.
+ Although both methods are valid, the use of linked records is RECOMMENDED.
This specification does not define how such additional properties are compiled, stored or exposed by
- user agents in their internal representation of the infoset. A user agent MAY ignore some or all
+ user agents in their internal representation of the manifest. A user agent MAY ignore some or all
extended properties.
@@ -3010,7 +2843,7 @@ Linked records
Linked records MUST be included in the resource list when they are
- part of the Web Publication (i.e., are needed for more than just infoset extensibility).
+ part of the Web Publication (i.e., are needed for more than just manifest extensibility).
Otherwise, they MUST be included in the links list .
@@ -3033,7 +2866,7 @@ Linked records
The application/onix+xml MIME type has not yet been registered by
IANA at the time of writing this document, and is included in the example for illustrative
- purposes only.
+ purposes only.
@@ -3073,7 +2906,7 @@ Additional Properties in the Manifest
of [[schema.org]]. This means that it is not necessary to add the prefix explicitly. The same is
true for a number of other public vocabularies; see the schema.org context file for further
- details.
+ details.
@@ -3082,16 +2915,16 @@ Additional Properties in the Manifest
Web Publication Lifecycle
See the diagrams in the appendix for a visual
- representation of the lifecycle algorithm.
+ representation of the lifecycle algorithm.
Obtaining a manifest
- The steps for
- obtaining a manifest , starting from the primary entry page , are given by the
- following algorithm. The algorithm, if successful, returns a processed manifest ; otherwise,
- it terminates prematurely and returns nothing. In the case of nothing being returned, the user agent
- MUST ignore the manifest declaration.
+ The steps for obtaining
+ a manifest , starting from the primary entry page , are given by the following
+ algorithm. The algorithm, if successful, returns a processed manifest ; otherwise, it
+ terminates prematurely and returns nothing. In the case of nothing being returned, the user agent
+ MUST ignore the manifest declaration.
From the Document of the top-level browsing context of the primary entry
@@ -3169,24 +3002,14 @@ Obtaining a manifest
The algorithm does not describes how error and warning messages should be reported.
- This is implementation dependent.
+ This is implementation dependent.
Generating a Canonical Manifest
- A Canonical Web Publication
- Manifest (or Canonical Manifest) is a version of the Web Publication Manifest where
- all possible ambiguities on property values (see, e.g., primary entry page are incorporated. Using a Canonical Manifest when processing the manifest makes those processing steps, as well as
- the transformation of the manifest to programming language structures, clearer. Converting the
- Manifest into its canonical form is done when the manifest is obtained .
-
- The steps to convert a Web Publication Manifest into a Canonical Manifest are given by the following
+
The steps to convert a Web Publication Manifest into a Canonical Manifest are given by the following
algorithm. The algorithm takes the following arguments:
the manifest the JSON object that represent the manifest
@@ -3197,11 +3020,11 @@ Generating a Canonical Manifest
- The steps of the algorithm are described below. As an abuse of notation, P["term"] refers
+
The steps of the algorithm are described below. As an abuse of notation, P["term"] refers
to the value in the object P for the label "term" , where P is
either manifest , or an object appearing within manifest (e.g., a
Person ). The algorithm replaces or adds some terms to manifest ; the
- replacement terms are expressed in JSON syntax as {"term":"value"}.
+ replacement terms are expressed in JSON syntax as {"term":"value"}.
let lang string represent the default language, set to:
the value of the Generating a Canonical Manifest
See the diagram in the appendix for a
visual representation of the algorithm. Also, to help understanding the result of the algorithm,
there is a link to the corresponding canonical manifests for all the examples in
+ href="#app-manifest-examples"> .
Some open issues, either in this working group or in the
JSON-LD Working Group may modify some of the
details above. These are:
@@ -3319,12 +3142,12 @@ Generating a Canonical Manifest
Processing the manifest
- The steps for processing a
+ The steps for processing a
manifest are given by the following algorithm. The algorithm takes a json
object representing a canonical manifest . The output from inputting a JSON object into this
algorithm is a processed manifest . The goal of the algorithm is to ensure that the data
represented in json abides to the minimal requirements on the data, removing, if
- applicable, non-conformant data.
+ applicable, non-conformant data.
Let manifest object be the result of Processing the manifest
Return manifest object .
-
User Agent Features
@@ -3385,10 +3207,9 @@ Switch to publication mode
This feature has the following requirements:
- it MUST inform the user that the current resource is part of a Web Publication
- it SHOULD display the title of the Web Publication
- it MAY display additional metadata from the infoset
+ It MUST inform the user that the current resource is part of a Web Publication .
+ It SHOULD display the title of the Web Publication.
+ It MAY display additional metadata from the manifest.
Publication mode is a display mode implemented by the user agent that follows the
@@ -3597,21 +3418,21 @@
Table of Contents
Short description
- The user agent should provide access to the table of contents without leaving current
- resource from anywhere in the publication.
- For accessibility reasons, it is RECOMMENDED for User Agents to use a table of contents to
- allow multiple ways for users to access content.
+ The user agent should provide access to the table of contents without leaving current
+ resource from anywhere in the publication.
+ For accessibility reasons, it is RECOMMENDED for User Agents to use a table of contents to
+ allow multiple ways for users to access content.
Affordances
- The table of contents is a listed as a structural property in the infoset, see The table of contents is a listed as a structural property in the manifest, see
- The table of content is referred to in the Web Publication Manifest (see
- User agents MAY use the default reading order in the case a Table of Contents is not
- explicitly specified to create a table of contents.
+ The table of content is referred to in the Web Publication Manifest (see
+ User agents MAY use the default reading order in the case a Table of Contents is not
+ explicitly specified to create a table of contents.
Use Case References
@@ -3650,35 +3471,35 @@ Reading State
Short description
- The user must be able to leave the Web Publication and return to it at the last position they
+
The user must be able to leave the Web Publication and return to it at the last position they
left from. The User Agent must retain the reading position, based on the last known position of
the reader in the web publication. The position should be based on the reader's position in the
- file, within the reading order.
- The user agent may retain reading state if the web publication is revised.
+ file, within the reading order.
+ The user agent may retain reading state if the web publication is revised.
Affordances
- The navigation of the web publication should be defined in the Default Reading Order
- required by the Information Set.
- User Agents should not have to set the reading state in the following type of resources:
+ The navigation of the web publication should be defined in the required Default Reading
+ Order .
+ User Agents should not have to set the reading state in the following type of resources:
External Links (i.e. a link to google.com)
Data references (i.e. a linked CSV file)
Multimedia content (i.e. a video)
- Reading state should only apply to content documents listed as being within the bounds of the
- Web Publication.
+ Reading state should only apply to content documents listed as being within the bounds of the Web
+ Publication.
Examples
- Example 1:
Example 1:
+ reading state for the next time she opens the publication.
Testing
- If a tester opens a web publication in a WP-aware UA, moves ahead in the publication, closes the
- reader, then reopens it, they should be returned to the last known reading state.
+ If a tester opens a web publication in a WP-aware UA, moves ahead in the publication, closes the
+ reader, then reopens it, they should be returned to the last known reading state.
@@ -3687,7 +3508,7 @@ Web Publication Locators
The document referred from this section, i.e., Web Annotation Extensions for Web
Publications [[wpub-ann]], has been recently renamed. Its previous was "Locators for Web
- Publication". The terminology used in this section has to be realigned with the name change.
+ Publication". The terminology used in this section has to be realigned with the name change.
Locators are used to identify, locate, retrieve, and/or reference locations and content fragments within
Web Publications (e.g., for address(es), bookmarks, and annotations). Locators traditionally
@@ -3729,15 +3550,14 @@
Web Publication Locators
way to identify and reference a location within a Web Publication (i.e., as distinct from identifying
and referencing a content fragment consisting of a span of characters or bytes). A Web Publication
Locator can be used to identify, retrieve and/or reference a fragment of a Web Publication that spans
- multiple resources.
+ multiple resources.
In composing a Web Publication Locator, use the canonical identifier of the Web Publication in
preference to any alternative addresses. Such use facilitates the collation of Web Publication
Locators associated with a particular Web Publication. URLs of Web Publication resources appearing in a Web Publication Locator should match
- the URL of the resource provided in the infoset
+ the
URL of the resource provided in the manifest.
@@ -3934,19 +3754,18 @@ Cleaning up the data
Image Descriptions
- Description for the “Structure of Web Publications”
+ Description for the "Structure of Web Publications"
diagram :
A simplified diagram of the structure of a Web Publication . The Web Publication is broken
down into two elements. The first element is the actual contents (all the real things listed in the
- manifest). This element is broken down into the CSS, the actual “things” such as the HTML documents, audio, etc, and the images, fonts etc.
- The actual “things” have an additional subset of items that includes the entry page to the
+ The actual "things" have an additional subset of items that includes the entry page to the
publication and all of the other documents. The second element is the Manifest (JSON). The manifest
- is used to generate the Information Set (“Infoset”) , which
- consists of a list of all the “things” in the publication, the publication metadata, and the default
- reading order of content. It is noted in the diagram that the entry page has to link to the
- manifest. (Return to the diagram of Web
- Publication.)
+ is used to generate the canonical manifest, which consists of a list of all the "things" in the
+ publication, the publication metadata, and the default reading order of content. It is noted in the
+ diagram that the entry page has to link to the manifest. ( Return to the diagram of Web Publication.)
diff --git a/snapshot/images/clean_up_data.png b/snapshot/images/clean_up_data.png
index b28eb62..4e7db7f 100644
Binary files a/snapshot/images/clean_up_data.png and b/snapshot/images/clean_up_data.png differ
diff --git a/snapshot/images/clean_up_data.svg b/snapshot/images/clean_up_data.svg
index e62a053..e95e26e 100644
--- a/snapshot/images/clean_up_data.svg
+++ b/snapshot/images/clean_up_data.svg
@@ -1 +1 @@
-