Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Review exported PDFs from "MHV on VA.gov" team #58587

Closed
4 of 12 tasks
Tracked by #77076
artsymartha68 opened this issue May 17, 2023 · 28 comments
Closed
4 of 12 tasks
Tracked by #77076

Review exported PDFs from "MHV on VA.gov" team #58587

artsymartha68 opened this issue May 17, 2023 · 28 comments
Assignees
Labels
10-10ez notifications Notifications for the 10-10EZ application sitewide CAIA sitewide content CAIA content work sitewide IA

Comments

@artsymartha68
Copy link
Contributor

artsymartha68 commented May 17, 2023

What does your team need support for? Check all that apply.

  • Launching one or more unauthenticated pages, online forms, apps, or tools on VA.gov
  • Making revisions to one or more existing VA.gov pages
  • Something else

Give a brief description of what your team needs support with.

The "MHV on VA.gov" team is making excellent progress with exporting PDFs out of the Veterans' medical record. We need to review these samples to make sure the a11y requirements are being met as development proceeds. Assigning SK since she has PDF expertise.

Will this new product be released incrementally (for instance 25% of users initially)?

  • Yes
  • No

Supporting artifacts

Please provide supporting artifacts as available.

There are sample PDFs in the slack channel here (SK is on the thread with Adrian and Bobby):

https://dsva.slack.com/archives/C03Q2UQL1AS/p1684344969816149?thread_ts=1681767385.014929&cid=C03Q2UQL1AS

Will this work be going through the Collaboration Cycle?

  • Yes (eventually)
  • No

When does this work need to be done?

  • Estimated launch date:
  • Estimated staging review date:
  • Content, Accessibility, and IA work needed by: asap as developers are actively working

Do you plan to bring this to an upcoming content office hours session?

  • Yes, benefit content office hours (Thursdays, 3:00 p.m. to 3:45 p.m. ET)
  • Yes, health content office hours (Thursdays, 11:00 a.m. to 11:30 a.m. ET)
  • Yes, unauth office hours (Mondays, 11:00 a.m. to 11:30 a.m. ET)
  • No, but I'd like to schedule time to talk about this request
  • No, let's work asynchronously and meet if needed

Note: If we think this work would benefit from a collaborative session with you, we may ask you to bring it to office hours or set up a separate time to meet.

Artifacts

https://app.zenhub.com/files/133843125/a8ffd18d-7c42-470a-8ae9-8e4e65dc72a5/downloadhttps://app.zenhub.com/files/133843125/fe342527-1092-4515-a744-16ca40e8c107/downloadhttps://app.zenhub.com/files/133843125/87e0e673-d2d4-48af-b798-d2e4cbfcad30/downloadhttps://app.zenhub.com/files/133843125/9556265b-0b2e-4080-a4c3-fef1d8b7963f/download

About your team

@acrollet
Copy link
Contributor

I just realized that I need to review and fix some issues with word separation/whitespace. I'll upload new PDFs later today.

@acrollet
Copy link
Contributor

I've updated the slack link in the issue to point at the more recent PDFs.

@SarahKay8
Copy link
Contributor

SarahKay8 commented May 18, 2023

Hey @acrollet! I would break these sections out into paragraphs 59B00A48-CBB3-4152-B348-6BFFDE933CAD.jpeg,

Lists must have the following structure: Label Elements and List Item Body Elements.
Once I get these PDF's through my commonlook validator, I'll drop more feedback (if any)

@acrollet
Copy link
Contributor

thanks @SarahKay8 !

so you're saying that in the example above, "Result: ", "Standard range: " and so on should go in the Lbl element? I just ask because the guidance (for example) I've seen online is that the label should contain bullets and/or numbers, which we don't have in this doc.

thanks again 🙂

@SarahKay8
Copy link
Contributor

SarahKay8 commented May 18, 2023

Yep correct! Because these don't have anylbls such as bullets or numbers
we can put “result:6.0 g/dL low” “Standard range:13.5-17.4 g/DL” “Status: Final” and so on into individual paragraph tags. Sorry if I didn't word it correctly @acrollet

@acrollet
Copy link
Contributor

oh I get it, great! thanks 🙂

@MarciMcGuire MarciMcGuire added the 10-10ez notifications Notifications for the 10-10EZ application label May 19, 2023
@acrollet
Copy link
Contributor

@SarahKay8
Copy link
Contributor

Hey @acrollet! Thank you for making these changes.

