Skip to content

Create export-9.html - #44

Open
zakkinsey wants to merge 3 commits into
mainfrom
36-export---9---reference-bibentry-index-structure-elements
Open

Create export-9.html#44
zakkinsey wants to merge 3 commits into
mainfrom
36-export---9---reference-bibentry-index-structure-elements

Conversation

@zakkinsey

Copy link
Copy Markdown
Collaborator

The IDs and PLSE names will need heavy remediation in this export due to the input formatting and likeness.

@zakkinsey zakkinsey linked an issue May 5, 2026 that may be closed by this pull request
Comment thread WIP/export-9.html Outdated
@@ -0,0 +1,359 @@
<h4 id="role-reference-inline-doc-biblioref">`Reference` <span class="el-context">(Placement = Inline)</span></h4>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have three tables for Reference, all being mapped to different DPub roles, but none mapped to anything in HTML or ARIA. I wonder if we need another table for Reference that maps to ARIA or HTML?
And also, this first one has the "secondary type" as Inline but otherwise, between the three we currently have, there's no other way to know which DPub role to use when processing a Reference tag. And, thinking about this more, all References would be Inline.
There is also this question/ comment in the Google sheet:
If, in PDF, Reference is for a link to somewhere else in the same document (as opposed to an external link) then should we treat this more like "link"? Also, seeing as "link" is in HTML and ARIA, it might be better supported than the DPub roles? That said, for link, HTML just says to use ARIA mapping.

And there is also the issue that many screen readers say "link" when they encounter a Reference tag, even if there is no functionality that makes it work like a link. If we can solve for that issue, too.

Comment thread WIP/export-9.html Outdated
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code> Question: If, in PDF, Reference is for a link to somewhere else in the same document (as opposed to an external link) then should we treat this more like &quot;link&quot;? Also, seeing as &quot;link&quot; is in HTML and ARIA, it might be better supported than the DPub roles? That said, HTML just says to use ARIA mapping.</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code> Question: If, in PDF, Reference is for a link to somewhere else in the same document (as opposed to an external link) then should we treat this more like &quot;link&quot;? Also, seeing as &quot;link&quot; is in HTML and ARIA, it might be better supported than the DPub roles? That said, HTML just says to use ARIA mapping.</code></span>
<span class="property">Note: <code>TBD</code></span>

I took the question that was here and actually put it in my comment at line 1.

Comment thread WIP/export-9.html Outdated
@@ -0,0 +1,359 @@
<h4 id="role-reference-inline-doc-biblioref">`Reference` <span class="el-context">(Placement = Inline)</span></h4>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-reference-inline-doc-biblioref">`Reference` <span class="el-context">(Placement = Inline)</span></h4>
<h4 id="role-reference-doc-biblioref">`Reference` <span class="el-context">(DPub role = doc-biblioref)</span></h4>

We don't need to specify placement.

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-reference-doc-glossref">`Reference Placement = Inline`</h4>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-reference-doc-glossref">`Reference Placement = Inline`</h4>
<h4 id="role-reference-doc-glossref">`Reference` <span class="el-context">(DPub role = doc-glossref)</span></h4>

Comment thread WIP/export-9.html Outdated
</tr>
<tr>
<th>Analogous HTML Element</th>
<td>Use WAI-ARIA mapping</td>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<td>Use WAI-ARIA mapping</td>
<td>Use DPub mapping</td>

We should point to DPub mapping if this is mapped to a DPub role. In all of the rows below.

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-reference-doc-noteref">`Reference Placement = Inline`</h4>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-reference-doc-noteref">`Reference Placement = Inline`</h4>
<h4 id="role-reference-doc-noteref">`Reference` <span class="el-context">(DPub role = doc-noteref)</span></h4>

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-bibentry-doc-biblioentry">`BibEntry`</h4>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-bibentry-doc-biblioentry">`BibEntry`</h4>
<h4 id="role-doc-biblioentry">`BibEntry` as DPub `doc-bibentry`<span class="el-context">(DPub role = doc-bibentry)</span></h4>

Also, how will we differentiate this BibEntry from the other two, below, other than their DPub role? I wonder if the H4 should be something like BibEntry as DPub bibentry - and then do similarly for list item and paragraph?

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-bibentry-listitem">`BibEntry`</h4>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-bibentry-listitem">`BibEntry`</h4>
<h4 id="role-bibentry-listitem">`BibEntry` as a `listitem` <span class="el-context">(WAI-ARIA role = listitem)</span></h4>

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-bibentry-paragraph">`BibEntry We used this one in our &quot;article&quot;`</h4>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-bibentry-paragraph">`BibEntry We used this one in our &quot;article&quot;`</h4>
<h4 id="role-bibentry">`BibEntry` <span class="el-context">(WAI-ARIA role = paragraph)</span></h4>

