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 Add annotations wcag #7081

Closed
wants to merge 12 commits into from
Closed
6 changes: 3 additions & 3 deletions securedrop/journalist_templates/account_new_two_factor.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@

{% block body %}
{% if user.is_totp %}
<h1>{{ gettext('Enable FreeOTP') }}</h1>
<h1>{{ gettext('Enable <abbr title="two-factor authentication application">FreeOTP</abbr>') }}</h1>
Copy link
Member

Choose a reason for hiding this comment

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

"FreeOTP" is the name of a specific application, so it doesn't need a generic annotation.

<p>
{{ gettext("You're almost done! To finish resetting your two-factor authentication, follow the instructions below to set up FreeOTP. Once you've added the entry for your account in the app, enter one of the 6-digit codes from the app to confirm that two-factor authentication is set up correctly.") }}
</p>

<ol>
<li>{{ gettext('Install FreeOTP on your phone') }}</li>
<li>{{ gettext('Open the FreeOTP app') }}</li>
<li>{{ gettext('Tap the QR code symbol at the top') }}</li>
<li>{{ gettext('Tap the <abbr title="quick response">QR</abbr> code symbol at the top') }}</li>
Copy link
Member

Choose a reason for hiding this comment

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

I wouldn't annotate an initialism that's (a) in common use and (b) cited far more widely (463 million Google results) than its expansion (2.1 million results).

<li>{{ gettext('Your phone will now be in "scanning" mode. When you are in this mode, scan the barcode below:') }}
</li>
</ol>
Expand All @@ -23,7 +23,7 @@ <h1>{{ gettext('Enable FreeOTP') }}</h1>
<mark id="shared-secret">{{ user.formatted_otp_secret }}</mark>
<p>{{ gettext("Once you have paired FreeOTP with this account, enter the 6-digit verification code below:") }}</p>
{% else %}
<h1>{{ gettext('Enable YubiKey (OATH-HOTP)') }}</h1>
<h1>{{ gettext('Enable YubiKey (<abbr title="HMAC based one-time password algorithm">OATH-HOTP</abbr>)') }}</h1>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<h1>{{ gettext('Enable YubiKey (<abbr title="HMAC based one-time password algorithm">OATH-HOTP</abbr>)') }}</h1>
<h1>{{ gettext('Enable YubiKey (OATH-<abbr title="HMAC-based one-time password">HOTP</abbr>)') }}</h1>

Choose a reason for hiding this comment

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

fixed this change

<p>{{ gettext('Once you have configured your YubiKey, enter the 6-digit verification code below:') }}</p>
{% endif %}
<form id="check-token" method="post">
Expand Down
2 changes: 1 addition & 1 deletion securedrop/journalist_templates/admin.html
Original file line number Diff line number Diff line change
Expand Up @@ -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 config') }}">
Copy link
Member

Choose a reason for hiding this comment

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

See next comment:

Suggested change
id="update-instance-config" aria-label="{{ gettext('Update instance config') }}">
id="update-instance-config" aria-label="{{ gettext('Update instance configuration') }}">

{{ gettext('INSTANCE CONFIG') }}
{{ gettext('INSTANCE <abbr title="Configuration">CONFIG</abbr>') }}
Copy link
Member

Choose a reason for hiding this comment

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

Let's go ahead and just expand this, as we have in: :-)

<h1>{{ gettext('Instance Configuration') }}</h1>

Suggested change
{{ gettext('INSTANCE <abbr title="Configuration">CONFIG</abbr>') }}
{{ gettext('INSTANCE CONFIGURATION') }}

Choose a reason for hiding this comment

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

fixed this

</a>

{% endblock %}
6 changes: 3 additions & 3 deletions securedrop/journalist_templates/config.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ <h2 id="config-orgname">{{ gettext('Organization Name') }}</h2>
<form action="{{ url_for('admin.update_org_name') }}" method="post">
<input name="csrf_token" type="hidden" value="{{ csrf_token() }}">
<div><label
for="organization_name">{{ gettext('Set the organization name used on the SecureDrop web interfaces:') }}</label>
for="organization_name">{{ gettext('Set the organization name used on the SecureDrop <abbr title="World Wide Web">web</abbr> interfaces:') }}</label>
Copy link
Member