I would break up each of these lines here into seperate paragraph tags. This is on the Vaccine PDF. I.E "Provider comments: No information no feedback given" in a single tag 29385725-68DF-444B-AEDB-023FBCC26C6C.jpeg
You also need to give this PDF an English language which can be done In "Page Properties".
Also, because there is a repeating instance of "Vaccines" and the paragraph beneath it, you can artifact these on page 2 and so on so it doesn't keep repeating on each page. E6F1D550-24C4-4799-9021-B095D046625A.jpeg. There is also an empty H3 tag on the Blood Pressure PDF. 88BB8928-6D1A-4FE2-85A4-54B4122EAF79.jpegLastly, each pdf has failed Tab Order. To remediate in Acrobat, go to "Page Properties" in the page panel, select "Tab Order" and choose "Use Document Structure" , tab order failure will pass.**

@acrollet
Copy link
Contributor

@SarahKay8 thanks for your review! I'll be working on your feedback, I've also contributed a fix to the generation package to set the Tab Order to "Use Document Structure", hopefully that will get reviewed and merged in quickly.

@RLHecht
Copy link
Contributor

RLHecht commented May 24, 2023

Going to close this ticket but please reopen if there's more work needed!

@RLHecht RLHecht closed this as completed May 24, 2023
@acrollet
Copy link
Contributor

@RLHecht I'll want a re-review to ensure that these issues have been correctly addressed, should I open a new ticket once I have new samples ready? thanks!

@RLHecht
Copy link
Contributor

RLHecht commented May 24, 2023

Ah, got it. i think we can keep it all in this ticket. I'll reopen so it's easier to find.

@RLHecht RLHecht reopened this May 24, 2023
@SarahKay8
Copy link
Contributor

@SarahKay8 thanks for your review! I'll be working on your feedback, I've also contributed a fix to the generation package to set the Tab Order to "Use Document Structure", hopefully that will get reviewed and merged in quickly.

Sounds good! Thanks!

@SarahKay8
Copy link
Contributor

SarahKay8 commented May 25, 2023

Hey @acrollet! lastly, our a11y specialist Evan ran these pdfs through the commonlook software and this was his feedback. Required fixes

  • Tab order is not set in Acrobat 
    • Not sure if this is possible to set in the source software?
    • Since there are no interactive elements in the doc, the tab order won’t make much of a difference, though it does fail the checker
  • There are empty <NonStruct> tags throughout the tag tree
    • More so a PDF/UA issue 
  • The tagged <Artifact> header and footer content at the end of the tag tree is read by the screen reader when the user reaches the end of the document
    • Though tagged as <Artifact> in the tag tree, the header/footer content is within<Span>tags in the content pane
    • If it is not possible to programmatically ignore header/footer content in the source, could alt text be added to the properties of the artifacted content to let the user know it should be ignored? 
      FOR BLOOD PRESSURE ONLY
      There’s an empty <H3> tag that is causing a hierarchy issue due to the previous heading being a <H1> 
      Recommended fixes
  • <Sect> tags are used as a root element, though <Document> should be used as the tag that contains all tags in the tag tree
  • Provide content for the Author and Subject fields in the document properties
  • Author is the organization, not an individual 

@acrollet
Copy link
Contributor

Thanks @SarahKay8 ! Questions inline:

  • Tab order is not set in Acrobat 

    • Not sure if this is possible to set in the source software?

This will be fixed per our conversation above.

  • Since there are no interactive elements in the doc, the tab order won’t make much of a difference, though it does fail the checker
  • There are empty <NonStruct> tags throughout the tag tree

These tags contain the horizontal rule elements - would it be better to use Artifact tags?

  • The tagged <Artifact> header and footer content at the end of the tag tree is read by the screen reader when the user reaches the end of the document

    • Though tagged as <Artifact> in the tag tree, the header/footer content is within<Span>tags in the content pane

Would it be better to make the Artifact tag a Struct and place the text content in Artifact tags instead of Spans?

  • If it is not possible to programmatically ignore header/footer content in the source, could alt text be added to the properties of the artifacted content to let the user know it should be ignored? 
    FOR BLOOD PRESSURE ONLY
    There’s an empty <H3> tag that is causing a hierarchy issue due to the previous heading being a <H1> 

This will be resolved in the next set for review.

**Recommended fixes**
  • <Sect> tags are used as a root element, though <Document> should be used as the tag that contains all tags in the tag tree
  • Provide content for the Author and Subject fields in the document properties
  • Author is the organization, not an individual

