Skip to content

Commit

Permalink
Try title_HTML to hold abbr
Browse files Browse the repository at this point in the history
  • Loading branch information
@daniel-montalvo
daniel-montalvo committed Nov 28, 2024
1 parent ea2be4d commit 72287c7
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions pages/about/groups/task-forces/pdf-aam.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Portable Document Format Accessibility APIs Mapping (PDF-AAM) Task Force
title_html: Portable Document Format Accessibility <abbr title="Accessibility Programming Interfaces">APIs</abbr> Mapping (PDF-AAM) Task Force
permalink: /about/groups/task-forces/pdf-aam/
ref: /about/groups/task-forces/pdf-aam/
lang: en
Expand Down

1 comment on commit 72287c7

@tamsinewing555
Copy link
Contributor

@tamsinewing555 tamsinewing555 commented on 72287c7 Nov 28, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

This is working as expected in preview: https://deploy-preview-974--wai-website.netlify.app/about/groups/task-forces/pdf-aam/ .
Note: If you do decide to use abbr in the h1, then it's no longer necessary to also use it in the summary sentence below.

A couple of other things:

The definition of API needs to be corrected (the word 'Accessibility' is used instead of 'Application'):
Portable Document Format Accessibility <abbr title="Application Programming Interfaces">APIs</abbr> Mapping (PDF-AAM) Task Force

Furthermore, in the summary sentence, I'd recommend implementing the best practice of ensuring an abbreviation’s full meaning is expressed in the content immediately following a heading that contains abbr.

To solve this problem, would it be possible to make a tweak to the second sentence in the summary, as follows?:
'It assists this Working Group to map Accessibility APIs (Application Programming Interfaces) to PDFs and keep the development of PDF-AAM in sync with WAI-ARIA.'

If we can't add the expanded form of the abbreviation to the summary or find another way to provide it earlier, then instead I suggest adding the expanded form of API where it appears under the heading, 'Current work':
'As this work develops, the Editor’s Draft will be updated with the latest PDF Accessibility API (Application Programming Interface) mappings.'
Note: In the above sentence, 'Editor's Draft' still needs to be linked, as you had done originally (that link has been removed in the latest update).

Please sign in to comment.