Skip to content

Conversation

@alisaismailati
Copy link
Contributor

References

Description

Heading levels on a page should be applied structurally and hierarchically, without skipping levels.
Screen readers and other assistive technologies rely on the correct use of HTML elements to navigate and interpret the content. Misusing heading levels can make it harder for users with visual impairments to understand the structure and flow of a page.

Instructions for Reviewers

To identify inappropriate heading size is used a browser extensions as tool for assistance:
https://wave.webaim.org/extension/ - detects when there are missing headers or skipped levels of heading.
This way, adjusted the heading levels indicated as warnings by the web tool extension, in order to eliminate missing headers or skipped levels of heading.

In some cases, such as for instance, title of a modal that is located inside a modal-header, we can use a <div> element with an h4 class to apply the styles.This way we reach the visual result and avoid using <h4> tag, which might not be semantically appropriate.
Example (Discard submission modal):
image

Reference: Typography

Include guidance for how to test or review your PR.
Here are a few illustrated examples:

  • Search-page - Missing first level heading
    image
    now:
    image

  • Quality Assurance Suggestions
    image
    now:
    image
    Other pages examples are:

  • MyDspace, Quality Assurance (sources-list),

  • Quality Assurance (topic-list),

  • Create Community/Collection,

  • Discard submission modal,

  • Select a search scope modal,

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You do not need to complete this checklist prior creating your PR (draft PRs are always welcome).
However, reviewers may request that you complete any actions in this list if you have not done so. If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is created against the main branch of code (unless it is a backport or is fixing an issue specific to an older branch).
  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using yarn lint
  • My PR doesn't introduce circular dependencies (verified via yarn check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • My PR aligns with Accessibility guidelines if it makes changes to the user interface.
  • My PR uses i18n (internationalization) keys instead of hardcoded English text, to allow for translations.
  • My PR includes details on how to test it. I've provided clear instructions to reviewers on how to successfully test this fix or feature.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@tdonohue tdonohue added bug accessibility 1 APPROVAL pull request only requires a single approval to merge claimed: 4Science 4Science team is working on this issue & will contribute back funded Task is funded via the DSpace Development Fund port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Jul 29, 2024
@github-actions
Copy link

github-actions bot commented Oct 9, 2024

Hi @alisaismailati,
Conflicts have been detected against the base branch.
Please resolve these conflicts as soon as you can. Thanks!

# Conflicts:
#	src/app/notifications/qa/source/quality-assurance-source.component.html
Copy link
Member

@mwoodiupui mwoodiupui left a comment

Choose a reason for hiding this comment

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

I tried to find the fixed components. Scanned the pages with Wave. Nothing looked odd to me.

@tdonohue tdonohue added this to the 9.0 milestone Nov 13, 2024
@tdonohue tdonohue merged commit 0417e1d into DSpace:main Nov 13, 2024
@dspace-bot
Copy link
Contributor

Backport failed for dspace-7_x, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin dspace-7_x
git worktree add -d .worktree/backport-3225-to-dspace-7_x origin/dspace-7_x
cd .worktree/backport-3225-to-dspace-7_x
git switch --create backport-3225-to-dspace-7_x
git cherry-pick -x 703945c804820de8d5b64ec02340d8a44ca8b801

@dspace-bot
Copy link
Contributor

Backport failed for dspace-8_x, because it was unable to cherry-pick the commit(s).

Please cherry-pick the changes locally and resolve any conflicts.

git fetch origin dspace-8_x
git worktree add -d .worktree/backport-3225-to-dspace-8_x origin/dspace-8_x
cd .worktree/backport-3225-to-dspace-8_x
git switch --create backport-3225-to-dspace-8_x
git cherry-pick -x 703945c804820de8d5b64ec02340d8a44ca8b801

@tdonohue tdonohue removed port to dspace-7_x This PR needs to be ported to `dspace-7_x` branch for next bug-fix release port to dspace-8_x This PR needs to be ported to `dspace-8_x` branch for next bug-fix release labels Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

1 APPROVAL pull request only requires a single approval to merge accessibility bug claimed: 4Science 4Science team is working on this issue & will contribute back funded Task is funded via the DSpace Development Fund

Projects

No open projects
Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Headings must have an appropriate relative hierarchy to other headings on the same page.

4 participants