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

#6405 Fix wcag annotations #7314

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

amnak613
Copy link

Status

Ready for review / Work in progress

Description of Changes

Added abbreviation descriptions to the html pages.

Fixes #6405. and the closed pr: #7081

Changes proposed in this pull request:

  • add abbr tag to html pages

Testing

How should the reviewer test this PR?
Write out any special testing steps here.

-when looking through the page ensure the correct words have abbreviations

Deployment

Any special considerations for deployment? Consider both:

  1. Upgrading existing production instances.
  2. New installs.

Checklist

If you made changes to the server application code:

  • Linting (make lint) and tests (make test) pass in the development container

If you made changes to securedrop-admin:

  • Linting and tests (make -C admin test) pass in the admin development container

If you made changes to the system configuration:

If you added or removed a file deployed with the application:

  • I have updated AppArmor rules to include the change

If you made non-trivial code changes:

  • I have written a test plan and validated it for this PR

Choose one of the following:

  • I have opened a PR in the docs repo for these changes, or will do so later
  • I would appreciate help with the documentation
  • These changes do not require documentation

If you added or updated a reference to a production code dependency:

Production code dependencies are defined in:

  • admin/requirements.in
  • admin/requirements-ansible.in
  • securedrop/requirements/python3/requirements.in
  • securedrop/requirements/python3/translation.in (used in the build
    container)

If you changed another requirements.in file that applies only to development
or testing environments, then no diff review is required, and you can skip
(remove) this section.

Choose one of the following:

  • I have performed a diff review and pasted the contents to the packaging wiki
  • I would like someone else to do the diff review
  • I am silencing an alert related to a production dependency, because (please explain below):

@amnak613 amnak613 requested a review from a team as a code owner October 30, 2024 22:01
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

Thanks for this @amnak613 - I had a few questions, see the review!

@@ -2,19 +2,19 @@
<a href="#close" class="external" aria-label="{{ gettext('Close') }}"></a>
<dialog open id="delete-confirm-menu-dialog" aria-labelledby="confirm-heading">
<h2 id="confirm-heading" class="paragraph-spacing">
{{ gettext('When the account for a source is deleted:') }}
{{ gettext('When the account for a <abr title="user">source</abr>is deleted:') }}
Copy link
Contributor

Choose a reason for hiding this comment

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

AFAICT the tag should be <abbr title="..."> not <abr title="..."> - unsure if both are valid.

Copy link
Author

Choose a reason for hiding this comment

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

Looked it up and both are valid - https://www.w3schools.com/tags/tag_abbr.asp

</h2>
<ul>
<li>{{ gettext('The source will no longer be able to log in with their codename.') }}</li>
<li>{{ gettext('The <abr title="user">source</abr> will no longer be able to log in with their <abbr title="user name">codename</abbr>.') }}</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

It's unclear that terms like source and codename are ones that should have an abbr tag (vs the OATH-HOTP instance below, which definitely should!) - is there a reason they're included?

Copy link
Author

Choose a reason for hiding this comment

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

The reason why I thought it would be nice to have was because its a bit unclear as a new user what a codename is as its a term used specifically by the app. Let me know if I need to update @zenmonkeykstop

@@ -85,7 +85,7 @@ <h2 id="users-heading" class="visually-hidden">Users</h2>

<a href="{{ url_for('admin.manage_config') }}" class="btn icon icon-edit section-spacing-inline"
id="update-instance-config" aria-label="{{ gettext('Update instance configuration') }}">
{{ gettext('INSTANCE CONFIG') }}
{{ gettext('INSTANCE CONFIGURATION') }}
Copy link
Contributor

Choose a reason for hiding this comment

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

This is probably out of scope for WCAG annotations and will require translation changes.

Copy link
Author

Choose a reason for hiding this comment

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

okay, sounds good - will remove for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

annotate abbreviations and SecureDrop jargon (WCAG 3.1.3, 3.1.4)
2 participants