I think this one should be the "default" handling unless another DPub (or other) role is set.

Comment thread WIP/export-9.html Outdated
</tr>
<tr>
<th>Analogous HTML Element</th>
<td>Use WAI-ARIA mapping</td>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Refer to my comment at line 46.

Comment thread WIP/export-9.html Outdated
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>
<span class="property">Note: <code>TBD</code></span>

Comment thread WIP/export-9.html
</tr>
<tr>
<th>Analogous HTML Element</th>
<td>Use WAI-ARIA mapping</td>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my comment at line 46.

Comment thread WIP/export-9.html
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>
<span class="property">Note: <code>TBD</code></span>

Comment thread WIP/export-9.html
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>
<span class="property">Note: <code>TBD</code></span>

Comment thread WIP/export-9.html
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>
<span class="property">Note: <code>TBD</code></span>

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-index-generic">`Index Parked for ARIA / Reuse discussions`</h4>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-index-generic">`Index Parked for ARIA / Reuse discussions`</h4>
<h4 id="role-index">`Index` <span class="el-context">(If no accessible name)</span> </h4>

Comment thread WIP/export-9.html
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Hold for consultation with W3C experts. The HTML table and Derivation group said to use &quot;generic,&quot; (and the related ARIA mapping), but the ARIA roll mapping table says otherwise.</code></span>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Hold for consultation with W3C experts. The HTML table and Derivation group said to use &quot;generic,&quot; (and the related ARIA mapping), but the ARIA roll mapping table says otherwise.</code></span>
<span class="property">Note: <code>Use this mapping if there is not an accessible name.</code></span>

There is a question here, though: The HTML table and Derivation group said to use "generic," (and the related ARIA mapping), but the ARIA roll mapping table says otherwise. @romantoda , @daniel-montalvo , @zakkinsey

Comment thread WIP/export-9.html
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>NOTE: There is no &quot;section with (or without) accessible name&quot; but the ARIA role could be different based on whether or not there is an accessible name.</code></span>

@PaulRayius-2 PaulRayius-2 May 8, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>NOTE: There is no &quot;section with (or without) accessible name&quot; but the ARIA role could be different based on whether or not there is an accessible name.</code></span>
<span class="property">Note: <code>TBD</code></span>

Question: NOTE: The ARIA role could be different based on whether or not there is an accessible name? Is that right or did I misunderstand, before? There is something about using ARIA - "region" if there is an accessible name but "generic" if there is no accessible name. Not sure about this.

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-index-region">`Index Parked for ARIA / Reuse discussions`</h4>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-index-region">`Index Parked for ARIA / Reuse discussions`</h4>
<h4 id="role-index-has-accessible-name">`Index` <span class="el-context">(Has an accessible name)</span></h4>

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-index-navigation">`Index Parked for ARIA / Reuse discussions`</h4>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-index-navigation">`Index Parked for ARIA / Reuse discussions`</h4>
<h4 id="role-index-navigation">`Index` <span class="el-context">(WAI-ARIA role = navigation)</span></h4>

Comment thread WIP/export-9.html
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>
<span class="property">Note: <code>TBD</code></span>

Comment thread WIP/export-9.html Outdated
</tbody>
</table>

<h4 id="role-index-doc-index">`Index Parked for ARIA / Reuse discussions`</h4>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<h4 id="role-index-doc-index">`Index Parked for ARIA / Reuse discussions`</h4>
<h4 id="role-index-doc-index">`Index` <span class="el-context">(DPub role = doc-index)</span></h4>

Comment thread WIP/export-9.html
</tr>
<tr>
<th>Analogous HTML Element</th>
<td>Use WAI-ARIA mapping</td>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If my suggestion at line 217 is correct then these subsequent rows should map to DPub, not WAI-ARIA.

Comment thread WIP/export-9.html Outdated
<tr>
<th><abbr title="Notes">Notes:</abbr></th>
<td>
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<span class="property">Note from PDFa: <code>Use WAI-ARIA mapping</code></span>
<span class="property">Note: <code>TBD</code></span>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Export - 9 - Reference, BibEntry, Index structure elements

3 participants