Skip to content

Commit

Permalink
Consolidate on i18n-drafts location (reviews/shortchecklist.html)
Browse files Browse the repository at this point in the history
  • Loading branch information
@r12a
r12a committed Jun 3, 2019
1 parent 9efff7f commit 4c90579
Showing 1 changed file with 2 additions and 193 deletions.
195 changes: 2 additions & 193 deletions reviews/shortchecklist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,201 +2,10 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Spec review checklist</title>
<meta name="description" content="Lists open issues in i18n Activity github repositories." />
<script type="text/javascript">
var f = { }

// AUTHORS should fill in these assignments:
f.directory = 'i18n-wg/repostatus/'+'/'; // the path to this file, not including /International or the file name
f.filename = 'reviews'; // the file name WITHOUT extensions
f.authors = 'Richard Ishida, W3C'; // author(s) and affiliations
f.previousauthors = ''; // as above
f.modifiers = ''; // people making substantive changes, and their affiliation
f.searchString = 'reviews-openissues'; // blog search string - usually the filename without extensions
f.firstPubDate = '2106-03-16'; // date of the first publication of the document (after review)
f.lastSubstUpdate = { date:'2106-07-15', time:'07:18'} // date and time of latest substantive changes to this document
f.status = 'notreviewed'; // should be one of draft, review, published, notreviewed or obsolete
f.path = 'https://w3c.github.io/i18n-drafts/' // what you need to prepend to a URL to get to the /International directory

// AUTHORS AND TRANSLATORS should fill in these assignments:
f.thisVersion = { date:'2106-07-15', time:'07:18'} // date and time of latest edits to this document/translation
f.contributors = ''; // people providing useful contributions or feedback during review or at other times
// also make sure that the lang attribute on the html tag is correct!

// TRANSLATORS should fill in these assignments:
f.translators = 'xxxNAME, ORG'; // translator(s) and their affiliation - a elements allowed, but use double quotes for attributes

f.breadcrumb = 'characters';

f.additionalLinks = ''
</script>
<script type="text/javascript" src="index-data/translations.js"> </script>
<script type="text/javascript" src="https://w3c.github.io/i18n-drafts/javascript/doc-structure/article-dt.js"> </script>
<script type="text/javascript" src="https://w3c.github.io/i18n-drafts/javascript/boilerplate-text/boilerplate-en.js"></script><!--TRANSLATORS must change -en to the subtag for their language!-->
<script type="text/javascript" src="https://w3c.github.io/i18n-drafts/javascript/doc-structure/sitepage.js"> </script>
<script type="text/javascript" src="https://w3c.github.io/i18n-drafts/javascript/articletoc-html5.js"></script>
<script type="text/javascript" src="index-data/label-list.js"></script>
<link rel="stylesheet" href="https://w3c.github.io/i18n-drafts/style/sitepage-2016.css" type="text/css" />
<link rel="stylesheet" href="index-data/local.css" type="text/css" />
<link rel="copyright" href="#copyright"/>
<!--[if lt IE 9]><script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script><![endif]-->
<style>
#checklist td { vertical-align: top; padding: .25em; font-family: Helvetica, Roboto, Calibri, "Segoe UI", sans-serif; }
</style>
<title>redirect</title>
</head>

