Repository navigation
Low priority accessibility fixes - #1064
Conversation
…ges from ezid-info-pages repository
…ion and footer elements LI and etc
|
Adam, I'm also not sure if we should get someone else to review these. Since they are mostly HTML/CSS and accessibility changes, maybe Juliet for code or the UX team for compliance if they want to. |
There was a problem hiding this comment.
🟡 Changes recommended
Unresolved test database-access failures remain, along with accessibility and CI/source-path issues.
4 open findings
What changed in this PR
This PR adds accessibility improvements across EZID templates, styles, demos, tests, documentation, and CI.
Changes:
- Adds semantic landmarks, headings, fieldsets, navigation labels, and accessible form markup.
- Improves contrast, focus styling, and generated assets.
- Adds accessibility tests and supporting configuration and documentation.
| File | Summary |
|---|---|
ui_tags/templatetags/menus.py |
Adds breadcrumb navigation semantics. |
ui_tags/templatetags/manage_form_tags.py |
Removes redundant form roles. |
tox.ini |
Updates test configuration. |
tests/test_ui_landmarks.py |
Adds landmark and form accessibility tests. |
tests/test_ui_headings.py |
Adds heading accessibility tests. |
templates/tombstone.html |
Adds header and main landmarks. |
templates/search/results.html |
Removes redundant form roles. |
templates/search/index.html |
Adds semantic fieldsets. |
templates/search/_results.html |
Removes redundant form roles. |
templates/search/_pagination.html |
Improves pagination labels. |
templates/manage/index.html |
Adds fieldsets and legends. |
templates/manage/edit.html |
Removes redundant form roles. |
templates/manage/details.html |
Adds labeled content sections. |
templates/layouts/base.html |
Adds the main landmark. |
templates/index.html |
Improves heading and note markup. |
templates/includes/top.html |
Adds navigation landmarks. |
templates/includes/status.html |
Updates status-region semantics. |
templates/includes/localized/cdl/footer_fineprint.html |
Structures footer links semantically. |
templates/includes/footer.html |
Improves footer structure. |
templates/doc/apidoc.2.rst |
Updates the ERC reference. |
templates/doc/apidoc.1.html |
Corrects heading levels. |
templates/demo/simple.html |
Removes redundant form roles. |
templates/demo/advanced.html |
Removes redundant form roles. |
templates/dashboard/index.html |
Improves dashboard headings and forms. |
templates/dashboard/_totalIdsByMonth.html |
Removes redundant form roles. |
templates/dashboard/_issues.html |
Removes redundant form roles. |
templates/dashboard/_crossref.html |
Removes redundant form roles. |
templates/create/simple.html |
Removes redundant form roles. |
templates/create/advanced.html |
Removes redundant form roles. |
templates/create/_home_demo_form.html |
Removes redundant form roles. |
templates/contact.html |
Removes redundant form roles. |
templates/account/pwreset2.html |
Removes redundant form roles. |
templates/account/pwreset1.html |
Removes redundant form roles. |
templates/account/login.html |
Removes redundant form roles. |
templates/account/edit.html |
Removes redundant form roles. |
static_src/stylesheets/main2.min.css |
Updates generated accessibility styling. |
static_src/stylesheets/main.css |
Updates legacy heading styling. |
static_src/locale/fr_CA/LC_MESSAGES/django.po |
Updates translated markup. |
static_src/info/learnsub_current_users.html |
Changes the informational heading level. |
pyproject.toml |
Updates package configuration. |
gulpfile.js |
Reformats the asset pipeline. |
dev/scss/main2.scss |
Adds accessibility utility styles. |
dev/scss/_home.scss |
Styles the homepage note. |
dev/scss/_home-banner.scss |
Improves banner contrast and focus styling. |
dev/scss/_header.scss |
Styles semantic navigation lists. |
dev/scss/_footer.scss |
Styles semantic footer links. |
dev/scss/_fieldsets.scss |
Normalizes fieldset styling. |
dev/legacy-scss/_pg-api.scss |
Styles API headings. |
dev/legacy-scss/_headings.scss |
Updates heading styles. |
dev/layout_search.html |
Updates search demo semantics. |
dev/layout_search-results.html |
Adds a main landmark. |
dev/layout_manage.html |
Updates navigation and fieldsets. |
dev/layout_identifier.html |
Adds content landmarks. |
dev/layout_home.html |
Updates homepage demo semantics. |
dev/layout_create.html |
Updates create-page structure. |
dev/layout_contact.html |
Adds a main landmark. |
dev/includes/pagination.html |
Improves pagination labels. |
dev/includes/login-menu.html |
Adds account navigation semantics. |
dev/includes/home-banner.html |
Updates banner structure. |
dev/includes/header.html |
Adds semantic header navigation. |
dev/includes/footer_geo-on.html |
Structures footer links. |
dev/includes/footer_geo-off.html |
Structures footer links. |
AGENTS.md |
Documents repository conventions. |
.gitignore |
Ignores .old files. |
.github/workflows/main.yml |
Checks out informational-page templates in CI. |
Files not reviewed (1)
- static_src/stylesheets/main.css: Generated file
🧠 Review effort: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
…DK but it doesn't seem to hurt.
|
@jupiter007 Since you're a CSS/HTML master, can you glance over these changes? They are deployed at https://ezid-dev.cdlib.org/ which you may need to be on the VPN to use (or in the office). I don't think a very thorough review is needed but just to do a sanity check to be sure nothing terrible is happening. This is also some pretty old legacy HTML which likely will not be completely rewritten to be the most shiny. It's mostly about doing more semantic markup from some very old HTML divs and some other redundant aria problems and some other stuff. Just to be sure we maintain functionality and streamline low-priority fixes. None of these were particularly critical according to the UX team but nice to haves that make it easier for something like a screen reader or other things to work well. |
jupiter007
left a comment
There was a problem hiding this comment.
Looks good. I only had a few comments.
Another thing I noticed is that the dashboard menu with "Dashboard", "Manage IDs", "Create Id" and "Account Settings" doesn't indicate to screen readers which one is selected. Since there isn't a Title on each of those pages to indicate where the user is, we might want to add the use of "aria-current='page'" on the selected link.
|
Thanks for this good feedback. I'll add some fixes for these things. Thanks again for reviewing. |
|
I also added an aria for the current menu as mentioned above by Juliet. It does something visually (an little down arrow). |
These are changes based on the ticket #1049 and all the sub-issues.
These are generally small changes such as changing some things from divs to semantic html markup, adding fieldsets, removing unnecessary aria form attributes (when something is already a form), small scss tweaks to make things appear reasonably.
It also dims the "hero" splash so that white text over dark background has necessary contrast. We might be able to tweak more if it seems too dark to get right to the edge of the contrast that is allowable for large text (I think 3:1).
It also adds an AGENTS.md since I think it's useful to have a little context for agents to modify routine things in EZID since they were faster and generally more thorough at finding things for fixing than I think I am (or the notes were). There are also some things that are confusing with random sprinkles of duplicated files in a few places and it's good for it to know what to actually modify.
It also modifies the Github Action tests to bring in the ui-library since it is required in the real deployment and there are some added tests for the modifications to some UI areas. I don't think these are particularly super important tests, though, so if they become onerous to maintain (because of something like frequent layout changes) then we could remove them. But I think the EZID UI is quite stable and mostly unchanging for many years aside from accessibility changes and things like jquery/bootstrap updates.
I tried to do a commit for each of the items if it's too much to look at everything all at once. There are a lot of changes, but they are generally small-ish ones. Some files look like everything was changed but it's somewhat because the formatting of the HTML was horrible and not indented well and now it is.