👍

@acrollet
Copy link
Contributor

You also need to give this PDF an English language which can be done In "Page Properties".

@SarahKay8 that's odd, I'm giving the document the language code en-US - what is acrobat reporting it as? Would you prefer that I simply use en? thanks!

@SarahKay8
Copy link
Contributor

SarahKay8 commented May 26, 2023

@acrollet Empty <NonStruct> tags: Yes, the horizontal rule elements should be changed to artifacts and ignored by screen readers. Decorative content such as structural elements, non-informative images, or anything that doesn't provide value to a screen reader user should be changed to artifacts so they're not picked up during reading.

Header/footer content: It would be best to find a way to make sure the content isn't read at all. If this is content is important and should be read, only one instance of the header/footer should be accessed - the header on the the first page and the footer on the last page. This is the ideal scenario. It seems like the app is trying to make the header/footer content hidden from users due to the <Artifact> tags, but it's still picked up. Since they come at the end of the document, it doesn't impact the user much, so I'd be okay leaving as is if there's no way to address the issue.

cc: [email protected]

@acrollet
Copy link
Contributor

@BobbyBaileyRB can you provide guidance on whether the header/footer content should be accessible to screen readers? That is to say, is it considered essential content or meta/informational?

@acrollet
Copy link
Contributor

acrollet commented May 30, 2023

just noting that the vaccines-list.pdf file was not generated by the new pdf generation package. (I think this resolves the question on the language property)

@BobbyBaileyRB
Copy link
Contributor

Hi! @acrollet, the footer is helpful information when navigating pages. The header information is a requirement that we must provide, such as the first name and last, along with the DOB. Should these be accessible to screen readers at some point while reviewing the documents.

It wouldn't be a good experience if the header was spoken to screen readers on every page - as Sarah recommended, it would be nice if it only read this to AT users when it first displays the header. However, @SarahKay8 shouldn't the page numbers always be in the tab order and read to AT users? Or does the application itself solve for that? We don't need to read off "the Report generated by" for every page, only needs to be read off on the first time it appears.

@BobbyBaileyRB
Copy link
Contributor

Note: the content team has provided some written updates for the PDF - I will be working on the PDF design updates this week (or the next, depending on time and tasks).

@acrollet
Copy link
Contributor

@acrollet Empty <NonStruct> tags: Yes, the horizontal rule elements should be changed to artifacts and ignored by screen readers. Decorative content such as structural elements, non-informative images, or anything that doesn't provide value to a screen reader user should be changed to artifacts so they're not picked up during reading.

Header/footer content: It would be best to find a way to make sure the content isn't read at all. If this is content is important and should be read, only one instance of the header/footer should be accessed - the header on the the first page and the footer on the last page. This is the ideal scenario. It seems like the app is trying to make the header/footer content hidden from users due to the <Artifact> tags, but it's still picked up. Since they come at the end of the document, it doesn't impact the user much, so I'd be okay leaving as is if there's no way to address the issue.

cc: [email protected]

Hi Sarah,

I've updated the HR elements and worked on the header/footer content so that the first header will be read at the top of the document, and the last footer at the bottom. Could you review this attached file? Thanks!

lab_and_test_results (9).pdf

@SarahKay8
Copy link
Contributor

Looks good! @acrollet Thanks for the update

@acrollet
Copy link
Contributor

acrollet commented Jun 2, 2023

@SarahKay8 here are PDFs for (hopefully) final review, I believe I've addressed all feedback with the exception of the tab order, which will be resolved once this pull request is merged into PDFKit and a new version has been released.

lab_and_test_results.pdf
single_vital.pdf
vitals.pdf
vaccines.pdf

@SarahKay8
Copy link
Contributor

HI @acrollet! I have no additional feedback to add. These look great.

@SarahKay8
Copy link
Contributor

is this okay to close out? @acrollet

@acrollet
Copy link
Contributor

acrollet commented Jun 5, 2023

@SarahKay8 I think so, can you just confirm that the tab order change is not a launch blocker?

@SarahKay8
Copy link
Contributor

Ah I see! I personally would consider this a minor defect. Once changes are merged, Myra at the 508 office will do one final QA and we should be good to go. @acrollet

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
10-10ez notifications Notifications for the 10-10EZ application sitewide CAIA sitewide content CAIA content work sitewide IA
Projects
None yet
Development

No branches or pull requests

7 participants