Permalinks in computations should NOT use specific numbering in the link (because the numbering will change)

[cookiecrook]

The AccName computation permalinks to specific steps are unique to their current position in the list, rather than unique to the content of the list item. For example step2B.ii.c:

<li id="step2B.ii.c">Append the <code>result</code>, with a space, to the <code>accumulated text</code>.</li>

I believe this should be changed, as we reorder or add items from time-to-time. Keeping these numbered permalinks would either break permalinking, or would result in confusing legacy hashes that don't match the number.

Instead, they should use a unique, somewhat human readable ID ref, such as:

<li id="idref_append_space">Append the <code>result</code>, with a space, to the <code>accumulated text</code>.</li>

Then the link wouldn't need to change if reordering happened.

[jnurthen]

Thoughts from 8/19 Deep Dive - folks please edit this.

Going off the Computation steps in the ED:
https://w3c.github.io/accname/#computation-steps

The first string would be human understandable text names that would be rendered at the beginning of every major step, and any important sub-step that we agree with worth linking. The id value is the proposed unique ID for permalinks; prefixed here with "comp_"

• Step 1: "Initialization" id: comp_init
• Step 2: "Computation" id: comp_comp
  • A: "Hidden Not Referenced" id: comp_hidden_not_referenced
  • B: "Labelled or Described By" id: comp_labelled_or_described_by
    • 1st bullet: "Non-Recursive LabelledBy" id: comp_non_recursive_labelled_by (should this be combined with the next bullet?)
    • 2nd bullet: "Non-Recursive DescribedBy" id: comp_non_recursive_described_by
      • i: No ID needed for sub-step?
      • ii: No ID needed for sub-step?
        • a: No ID needed for sub-step?
        • b: No ID needed for sub-step?
        • c: No ID needed for sub-step?
      • iii: No ID needed for sub-step?
  • 2C: "Embedded Control" id: comp_embedded_control
    • 1st bullet: "Textbox" id: comp_embedded_textbox
    • 2nd bullet: "Combobox/Listbox" id: comp_embedded_composite
    • 3rd bullet: "Range" id: comp_embedded_range
      • 1st sub-bullet: "Value Text" id: comp_embedded_range_valuetext
      • 2nd sub-bullet: "Value Now" id: comp_embedded_range_valuenow
      • 3rd sub-bullet: "Host Language Value" id: comp_embedded_range_host_language_value
  • 2D: "Non-recursive aria-label" id: comp_non_recursive_aria_label
    • 1st bullet: No ID needed for sub-step?
    • 2nd bullet: No ID needed for sub-step?
  • 2E: "Host Language Label" id: comp_host_language_label
  • 2F: "Name From Content" id: comp_name_from_content
    • i: "Reset Name From Content" "id: comp_name_from_content_reset
    • ii: "Pseudo Elements" id: comp_pseudo
      • 1st bullet: "::Before" id: comp_pseudo_before
      • 2nd bullet: "::After" id: comp_pseudo_after
    • iii: "For Each Child" id: comp_for_each_child
      • a: No ID needed for sub-step?
      • b: No ID needed for sub-step?
      • c: No ID needed for sub-step?
    • iv: No ID needed for sub-step?
  • G: "Text Node" id: comp_text_node
  • H: "Recursive Name From Content" id: comp_recursive_name_from_content
  • I: "Tooltip" id: comp_tooltip

[cookiecrook]

Open questions... (feel free to edit this comment too)

• Should the embedded comments and examples have names and IDs, too?
• Should IDs use camelCase, underscore_separation, or something else?
• It's not always clear why sub-sections are ordered versus unordered. Should all of them be ordered for consistency? The style sheet could be updated to ensure a consistent numbering system for each level.
• What other resources point to specific steps of the computation? When this is updated, we should track issues in each of those to update the verbiage and link accordingly.
• We may be able to keep the legacy links working by using the deprecated name attr for the old link such as <li name="step1" id="comp_init"> for a version release or two.

[cookiecrook]

Append the result of each step above, with a space, to the total accumulated text.
After all steps are completed, the total accumulated text is used as the accessible name or accessible description of the element that initiated the computation.

Should the text above be "Step 3"?

Update: Filed as #142

[cookiecrook]

Note: I also filed #141 and #143 as separate issues when reviewing this outline.

[cookiecrook]

I have completed a first pass proposal in @jnurthen's comment above. @jnurthen, @joanmarie, @accdc, and @aleventhal please review.

[accdc]

This seems logical to me. Do others have any opinions?

[cookiecrook]

Also we can change the legacy id attributes to name to prevent old permalinks from breaking.