Skip to content

Add comment role #1135

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

Merged
merged 19 commits into from
Feb 11, 2020
Merged

Add comment role #1135

Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
d20851c
Add comment role
Dec 11, 2019
7eef5ed
Improvements
Jan 14, 2020
59a1cbf
Keep empty td on one line
Jan 15, 2020
306929d
Better wording
Jan 15, 2020
4203687
Update index.html
aleventhal Jan 15, 2020
559e9a7
Update index.html
aleventhal Jan 15, 2020
46a3354
Update index.html
aleventhal Jan 15, 2020
52bb688
Update index.html
aleventhal Jan 15, 2020
c65afd8
Slight improvement to ancestor language
Jan 16, 2020
415c17c
Update inheritance, name, supported properties
Jan 16, 2020
d29a1e7
Remove prohibited aria-label* properties
Jan 16, 2020
eb690b9
Update index.html
aleventhal Jan 27, 2020
4a484cb
Less restrictive summary
Jan 27, 2020
bbadb71
Reworded, inspired by mck
Jan 27, 2020
4e735be
Update index.html
aleventhal Jan 28, 2020
157e90d
Update index.html
aleventhal Jan 28, 2020
6ed859a
Use group or region for comment container
Jan 30, 2020
2ad3609
Turn group/region role request for comment container into a SHOULD
Jan 30, 2020
75a6436
Update index.html
aleventhal Feb 6, 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
102 changes: 102 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,7 @@ <h3>Document Structure Roles</h3>
<li><rref>caption</rref></li>
<li><rref>cell</rref></li>
<li><rref>columnheader</rref></li>
<li><rref>comment</rref></li>
<li><rref>definition</rref></li>
<li><rref>deletion</rref></li>
<li><rref>directory</rref></li>
Expand Down Expand Up @@ -2327,6 +2328,107 @@ <h2>Definition of Roles</h2>
</tbody>
</table>
</div>
<div class="role" id="comment">
<rdef>comment</rdef>
<div class="role-description">
<p>A comment contains content expressing reaction to other content.</p>
<p>Comments can annotate any visible content, from small spans of text, to other comments, to entire articles. Authors SHOULD identify the relationships between comments and the commented content, as follows:</p>
<ol>
<li>If the comment is a reply to another <code>comment</code>:
<ul>
<li>If all ancestor comments are available in the DOM, make each reply <code>comment</code> a semantic descendant of the <code>comment</code> to which it is replying, either by making it a DOM descendant element or by using <pref>aria-owns</pref>.</li>
<li>Alternatively, if all ancestor comments are not in the DOM, such as when comments are paginated, the hierarchical
level MAY be indicated via <pref>aria-level</pref>. Additional group positional information MAY be indicated via <pref>aria-posinset</pref> and <pref>aria-setsize</pref>.</li>
</ul>
</li>
<li>Otherwise, if the comment relates to other content in the page:
<ul>
<li>Provide <pref>aria-details</pref> on the element containing the commented content with a value refering to the element with role <code>comment</code>.</li>
<li>If there are multiple comments related to the same commented content, either provide a value for <pref>aria-details</pref> on the commented content that refers to each individual comment, or use <pref>aria-details</pref> to refer to a parent container of the comments. If <pref>aria-details</pref> refers to an element containing comments rather than <code>comment</code> elements, authors SHOULD assign a role of <rref>group</rref> or <rref>region</rref> to the referenced container.</li>
</ul>
</li>
</ol>
<p>If the author has not explicitly declared <pref>aria-level</pref>, <pref>aria-posinset</pref>, or <pref>aria-setsize</pref> for a <code>comment</code> element, user agents MUST automatically compute the missing values and expose them to assistive technologies.</p>
</div>
<table class="role-features">
<caption>Characteristics:</caption>
<thead>
<tr>
<th scope="col">Characteristic</th>
<th scope="col">Value</th>
</tr>
</thead>
<tbody>
<tr>
<th class="role-abstract-head" scope="row">Is Abstract:</th>
<td class="role-abstract"> </td>
</tr>
<tr>
<th class="role-parent-head" scope="row">Superclass Role:</th>
<td class="role-parent"><rref>article</rref></td>
</tr>
<tr>
<th class="role-base-head" scope="row">Base Concept:</th>
<td class="role-base"> </td>
</tr>
<tr>
<th class="role-related-head" scope="row">Related Concepts:</th>
<td class="role-related"> </td>
</tr>
<tr>
<th class="role-scope-head" scope="row">Required Context Role:</th>
<td class="role-scope"> </td>
</tr>
<tr>
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
<td class="role-mustcontain"> </td>
</tr>
<tr>
<th class="role-required-properties-head">Required States and Properties:</th>
<td class="role-required-properties"> </td>
</tr>
<tr>
<th class="role-properties-head" scope="row">Supported States and Properties:</th>
<td class="role-properties">
<ul>
<li><pref>aria-level</pref></li>
<li><pref>aria-posinset</pref></li>
<li><pref>aria-setsize</pref></li>
</ul>
</td>
</tr>
<tr>
<th class="role-inherited-head" scope="row">Inherited States and Properties:</th>
<td class="role-inherited">Placeholder</td>
</tr>
<tr>
<th class="role-namefrom-head" scope="row">Name From:</th>
<td class="role-namefrom">
<ul>
<li>contents</li>
<li>author</li>
</ul>
</td>
</tr>
<tr>
<th class="role-namerequired-head" scope="row">Accessible Name Required:</th>
<td class="role-namerequired"> </td>
</tr>
<tr>
<th class="role-namerequired-inherited-head" scope="row">Inherits Name Required:</th>
<td class="role-namerequired-inherited"> </td>
</tr>
<tr>
<th class="role-childpresentational-head" scope="row">Children Presentational:</th>
<td class="role-childpresentational"> </td>
</tr>
<tr>
<th class="role-presentational-inherited-head" scope="row">Inherits Presentational:</th>
<td class="role-presentational-inherited"> </td>
</tr>
</tbody>
</table>
</div>
<div class="role" id="complementary">
<rdef>complementary</rdef>
<div class="role-description">
Expand Down