Add suggestion role (#1134)

aleventhal · carmacleod · mcking65 · web-flow · commit 2a047fd3316b · 2020-02-13T13:31:38.000-08:00
* Relates to ARIA Annotations, issue #749 Co-Authored-By: Carolyn MacLeod <Carolyn_MacLeod@ca.ibm.com> Co-Authored-By: Matt King <a11yThinker@Gmail.com>
diff --git a/index.html b/index.html
@@ -670,6 +670,7 @@ <h3>Document Structure Roles</h3>
 				<li><rref>separator</rref> (when not focusable)</li>
 				<li><rref>strong</rref></li>
 				<li><rref>subscript</rref></li>
+				<li><rref>suggestion</rref></li>
 				<li><rref>superscript</rref></li>
 				<li><rref>table</rref></li>
 				<li><rref>term</rref></li>
@@ -8394,6 +8395,107 @@ <h5>Presentational Roles Conflict Resolution</h5>
 				</tbody>
 			</table>
 		</div>
+		<div class="role" id="suggestion">
+			<rdef>suggestion</rdef>
+			<div class="role-description">
+					<p>A single proposed change to content.</p>
+					<p>For example, in an editing system that supports multiple users, one user may suggest a change, and another user would be responsible
+					for accepting or rejecting the suggestion.</p>
+					<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>
+					<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>
+					<pre class="example highlight">
+						&lt;p&gt;
+						  The best pet is a
+						  &lt;span role="suggestion"&gt;
+						    &lt;span role="deletion"&gt;cat&lt;/span&gt;
+						    &lt;span role="insertion"&gt;dog&lt;/span&gt;
+						  &lt;/span&gt;
+						&lt;/p&gt;
+					</pre>
+					<p>When a suggestion is accepted, authors SHOULD remove the <code>suggestion</code> role, indicating that the proposed revision has been made.
+						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.
+					  </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>section</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">
+											<li><rref>insertion</rref></li>
+											<li><rref>deletion</rref></li>
+									</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"> </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-disallowed-head" scope="row">Prohibited States and Properties:</th>
+									<td class="role-disallowed">
+											<ul>
+													<li><pref>aria-label</pref></li>
+													<li><pref>aria-labelledby</pref></li>
+											</ul>
+									</td>
+							</tr>
+							<tr>
+									<th class="role-namefrom-head" scope="row">Name From:</th>
+									<td class="role-namefrom">prohibited</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="superscript">
 			<rdef>superscript</rdef>
 			<div class="role-description">