Choose a reason for hiding this comment

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

I don't think "web" is worth annotating. Users know what it means, and it's debatable whether SecureDrop's interfaces (as Tor onion services) are part of the World Wide Web. :-)

</div>
<div>{{ organization_name_form.organization_name() }}</div>
<div class="section-spacing">
Expand All @@ -32,7 +32,7 @@ <h2 id="config-orgname">{{ gettext('Organization Name') }}</h2>
<section aria-labelledby="config-logoimage">
<h2 id="config-logoimage">{{ gettext('Logo Image') }}</h2>

<p>{{ gettext('Here you can update the image displayed on the SecureDrop web interfaces:') }}</p>
<p>{{ gettext('Here you can update the image displayed on the SecureDrop <abbr title="World Wide Web">web</abbr> interfaces:') }}</p>

<img id="current-logo" src="{{ g.logo }}" class="logo small" alt="{{ g.organization_name }}" width="250">

Expand Down Expand Up @@ -94,7 +94,7 @@ <h2 id="config-preventuploads">{{ gettext('Submission Preferences') }}</h2>
<section aria-labelledby="config-testalert">
<h2 id="config-testalert">{{ gettext('Alerts') }}</h2>

<p>{{ gettext('Send an encrypted email to verify if OSSEC alerts work correctly:') }}</p>
<p>{{ gettext('Send an encrypted email to verify if <abbr title="Open Source HIDS SECurity">OSSEC</abbr> alerts work correctly:') }}</p>
Copy link
Member

Choose a reason for hiding this comment

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

OSSEC is the name of an application, and we only ever refer to it this way. I don't think it needs expanding.


<form method="post" action="{{ url_for('admin.ossec_test') }}">
<input name="csrf_token" type="hidden" value="{{ csrf_token() }}">
Expand Down
2 changes: 1 addition & 1 deletion securedrop/source_templates/footer.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
{{ gettext('Powered by') }} <b>SecureDrop {{ version }}</b>.
</p>
<p id="footer-advisory">
{{ gettext('Please note: Sharing sensitive information may put you at risk, even when using Tor and SecureDrop.') }}
{{ gettext('Please note: Sharing sensitive information may put you at risk, even when using <abbr title="The Onion Router">Tor</abbr> and SecureDrop.') }}
Copy link
Member

Choose a reason for hiding this comment

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

I don't think this is worth expanding. It's no longer the official initialism of the Tor project or network, and users will reach this page via Tor Browser already.