<body>
<header>
<nav id="mainNavigation"></nav>
<script>document.getElementById('mainNavigation').innerHTML = mainNavigation</script>
</header>
<div class="content">
<h1> Short i18n review checklist</h1>
<section id="sidebarExtras">
<h2 class="notoc">Useful links</h2>
<ul>
<li><a class="print" href="https://www.w3.org/International/techniques/developing-specs">I18n review checklist</a></li>
<li><a class="print" href="https://www.w3.org/International/review-request">Request an i18n review</a></li>
<li><a class="print" href="https://github.com/w3c/i18n-activity/projects/1">Review radar</a></li>
</ul>
<p>If you would like to create a report against this list in a GitHub repository (<a href="https://github.com/w3c/wot-thing-description/issues/582">like this</a>), copy the text in this box to the comment field of your issue, and then annotate it.</p>
<textarea id="copy" style="width:100%;height:10em;">
Short i18n review checklist is [here](http://w3c.github.io/i18n-activity/reviews/shortchecklist)

1. [ ] _If the spec (or its implementation) contains any natural language text that will be read by a human (this includes error messages or other UI text, JSON strings, etc, etc),_

Comments go here.

2. [ ] _If the spec (or its implementation) allows content authors to produce typographically appealing text, either in its own right, or in association with graphics._

Comments go here.

3. [ ] _If the spec (or its implementation) allows the user to point into text, creates text fragments, concatenates text, allows the user to select or step through text (using a cursor or other methods), etc._

Comments go here.

4. [ ] _If the spec (or its implementation) allows searching or matching of text, including syntax and identifiers_

Comments go here.

5. [ ] _If the spec (or its implementation) sorts text_

Comments go here.

6. [ ] _If the spec (or its implementation) captures user input_

Comments go here.

7. [ ] _If the spec (or its implementation) deals with time in any way that will be read by humans and/or crosses time zone boundaries_

Comments go here.

8. [ ] _If the spec (or its implementation) allows any character encoding other than UTF-8._

Comments go here.

9. [ ] _If the spec (or its implementation) defines markup._

Comments go here.

10. [ ] _If the spec (or its implementation) deals with names, addresses, time & date formats, etc_

Comments go here.

11. [ ] _If the spec (or its implementation) describes a format or data that is likely to need localization._

Comments go here.

12. [ ] _If the spec (or its implementation) makes any reference to or relies on any cultural norms_

Comments go here.

</textarea>
<p><button onClick="document.getElementById('copy').select();">Select all</button></p>
</section>
<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>The text of this page is still being perfected. Please raise any suggestions using <a href="https://github.com/w3c/i18n-activity/issues/">GitHub issues</a>.</p>
</section>
<section id="rawdata">
</section>


<table id="checklist">
<tbody>
<tr>
<th>If the spec or its implementation...</th>
<th>... then:</th>
<th>links to detailed checklists</th></tr>
<tr>
<td>... contains <strong>any natural language</strong> text that will be read by a human (this includes error messages or other UI text, JSON strings, etc, etc),</td>
<td>... ensure that there’s metadata about and support for basic things such as language and text direction</td>
<td><p><a href="https://www.w3.org/International/techniques/developing-specs.en?open=resource#resource">Language</a></p>
<p><a href="https://www.w3.org/International/techniques/developing-specs.en?open=text_direction#text_direction">Text direction</a></p></td></tr>
<tr>
<td>... allows content authors to produce <strong>typographically appealing text</strong>, either in its own right, or in association with graphics.</td>
<td>... take into account the different typographic styles used around the world (for things such as line-breaking, text justification, emphasis or other text decorations, text selection and units, etc.)</td>
<td><p><a href="https://www.w3.org/International/techniques/developing-specs.en?open=typography#typography">Typographic support</a></p></td>
</tr>
<tr>
<td>... allows the user to <strong>point into text</strong>, creates text <strong>fragments</strong>, <strong>concatenates</strong> text, allows the user to <strong>select or step through</strong> text (using a cursor or other methods), etc.</td>
<td>... make allowances for the ways different scripts handle units of text</td>
<td><a href="https://www.w3.org/International/techniques/developing-specs.en?open=operations#operations">Text-processing</a></td>
</tr>
<tr>
<td>... allows <strong>searching or matching</strong> of text, including syntax and identifiers</td>
<td>... understand the implications of normalisation, case folding, etc</td>
<td><a href="https://www.w3.org/International/techniques/developing-specs.en?open=operations#operations">Text-processing</a></td>
</tr>
<tr>
<td>... <strong>sorts text</strong></td>
<td>... ensure that it does so in locally relevant ways</td>
<td><a href="https://www.w3.org/International/techniques/developing-specs.en?open=operations#operations">Text-processing</a></td>
</tr>
<tr>
<td>... <strong>captures user input</strong></td>
<td>... ensure that it also captures metadata about language and text direction, and that it accommodates locale-specific input methods</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>... <strong>deals with time</strong> in any way that will be read by humans and/or crosses time zone boundaries</td>
<td>... ensure that it will represent time as expected in locales around the world, and manage the relationship between local and global/absolute time.</td>
<td><a href="https://www.w3.org/International/techniques/developing-specs.en?open=locale#locale">Local dates, times and formats</a></td>
</tr>
<tr>
<td>... allows any <strong>character encoding</strong> other than UTF-8</td>
<td>... make sure you have a convincing argument as to why, and then ensure that the character encoding model is correct</td>
<td><p><a href="https://www.w3.org/International/techniques/developing-specs.en?open=characters#characters">Characters</a></p></td>
</tr>
<tr>
<td>... <strong>defines markup</strong></td>
<td>... ensure support for internationalisation features and avoid putting human-readable text in attribute values or plain-text elements</td>
<td><p><a href="https://www.w3.org/International/techniques/developing-specs.en?open=markup#markup">Markup &amp; syntax</a></p></td>
</tr>
<tr>
<td>... deals with <strong>names, addresses, time &amp; date formats</strong>, etc</td>
<td>... ensure that the model is flexible enough to cope with wide variations in format, levels of data, etc</td>
<td><p><a href="https://www.w3.org/International/techniques/developing-specs.en?open=locale#locale">Local dates, times and formats</a></p></td>
</tr>
<tr>
<td>... describes a format or data that is likely to <strong>need localisation</strong></td>
<td>... ensure that there’s an approach in place which allows effective storage and labelling of, and access to localised alternatives for strings, text, images, etc</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>... makes any reference to or relies on any <strong>cultural norms</strong></td>
<td>... ensure that it can be adapted to suit different cultural norms around the world (ranging from depictions of people or gestures, to expectations about gender roles, to approaches to work and life, etc).</td>
<td>&nbsp;</td>
</tr>
</tbody>
</table>


<footer id="thefooter"></footer>
<script type="text/javascript">document.getElementById('thefooter').innerHTML = g.bottomOfPage</script>
<script type="text/javascript">completePage()</script>

</div>
<p>This page is now available <a href="https://w3c.github.io/i18n-drafts/techniques/shortchecklist.html">here</a>.</p>
</body>
</html>

0 comments on commit 4c90579

Please sign in to comment.