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

Mention educational value of short checklist #610

Open
wants to merge 1 commit into
base: gh-pages
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions techniques/shortchecklist.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h2 class="notoc" style="hyphens:none;">Create a report</h2>
Comments go here.
- [ ] Not applicable

9. [ ] _If the spec (or its implementation) defines markup_ **ensure support for internationalization features and avoid putting human-readable text in attribute values or plain-text elements**. Also check the detailed guidance for [Markup & syntax](https://www.w3.org/TR/international-specs/#markup).
9. [ ] _If the spec (or its implementation) defines markup_ **ensure support for internationalisation features and avoid putting human-readable text in attribute values or plain-text elements**. Also check the detailed guidance for [Markup & syntax](https://www.w3.org/TR/international-specs/#markup).
Copy link
Contributor

Choose a reason for hiding this comment

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

Really? Zpelling change? 😉


Comments go here.
- [ ] Not applicable
Expand Down Expand Up @@ -141,8 +141,8 @@ <h2 class="notoc">Useful links</h2>


<section>
<p>This page points developers of specifications to various aspects of their spec that may need internationalization review. It can also be used by spec reviewers, to get an idea of what to look for in a spec.</p>
<p><strong>You should raise an issue in your own repository to show the answers to these questions, and attach the i18n-tracker label so that we are notified. Under 'Create a Report' you'll find a way to create a report.</strong></p>
<p><strong>The primary purpose for this page is educational. It helps you to learn about internationalization features that may affect the design of your spec. You should read it <em>and</em> <a href="https://www.w3.org/TR/international-specs/">Internationalization Best Practices for Spec Developers</a> as early as possible, so that you are aware of what your spec will need to address. Then, to ensure that you haven't missed anything, you can also use this page as a checklist prior to publishing the spec as a FPWD.</strong></p>
Copy link
Contributor

Choose a reason for hiding this comment

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

I like this a lot.

Consider using a class with a style instead of just using <strong>. We want people to read this and maybe a different background or other handling will help make it visible.

<p>You should raise an issue in your own repository to show the answers to these questions, and attach the i18n-tracker label so that we are notified. Under 'Create a Report' you'll find a way to create a report.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

put <code> around i18n-tracker?

</section>
<section id="rawdata">
</section>
Expand Down