Update aria-describedby and aria-description AXAPI (#142)

spectranaut · web-flow · commit 2e7aaca82068 · 2023-04-06T17:26:42.000-07:00
diff --git a/index.html b/index.html
@@ -267,7 +267,7 @@ <h5>Accessible Names and Descriptions</h5>
         <p>For instance, in MSAA, all <a class="termref">accessible objects</a> support the <code>accName</code> property, which stores the object's <a class="termref" data-cite="accname-1.2#dfn-accessible-name">accessible name</a>. Where the object also supports having an <a class="termref" data-cite="accname-1.2#dfn-accessible-description">accessible description</a>, MSAA stores this property in the object's <code>accDescription</code> property.</p>
         <p>Software using ATK can read and write to an object's <code>accessible-name</code> and <code>accessible-description</code> properties. In turn, AT-SPI can query the values of those properties through its <code>atspi_accessible_get_name</code> and <code>atspi_accessible_get_description</code> functions.</p>
         <p>Automation elements in the UIA accessibility tree have a <code>Name</code> property. Where the object also supports having an <a class="termref" data-cite="accname-1.2#dfn-accessible-description">accessible description</a>, UIA stores this property in the object's <code>FullDescription</code> property.</p>
-        <p>The approach to <a class="termref" data-cite="accname-1.2#dfn-accessible-name">accessible names</a> and <a class="termref" data-lt="accessible description" data-cite="accname-1.2#dfn-accessible-description">accessible descriptions</a> in AX API is somewhat different to the other platform APIs. <a class="termref" data-cite="accname-1.2#dfn-accessible-name">Accessible names</a> are exposed using the <code>AXTitle</code> property when the name is visually rendered, while the <code>AXDescription</code> property is used when the object's name is not rendered visually. An object's <a class="termref" data-cite="accname-1.2#dfn-accessible-description">accessible description</a>, where provided, should always be exposed in the <code>AXHelp</code> property.</p>
+        <p>The approach to <a class="termref" data-cite="accname-1.2#dfn-accessible-name">accessible names</a> and <a class="termref" data-lt="accessible description" data-cite="accname-1.2#dfn-accessible-description">accessible descriptions</a> in AX API is somewhat different to the other platform APIs. <a class="termref" data-cite="accname-1.2#dfn-accessible-name">Accessible names</a> are exposed using the <code>AXTitle</code> property when the name is visually rendered, while the <code>AXDescription</code> property is used when the object's name is not rendered visually. An object's <a class="termref" data-cite="accname-1.2#dfn-accessible-description">accessible description</a>, where provided by <a class="state-reference" href="#aria-description"><code>aria-description</code></a> or <a class="state-reference" href="#aria-describedby"><code>aria-describedby</code></a>, should be exposed in the <code>accessibilityCustomContent</code> API. Otherwise, it should be exposed as <code>AXHelp</code>.</p>
         <p>For more detail, see the <a class="accname" href="">Accessible Name and Description Computation</a> specification.</p>
       </section>
     </section>
@@ -2598,8 +2598,8 @@ <h4>Not Mapped</h4>
 					<span class="seealso">See also: <a href="#mapping_additional_nd">Name Computation</a> and <a href="#mapping_additional_relations">Mapping Additional Relations</a></span>
 				</td>
 				<td class="attr-axapi">
-					<span class="property">Property: <code>AXHelp</code>: <code>&lt;value&gt;</code></span><br />
-					<span class="seealso">See also: <a href="#mapping_additional_nd">Name Computation</a></span>
+					<span class="api">In the accessibilityCustomContent API, expose as an <code>AXCustomContent</code> object with <code>{ label: "description" }</code> and `<code>value</code>` set to the description string.</span><br />
+-                                       <span class="seealso">See also: <a href="#mapping_additional_nd">Name Computation</a></span>
 				</td>
 			</tr>
 			<tr id="ariaDescription">
@@ -2617,8 +2617,8 @@ <h4>Not Mapped</h4>
 					<span class="seealso">See also: <a href="#mapping_additional_nd">Name Computation</a></span>
 				</td>
 				<td class="attr-axapi">
-					<span class="property">Property: <code>AXHelp</code>: <code>&lt;value&gt;</code></span><br />
-					<span class="seealso">See also: <a href="#mapping_additional_nd">Name Computation</a></span>
+					<span class="api">In the accessibilityCustomContent API, expose as an <code>AXCustomContent</code> object with <code>{ label: "description" }</code> and `<code>value</code>` set to the description string.</span><br />
+                                        <span class="seealso">See also: <a href="#mapping_additional_nd">Name Computation</a></span>
 				</td>
 			</tr>
 			<tr id="ariaDetails">
