Skip to content

Commit 2a047fd

Browse files
aleventhalcarmacleodmcking65
authored
Add suggestion role (#1134)
* Relates to ARIA Annotations, issue #749 Co-Authored-By: Carolyn MacLeod <[email protected]> Co-Authored-By: Matt King <[email protected]>
1 parent 6b168c0 commit 2a047fd

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed

index.html

+102
Original file line numberDiff line numberDiff line change
@@ -670,6 +670,7 @@ <h3>Document Structure Roles</h3>
670670
<li><rref>separator</rref> (when not focusable)</li>
671671
<li><rref>strong</rref></li>
672672
<li><rref>subscript</rref></li>
673+
<li><rref>suggestion</rref></li>
673674
<li><rref>superscript</rref></li>
674675
<li><rref>table</rref></li>
675676
<li><rref>term</rref></li>
@@ -8394,6 +8395,107 @@ <h5>Presentational Roles Conflict Resolution</h5>
83948395
</tbody>
83958396
</table>
83968397
</div>
8398+
<div class="role" id="suggestion">
8399+
<rdef>suggestion</rdef>
8400+
<div class="role-description">
8401+
<p>A single proposed change to content.</p>
8402+
<p>For example, in an editing system that supports multiple users, one user may suggest a change, and another user would be responsible
8403+
for accepting or rejecting the suggestion.</p>
8404+
<p>Authors MUST ensure that a <code>suggestion</code> contains either one <rref>insertion</rref> child or one <rref>deletion</rref> child or ensure that it contains two children where one is an <rref>insertion</rref> and the other is a <rref>deletion</rref>. Authors MUST ensure a <code>suggestion</code> does not contain any other children.</p>
8405+
<p>Authors MAY use <pref>aria-details</pref> or <pref>aria-description</pref> to associate the <code>suggestion</code> with related information such as comments, authoring info, and time stamps.</p>
8406+
<pre class="example highlight">
8407+
&lt;p&gt;
8408+
The best pet is a
8409+
&lt;span role="suggestion"&gt;
8410+
&lt;span role="deletion"&gt;cat&lt;/span&gt;
8411+
&lt;span role="insertion"&gt;dog&lt;/span&gt;
8412+
&lt;/span&gt;
8413+
&lt;/p&gt;
8414+
</pre>
8415+
<p>When a suggestion is accepted, authors SHOULD remove the <code>suggestion</code> role, indicating that the proposed revision has been made.
8416+
After the <code>suggestion</code> role is removed, child <rref>insertion</rref> and <rref>deletion</rref> elements can either be retained to document the revision or replaced with the revised content.
8417+
</p>
8418+
</div>
8419+
<table class="role-features">
8420+
<caption>Characteristics:</caption>
8421+
<thead>
8422+
<tr>
8423+
<th scope="col">Characteristic</th>
8424+
<th scope="col">Value</th>
8425+
</tr>
8426+
</thead>
8427+
<tbody>
8428+
<tr>
8429+
<th class="role-abstract-head" scope="row">Is Abstract:</th>
8430+
<td class="role-abstract"> </td>
8431+
</tr>
8432+
<tr>
8433+
<th class="role-parent-head" scope="row">Superclass Role:</th>
8434+
<td class="role-parent"><rref>section</rref></td>
8435+
</tr>
8436+
<tr>
8437+
<th class="role-base-head" scope="row">Base Concept:</th>
8438+
<td class="role-base"> </td>
8439+
</tr>
8440+
<tr>
8441+
<th class="role-related-head" scope="row">Related Concepts:</th>
8442+
<td class="role-related"> </td>
8443+
</tr>
8444+
<tr>
8445+
<th class="role-scope-head" scope="row">Required Context Role:</th>
8446+
<td class="role-scope"> </td>
8447+
</tr>
8448+
<tr>
8449+
<th class="role-mustcontain-head" scope="row">Required Owned Elements:</th>
8450+
<td class="role-mustcontain">
8451+
<li><rref>insertion</rref></li>
8452+
<li><rref>deletion</rref></li>
8453+
</td>
8454+
</tr>
8455+
<tr>
8456+
<th class="role-required-properties-head">Required States and Properties:</th>
8457+
<td class="role-required-properties"> </td>
8458+
</tr>
8459+
<tr>
8460+
<th class="role-properties-head" scope="row">Supported States and Properties:</th>
8461+
<td class="role-properties"> </td>
8462+
</tr>
8463+
<tr>
8464+
<th class="role-inherited-head" scope="row">Inherited States and Properties:</th>
8465+
<td class="role-inherited">Placeholder</td>
8466+
</tr>
8467+
<tr>
8468+
<th class="role-disallowed-head" scope="row">Prohibited States and Properties:</th>
8469+
<td class="role-disallowed">
8470+
<ul>
8471+
<li><pref>aria-label</pref></li>
8472+
<li><pref>aria-labelledby</pref></li>
8473+
</ul>
8474+
</td>
8475+
</tr>
8476+
<tr>
8477+
<th class="role-namefrom-head" scope="row">Name From:</th>
8478+
<td class="role-namefrom">prohibited</td>
8479+
</tr>
8480+
<tr>
8481+
<th class="role-namerequired-head" scope="row">Accessible Name Required:</th>
8482+
<td class="role-namerequired"> </td>
8483+
</tr>
8484+
<tr>
8485+
<th class="role-namerequired-inherited-head" scope="row">Inherits Name Required:</th>
8486+
<td class="role-namerequired-inherited"> </td>
8487+
</tr>
8488+
<tr>
8489+
<th class="role-childpresentational-head" scope="row">Children Presentational:</th>
8490+
<td class="role-childpresentational"> </td>
8491+
</tr>
8492+
<tr>
8493+
<th class="role-presentational-inherited-head" scope="row">Inherits Presentational:</th>
8494+
<td class="role-presentational-inherited"> </td>
8495+
</tr>
8496+
</tbody>
8497+
</table>
8498+
</div>
83978499
<div class="role" id="superscript">
83988500
<rdef>superscript</rdef>
83998501
<div class="role-description">

0 commit comments

Comments
 (0)