Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rewording of title and language #49

Closed
wants to merge 8 commits into from
Closed

rewording of title and language #49

Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fa7a06b
Merge pull request #1 from w3c/master
mattgarrish Aug 24, 2017
30ff6da
updating title and language to separate harvested data from fallback …
mattgarrish Aug 24, 2017
25074b7
add json properties to non-empty list
mattgarrish Aug 24, 2017
609ff29
remove potential ambiguity about title being non-empty and also only …
mattgarrish Aug 25, 2017
4e99c11
clarify language requirements apply when specified
mattgarrish Aug 25, 2017
850852d
remove link made redundant from recent shuffling
mattgarrish Aug 25, 2017
8214e2e
updates to language per Ivan's comments
mattgarrish Aug 25, 2017
744c951
adjust title to make harvesting part of fallback
mattgarrish Aug 25, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 61 additions & 41 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,13 @@ <h3>Terminology</h3>
and a <a>default reading order</a>.</p>
</dd>

<dt><dfn>Non-empty</dfn></dt>
<dd>
<p>For the purposes of this specification, non-empty is used to refer to an element, attribute or
property whose text content or value consists of one or more characters after whitespace
normalization, where whitespace normalization rules are defined per the host format.</p>
</dd>

<dt><dfn data-lt="Primary Resources">Primary Resource</dfn></dt>
<dd>
<p>A primary resource is one that is presented directly by a user agent (i.e., not embedded within
Expand Down Expand Up @@ -288,18 +295,18 @@ <h3>Requirements</h3>
<p>The Web Publication infoset MUST include the following information:</p>

<ul>
<li>The <a href="#title">title</a> (or "name") of the Web Publication.</li>
<li>The <a href="#language">default (natural) language</a> of the Web Publication.</li>
<li>The <a href="#address">address</a> of the Web Publication.</li>
<li>The <a href="#resources">Web Publication resources</a>.</li>
<li>The <a href="#default-reading-order">default reading order</a> of the Web Publication.</li>
<li>The <a href="#wp-address">address</a> of the Web Publication.</li>
<li>The <a href="#wp-resources">Web Publication resources</a>.</li>
<li>The <a href="#wp-default-reading-order">default reading order</a> of the Web Publication.</li>
</ul>

<p>In addition, the infoset SHOULD include the following information:</p>

<ul>
<li>A <a href="#canonical-identifier">canonical identifier</a>.</li>
<li>The <a href="#table-of-contents">table of contents</a>.</li>
<li>The <a href="#wp-title">title</a> (or "name") of the Web Publication.</li>
<li>The <a href="#wp-language">default (natural) language</a> of the Web Publication.</li>
<li>A <a href="#wp-canonical-identifier">canonical identifier</a>.</li>
<li>The <a href="#wp-table-of-contents">table of contents</a>.</li>
</ul>

<p class="ednote">These requirements reflect the current minimum consensus, though a number of issues remain
Expand All @@ -315,28 +322,32 @@ <h3>Requirements</h3>
<!-- <p class = "issue" data-number="30">Should Title be Required for the Publication for WCAG 2 Compliance?</p> -->
</section>

<section id="title">
<section id="wp-title">
<h3>Title</h3>

<p>The Web Publication's infoset requires a title.</p>
<p>The title provides the human-readable name of the Web Publication.</p>

<p>If a title is not specified in the <a href="#manifest">manifest</a>, the user agent MUST provide one as
follows:</p>
<p>When specified in the manifest, the title MUST be <a>non-empty</a>.</p>

<ol>
<li>If the Web Publication contains at least one primary resource whose media type includes a
<code>title</code> element (e.g., SVG or HTML), use the title of the first instance listed in the
default reading order.</li>
<li>If the preceding step results in an empty title, or no primary resources are recognized as having a
title, the user agent MUST use its own algorithm to produce a title (e.g., inspect subsequent primary
resources or provide a placeholder title).</li>
</ol>
<p>The title MAY be omitted from the manifest when the first resource in the default reading order contains a
<a>non-empty</a>
<code>title</code> (e.g., an HTML or SVG document). In this case, a user agent MUST add this title to the
infoset.</p>

<p>If a user agent requires a title and one is not available in the compiled infoset, it MAY define one. This
specification does not mandate how such a title is created. The user agent might:</p>

<ul>
<li>use the non-empty title of a subsequent primary resource in the default reading order;</li>
<li>provide a language-specific placeholder title (e.g., 'Untitled Publication');</li>
<li>use the URL of the manifest;</li>
<li>calculate a title using its own algorithm.</li>
</ul>

<div class="note">
<p>A user agent may not be able to produce a <a
<p>A user agent is not expected to produce a <a
href="https://www.w3.org/TR/WCAG20/#navigation-mechanisms-title">meaningful title</a> [[WCAG20]]
for a Web Publication based on the above rules. Authors are encouraged to ensure that their manifest
contains such a title, or one is provided in one of the two steps above.</p>
for a Web Publication when one is not specified.</p>
</div>

<div class="issue" data-number="20">
Expand All @@ -348,22 +359,31 @@ <h3>Title</h3>
</div>
</section>

<section id="language">
<section id="wp-language">
<h3>Language</h3>

<p>The Web Publication's infoset requires the language(s) of its content be specified. The language MUST be a
tag that conforms to [[!BCP47]] or its successors.</p>
<p>The language specified in the Web Publication's infoset identifies the natural language of its
content.</p>

<p>If the language is not specified in the <a href="#manifest">manifest</a>, the user agent MUST provide one
as follows:</p>
<p>This language is not used in the processing or rendering of the Web Publication, and is
<strong>not</strong> a replacement for identifying the language of each resource as defined by its
format. It instead allows a user agent to ability to provide supplementary enhancements, such as the
ability to download a custom dictionary or the preload a language-specific text-to-speech module.</p>

<ol>
<li>If the Web Publication contains at least one primary resource whose media type allows the language to
be specified (e.g., SVG or HTML), use the language of the first instance listed in the default
reading order.</li>
<li>If the preceding step results in an empty language tag, use the value "<code>und</code>"
(undetermined).</li>
</ol>
<p>When specified, the language MUST be a tag that conforms to [[!BCP47]] or its successors.</p>

<p>In the case of a multilingual Web Publication, the language declaration can be repeated.</p>

<p>If a user agent requires the language and one is not available in the compiled infoset, it MAY attempt to
determine the language. This specification does not mandate how such a language tag is created. The user
agent might:</p>

<ul>
<li>use the <a>non-empty</a> language declaration of the first primary resource in the default reading
order that provides one;</li>
<li>use the value "<code>und</code>" (undetermined);</li>
<li>calculate the language using its own algorithm.</li>
</ul>

<div class="issue" data-number="29">
<p>The question is whether the manifest MUST include the language(s) of the content or not.</p>
Expand All @@ -372,7 +392,7 @@ <h3>Language</h3>
</div>
</section>

<section id="canonical-identifier">
<section id="wp-canonical-identifier">
<h3>Canonical Identifier</h3>

<p>A <a>Web Publication's</a> canonical identifier is an <a>identifier</a> assigned to it by the publisher.
Expand All @@ -386,7 +406,7 @@ <h3>Canonical Identifier</h3>
<p>If assigned, this canonical identifier MUST be unique to the <a>Web Publication</a>.</p>
</section>

<section id="address">
<section id="wp-address">
<h3>Address</h3>

<p>A Web Publication's address is a <a>URL</a> that refers to a <a>Web Publication</a> and enables the
Expand All @@ -395,11 +415,11 @@ <h3>Address</h3>
<p>The availability of this address does not preclude the creation and use of other identifiers and/or
addresses to retrieve a representation of a <a>Web Publication</a> in whole or part.</p>

<div class="note">The Web Publication's <a href="#pub-address">address</a> can also be used as value for an
identifier link relation [[link-relation]].</div>
<div class="note">The Web Publication's address can also be used as value for an identifier link relation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have a canonical identifier, it probably makes more sense to use the canonical identifier instead of the address in link@rel="identifier".

The identifier value is just a proposal at this point, not sure that we should talk about it at all.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you open as a new issue? I'm working on consolidating the three PRs and reverting the defs so will be closing these off shortly.

[[link-relation]].</div>
</section>

<section id="resources">
<section id="wp-resources">
<h3>Resources</h3>

<p>The infoset MUST include a list of the <a>primary resources</a> of the Web Publication, regardless of
Expand All @@ -417,13 +437,13 @@ <h3>Resources</h3>
resources</a> or not.</p>
</section>

<section id="default-reading-order">
<section id="wp-default-reading-order">
<h3>Default Reading Order</h3>

<p>The default reading order MUST include at least one <a>primary resource</a>.</p>
</section>

<section id="table-of-contents">
<section id="wp-table-of-contents">
<h3>Table of Contents</h3>

<div class="ednote">Placeholder for identifying table of contents - whether embedded or by reference.</div>
Expand Down