Staff catalog search results should include heading tags

Bug #2009865 reported by Stephanie Leary
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Evergreen
Fix Released
Medium
Unassigned

Bug Description

Adding heading tags to the title and author in the search results list would make it much easier for screen reader users to skim the list using their software's outline tools (which we can emulate using a browser extension that lists landmarks and headings).

Branch forthcoming.

Related: Bug #1615707, Bug #1994711

Revision history for this message
Stephanie Leary (stephanieleary) wrote :

Branch here:
https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sleary/LP2009865-catalog-search-result-headings

In conjunction with the fix for Bug #1994711, the resulting page outline is:

h1. Staff Catalog
h2. Search Results (N)
(repeat for each result:)
h3. [Title]
h4. [Author]
(repeat for each facet box:)
h4. [Facet title]

We might want to give the facet sidebar a screenreader-only subheading and adjust the heading levels of the facet titles, but that can be addressed separately.

tags: added: accessibility pullrequest
Revision history for this message
Benjamin Kalish (bkalish) wrote :

Why would the title and author get separate heading at different levels? I'd also think it would be better if the facet box headings were not simply mixed with the search results–the idea of a screenreader-only subheading for the sidebar makes sense. Perhaps:

h1. Staff Catalog
h2. Search Results (N)
(repeat for each result:)
h3. [Title] [Author]
h2. Facets
(repeat for each facet box:)
h3. [Facet title]

Revision history for this message
Stephanie Leary (stephanieleary) wrote :

I agree that having the title and author in the same heading would be ideal, but it's not feasible with the current markup without redesigning the layout of the result--which I intend to do at some future date! At the moment, they're in separate Bootstrap layout rows, and there's no good way to smush them together.

Revision history for this message
Jane Sandberg (sandbergja) wrote :

I am +1 to using the titles in the search results as headings. In my opinion, the title functions as a heading by describing the content below it (i.e. the description of the work in the search results).

I am -1 to using the authors in the search results as headings, since they don't describe the content underneath them.

Also, with this patch, if a result does not have an author, a heading is still created, which is confusing. When I searched for "clarinet" in the concerto data set and opened the list of headings in the VoiceOver rotor, there were two headings that were just called "link".

Revision history for this message
Stephanie Leary (stephanieleary) wrote :

I went to update this branch and realized that there really wasn't anything preventing us from squashing the title and author into one heading. The order now matches Benjamin's suggested outline, with the hidden "Facets" heading inserted above the sidebar. Much better!

Since I was messing with the sidebar markup, I took the extra step of moving it after the results list in the source order. I've adjusted the CSS to preserve the left-right arrangement visually. I could open a separate ticket for that, but it felt like overkill.

The branch has been updated and rebased.

Changed in evergreen:
status: New → Confirmed
importance: Undecided → Medium
milestone: none → 3.10.2
Revision history for this message
Jane Sandberg (sandbergja) wrote :

Thanks, Stephanie! I tested this with the Voiceover rotor; it provides a much better experience. I squashed your two commits and added my signoff at https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/sandbergja/lp2009865-signoff

tags: added: signedoff
tags: added: staffcatalog
summary: - Search results should include heading tags
+ Staff catalog search results should include heading tags
Galen Charlton (gmc)
Changed in evergreen:
assignee: nobody → Galen Charlton (gmc)
Revision history for this message
Galen Charlton (gmc) wrote :

Tested and pushed down to rel_3_10. Thanks, Stephanie and Jane!

Changed in evergreen:
status: Confirmed → Fix Committed
assignee: Galen Charlton (gmc) → nobody
Changed in evergreen:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.