</p>
<p id="footer-fpf">
{{ gettext('SecureDrop is a project of Freedom of the Press Foundation.') }}
Expand Down
2 changes: 1 addition & 1 deletion securedrop/source_templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<div id="browser-security-level" class="warning" role="alert">
<p>{{ gettext('Your Tor Browser\'s <a id="disable-js" href=""><b>Security Level</b></a> is too low. Use the <img src="{icon}" alt="&quot;Security Level&quot;"> button in your browser’s toolbar to change it.').format(icon=url_for("static", filename="i/font-awesome/white/guard.svg")) }}</p>
</div>
{# Warning bubble to help TB users disable JavaScript with Tor Browser's Security Levels
{# Warning bubble to help <abbr title="Tor Browser">TB</abbr> users disable JavaScript with <abbr title="The Onion Router">Tor</abbr> Browser's Security Levels
Copy link
Member

Choose a reason for hiding this comment

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

This is a server-side Jinja comment for developers, so users will never see it, and HTML doesn't work here anyway. :-)

Included here so the images can preload while the user is first
reading the page. Hidden by default. #}
<dialog open id="security-level-info" aria-labelledby="security-level-heading"
Expand Down
2 changes: 1 addition & 1 deletion securedrop/source_templates/logout.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<section>
<h2>{{ gettext('One more thing...') }}</h2>
<p>
{{ gettext('Click the <img src={icon} alt="" width="16" height="16">&nbsp;<b>New Identity</b> button in your Tor Browser\'s toolbar. This will clear your Tor Browser activity data on this device.').format(icon=url_for('static', filename='i/torbroom.png')) }}
{{ gettext('Click the <img src={icon} alt="" width="16" height="16">&nbsp;<b>New Identity</b> button in your <abbr title="The Onion Router">Tor</abbr> Browser\'s toolbar. This will clear your Tor Browser activity data on this device.').format(icon=url_for('static', filename='i/torbroom.png')) }}
Copy link
Member

Choose a reason for hiding this comment

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

See above.

</p>
</section>
{% endblock %}
4 changes: 2 additions & 2 deletions securedrop/source_templates/lookup.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ <h2 id="submit-heading">{{ gettext('Submit Messages') }}</h2>

<p>
{% if allow_document_uploads %}
{{ gettext('If you are already familiar with GPG, you can optionally encrypt your files and messages with our <a href="{url}" class="text-link">public key</a> before submission. Files are encrypted as they are received by SecureDrop.').format(url=url_for('info.download_public_key')) }}
{{ gettext('If you are already familiar with <abbr title="GNU Privacy Guard">GPG</abbr>, you can optionally encrypt your files and messages with our <a href="{url}" class="text-link">public key</a> before submission. Files are encrypted as they are received by SecureDrop.').format(url=url_for('info.download_public_key')) }}
{% else %}
{{ gettext('If you are already familiar with GPG, you can optionally encrypt your messages with our <a href="{url}" class="text-link">public key</a> before submission.').format(url=url_for('info.download_public_key')) }}
{{ gettext('If you are already familiar with <abbr title="GNU Privacy Guard">GPG</abbr>, you can optionally encrypt your messages with our <a href="{url}" class="text-link">public key</a> before submission.').format(url=url_for('info.download_public_key')) }}
{% endif %}
{{ gettext('<a href="{url}" class="text-link">Learn more</a>.').format(url=url_for('info.why_download_public_key')) }}
</p>
Expand Down
2 changes: 1 addition & 1 deletion securedrop/source_templates/tor2web-warning.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ <h2>{{ gettext('Proxy Service Detected') }}</h2>
<div class="center">
{% include 'flashed.html' %}
</div>
<p>{{ gettext('You appear to be using a Tor proxy service to access SecureDrop. Proxy services do not protect your anonymity.') }}
<p>{{ gettext('You appear to be using a <abbr title="The Onion Router">Tor</abbr> proxy service to access SecureDrop. Proxy services do not protect your anonymity.') }}
Copy link
Member

Choose a reason for hiding this comment

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

See above.

</p>
<p>{{ gettext('Anyone monitoring your Internet traffic &mdash; including your government, your Internet provider, or the proxy operator &mdash; may be able to identify you.') }}
</p>
Expand Down
2 changes: 1 addition & 1 deletion securedrop/source_templates/why-public-key.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<h2>{{ gettext("Why download the team's public key?") }}</h2>
<p>{{ gettext("SecureDrop encrypts files and messages after they are submitted. Encrypting messages and files before submission can provide an extra layer of security before your data reaches the SecureDrop server.") }}
</p>
<p>{{ gettext("If you are already familiar with the GPG encryption software, you may wish to encrypt your submissions yourself. To do so:") }}
<p>{{ gettext("If you are already familiar with the <abbr title="GNU Privacy Guard">GPG</abbr> encryption software, you may wish to encrypt your submissions yourself. To do so:") }}
<ol>
<li>{{ gettext('<a href="{url}">Download</a> the public key. It will be saved to a file called:
<p><code>{submission_key_fpr_filename}</code></p>').format(url=url_for('info.download_public_key'), submission_key_fpr_filename=submission_key_fpr + '.asc')|safe }}
Expand Down