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

deprecate doc-biblioentry and doc-endnote #22

Merged
merged 5 commits into from
Sep 15, 2020
+32 −59
Merged

deprecate doc-biblioentry and doc-endnote #22

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0b284da
deprecate doc-biblioentry and doc-endnote and remove required parent/…
mattgarrish Jul 23, 2020
9de0b33
Merge branch 'master' into deprecate/required-children
mattgarrish Jul 23, 2020
5321e28
ignore - testing pr preview
mattgarrish Jul 23, 2020
8e2daa4
Merge branch 'deprecate/required-children' of https://github.com/w3c/…
mattgarrish Jul 23, 2020
c20b561
Merge branch 'master' into deprecate/required-children
mattgarrish Sep 15, 2020
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
91 changes: 32 additions & 59 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,29 +701,15 @@ <h2>Definition of Roles</h2>
<div class="role">
<rdef>doc-biblioentry</rdef>
<div class="role-description">
<p>A single reference to an external source in a bibliography. A biblioentry typically provides
more detailed information than its reference(s) in the content (e.g., full title, author(s),
publisher, publication date, etc.).</p>
<p>Authors MUST ensure that <a>elements</a> with role <code>doc-biblioentry</code> are contained
in, or owned, by an element with the role <rref>list</rref>.</p>
<pre class="example highlight">&lt;section role="doc-bibliography"&gt;
&lt;h1&gt;Cited Works&lt;/h1&gt;
&lt;div role="list"&gt;
&lt;p role="doc-biblioentry" id="b8cab5dd-bc24-459c-9858-7afa9da69b64"&gt;
John Steinbeck, The Grapes of Wrath (New York: The Viking Press, 1939)
&lt;/p&gt;
&lt;/div&gt;
&#8230;
&lt;/section&gt;</pre>
<pre class="example highlight">&lt;section role="doc-bibliography"&gt;
&lt;h1&gt;Select Bibliography&lt;/h1&gt;
&lt;ul&gt;
&lt;li role="doc-biblioentry" id="faulkner-dying"&gt;
William Faulkner, As I Lay Dying (New York: Jonathan Cape &amp; Harrison Smith, 1930)
&lt;/li&gt;
&lt;/ul&gt;
&#8230;
&lt;/section&gt;</pre>
<p>[Deprecated in DPUB-ARIA 1.1] A single reference to an external source in a bibliography. A
biblioentry typically provides more detailed information than its reference(s) in the content
(e.g., full title, author(s), publisher, publication date, etc.).</p>
<p class="note">The <code>doc-biblioentry</code>
<a>role</a> was designed for use as a list item, but due to clarifications in the WAI-ARIA
specification, it is not valid as a child of the <rref>list</rref> role. As the
<rref>doc-bibliography</rref> role already identifies a section of bibliography entries, authors
are instead advised to use the <rref>list</rref> and <rref>listitem</rref> roles when native HTML
elements cannot be used to structure the entries.</p>
</div>
<table class="role-features">
<caption>Characteristics:</caption>
Expand All @@ -740,7 +726,7 @@ <h2>Definition of Roles</h2>
</tr>
<tr>
<th class="role-parent-head" scope="row">Superclass Role:</th>
<td class="role-parent"><rref>listitem</rref></td>
<td class="role-parent"> </td>
</tr>
<tr>
<th class="role-children-head" scope="row">Subclass Roles:</th>
Expand All @@ -758,7 +744,7 @@ <h2>Definition of Roles</h2>
</tr>
<tr>
<th class="role-scope-head" scope="row">Required Context Role:</th>
<td class="role-scope"><rref>doc-bibliography</rref></td>
<td class="role-scope"> </td>
</tr>
<tr>
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
Expand Down Expand Up @@ -852,7 +838,7 @@ <h2>Definition of Roles</h2>
</tr>
<tr>
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
<td class="role-mustcontain"><rref>doc-biblioentry</rref></td>
<td class="role-mustcontain"> </td>
</tr>
<tr>
<th class="role-required-properties-head">Required States and Properties:</th>
Expand Down Expand Up @@ -1595,33 +1581,15 @@ <h2>Definition of Roles</h2>
<div class="role">
<rdef>doc-endnote</rdef>
<div class="role-description">
<p>One of a collection of notes that occur at the end of a work, or a section within it, that
provides additional context to a referenced passage of text.</p>
<p>Authors MUST ensure that <a>elements</a> with <a>role</a>
<code>doc-endnote</code> are contained in, or owned, by an element with the role
<rref>list</rref>.</p>
<pre class="example highlight">&lt;section role="doc-endnotes"&gt;
&lt;h2&gt;Notes&lt;/h2&gt;
&lt;ol&gt;
&lt;li id="6baa07af" role="doc-endnote"&gt;Additional results of this study can be found at &#8230; &lt;/li&gt;
&lt;li id="7b2c0555" role="doc-endnote"&gt;&#8230;&lt;/li&gt;
&#8230;
&lt;/ol&gt;
&lt;/section&gt;</pre>
<pre class="example highlight">&lt;section role="doc-endnotes"&gt;
&lt;h2&gt;Notes&lt;/h2&gt;
&lt;section id="ch1-notes"&gt;
&lt;h3&gt;Chapter 1&lt;/h3&gt;
&lt;div role="list"&gt;
&lt;p id="6baa07af" role="doc-endnote"&gt;1. Additional results of this study can be found at &#8230; &lt;/p&gt;
&lt;div id="7b2c0555" role="doc-endnote"&gt;
&lt;p&gt;2. The primary source of information &#8230;&lt;/p&gt;
&lt;p class="note-cont"&gt;In the case of secondary studies &#8230;&lt;/p&gt;
&lt;/div&gt;
&#8230;
&lt;/div&gt;
&lt;/section&gt;
&lt;/section&gt;</pre>
<p>[Deprecated in DPUB-ARIA 1.1] One of a collection of notes that occur at the end of a work, or a
section within it, that provides additional context to a referenced passage of text.</p>
<p class="note">The <code>doc-endnote</code>
<a>role</a> was designed for use as a list item, but due to clarifications in the WAI-ARIA
specification, it is not valid as a child of the <rref>list</rref> role. As the
<rref>doc-endnotes</rref> role already identifies a section of endnotes, authors are instead
advised to use the <rref>list</rref> and <rref>listitem</rref> roles when native HTML elements
cannot be used to structure the entries. The <rref>doc-footnote</rref> role can be used within each
list item to identify individual notes when necessary.</p>
</div>
<table class="role-features">
<caption>Characteristics:</caption>
Expand Down Expand Up @@ -1656,7 +1624,7 @@ <h2>Definition of Roles</h2>
</tr>
<tr>
<th class="role-scope-head" scope="row">Required Context Role:</th>
<td class="role-scope"><rref>doc-endnotes</rref></td>
<td class="role-scope"> </td>
</tr>
<tr>
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
Expand Down Expand Up @@ -1706,13 +1674,16 @@ <h2>Definition of Roles</h2>
<div class="role-description">
<p>A collection of notes at the end of a work or a section within it.</p>
<p>Note that the <code>doc-endnotes</code>
<a>role</a> is never applied directly to the list of endnotes. See the
<rref>doc-endnote</rref> role for more information.</p>
<a>role</a> is never applied directly to the list of endnotes.</p>
<pre class="example highlight">&lt;section role="doc-endnotes"&gt;
&lt;h2&gt;Notes&lt;/h2&gt;
&lt;ol&gt;
&lt;li id="6baa07af" role="doc-endnote"&gt;Additional results of this study can be found at &#8230; &lt;/li&gt;
&lt;li id="7b2c0555" role="doc-endnote"&gt;&#8230;&lt;/li&gt;
&lt;li id="6baa07af"&gt;
&lt;p role="doc-footnote"&gt;Additional results of this study can be found at &#8230; &lt;/p&gt;
&lt;/li&gt;
&lt;li id="7b2c0555"&gt;
&lt;p role="doc-footnote"&gt;&#8230;&lt;/p&gt;
&lt;/li&gt;
&#8230;
&lt;/ol&gt;
&lt;/section&gt;</pre>
Expand Down Expand Up @@ -1754,7 +1725,7 @@ <h2>Definition of Roles</h2>
</tr>
<tr>
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
<td class="role-mustcontain"><rref>doc-endnote</rref></td>
<td class="role-mustcontain"> </td>
</tr>
<tr>
<th class="role-required-properties-head">Required States and Properties:</th>
Expand Down Expand Up @@ -3962,6 +3933,8 @@ <h2>Substantive changes since the <a href="https://www.w3.org/TR/dpub-aria-1.0/"
<li>25-July-2020: Recommend that doc-pagebreak name be end user-consumable.</li>
<li>24-July-2020: Changed the superclass of <rref>doc-example</rref> to <rref>figure</rref> to
make compatible with use on HTML figure.</li>
<li>23-July-2020: Deprecated the <rref>doc-biblioentry</rref> and <rref>doc-endnote</rref> roles due to
the inability of them to be recognized as children of <rref>list</rref>.</li>
</ul>
</section>
<!-- <section>
Expand Down