Checklist for approving TRs for posting

last modified: 2003-02-28 

This checklist focuses on formal checking of format for publication release and does not contain issues for content review. All items in yellow need to be regularly updated almost every release. Instructions to the reviewer are given in blue.

A summary of checklist items, especially for the TR body, may be found in section 1, The Checklist.

• Check the page title. It's shown on browser title bar, and is in <title>...</title> in HTML. This is easy to forget. Don't use different titles for proposed/draft -- just use the final title. The title can be abbreviated, for example in this example it should be: 

UTR #25: Unicode and Mathematics

• Check overall TR format. The Bar should look like the above. The words "Technical Reports" should link to the main reports page

From this point, the TR body should be enclosed in a <div class="body"> element in order to provide a left margin. (This TR template has such a body element.)

Check status (either Draft or Proposed Draft, Proposed Update, or nothing) and the formatting of the title, e.g.:

Draft Unicode Technical Report #25

Unicode Support for Mathematics

• Check header table contents and format - table must neither be 100%, nor use fixed pixels or it will not display/print correctly (the table below uses 95% width):

• UAXs, when updated, should have the Unicode Version.

Version	1.0
Authors	Barbara Beeton (bnb@ams.org), Asmus Freytag (asmus@unicode.org), Murray Sargent III (murrays@microsoft.com) (not updated every time)
Date	2002-05-08 (always use ISO format)
This Version	http://www.unicode.org/reports/tr25/tr25-5.html (also check the link; it should be the same number)
Previous Version	http://www.unicode.org/reports/tr25/tr25-4.html (also check link; it should be the previous number)
Latest Version	http://www.unicode.org/reports/tr25 (check link)
Tracking Number	5  (must match the file name of "This Version" and must link to Modifications section below)

Summary

• All reports must have a summary (gray text is TR specific example).
• Text of the Summary and Status sections should be italic.

Starting with version 3.2, Unicode includes virtually all of the standard characters used in mathematics. This set supports a variety of math applications on computers, including document presentation languages like TeX, math markup languages like MathML, computer algebra languages like OpenMath, internal representations of mathematics in systems like Mathematica and MathCAD, computer programs, and plain text. This technical report describes the Unicode mathematics character groups and gives some of their default math properties.

Status

• Check that status section matches status in title, either Draft, Proposed Draft, Proposed Update, or final (text must match the sample text given here)

This document has been reviewed by Unicode members and other interested parties, and has been approved by the Unicode Technical Committee as a Unicode Standard Annex / Unicode Technical Standard / Unicode Technical Report. This is a stable document and may be used as reference material or cited as a normative reference by other specifications.

Alternate Paragraph for not-yet approved documents. Replace the above if needed, and delete this table.

This document is a proposed draft / draft / proposed update / proposed update of a previously approved Unicode Standard Annex / Unicode Technical Standard / Unicode Technical Report. Publication does not imply endorsement by the Unicode Consortium. This is a draft document which may be updated, replaced, or superseded by other documents at any time. This is not a stable document; it is inappropriate to cite this document as other than a work in progress.

A Unicode Standard Annex (UAX) forms an integral part of the Unicode Standard, but is published as a separate document. The Unicode Standard may require conformance to normative content in a Unicode Standard Annex, if so specified in the Conformance chapter of that version of the Unicode Standard. The version number of a UAX document corresponds to the version number of the Unicode Standard at the last point that the UAX document was updated.

Alternate Paragraphs for other types of TRs. Replace the above if needed, and delete this table.

A Unicode Technical Standard (UTS) is an independent specification. Conformance to the Unicode Standard does not imply conformance to any UTS. Each UTS specifies a base version of the Unicode Standard. Conformance to the UTS requires conformance to that version or higher.

A Unicode Technical Report (UTR) contains informative material. Conformance to the Unicode Standard does not imply conformance to any UTR. Other specifications, however, are free to make normative references to a UTR.

Please submit corrigenda and other comments with the online reporting form [Feedback]. Related information that is useful in understanding this document is found in [References]. The latest version of the Unicode Standard is found on [Unicode]. A list of current Unicode Technical Reports is found on [Reports]. For more information about versions of the Unicode Standard, see [Versions].

Contents

• Each TR must have contents section

1. Overview(check each link)
2. The Checklist
   1. A Subsection if needed
3. ..... TR specific contents ....
4. References      (required section, not numbered, also check link
5. Modifications    (required section, not numbered, also check link)
   

1 Overview 

This technical report starts with a discussion of the mathematics character repertoire incorporating the relevant block descriptions of the Unicode....  [ TR SPECIFIC CONTENTS ELIDED]

2 The Checklist

This section contains an item-by-item checklist of critical things to watch for in TR updates.

1. Top Part
   1. Make sure that there is a stylesheet link:
      • <link rel="stylesheet" type="text/css" href="http://www.unicode.org/reports/reports.css">
   2. Set the charset to UTF-8 (In Frontpage, right-click>page properties>language>HTML encoding.
   3. Above the title, make sure that the status is properly reflected (draft, proposed draft, proposed update, etc).
   4. Verify that the link in the navigation bar points to the TR directory, not to a specific version.
   5. Update the version number in the header table.
   6. Update the author list if this has changed.
   7. Update the tracking number. (Tracking numbers must match the filename and must link to the Modifications section, see below.)
   8. Check the links in the header table to make sure that Latest Version points at the directory of the TR and This Version points at the file itself, and Previous Version points at the previous HTML file.
   9. Check the date (and time) in the header table.
   10. Verify that the Status section reflects the new status (proposed draft, proposed update, etc) and has the proper boiler plate paragraph to go with that status.
   11. Have one line in the Contents for each section (<h2>) and subsection (<h3>). These are to be linked to the section/subsection.
2. Changing Status
   1. If the update is to Proposed Update, go through the checklist at: http://www.unicode.org/~book/logistics/changing_to_proposed_updates.htm
   2. If the update is from Proposed to another category, remove the word "Proposed" from the heading. Unless they are all now listed as "UTR" in page properties, the title needs to be checked and updated there as well. This is really easy to forget. Mark says: This is too error-prone -- we should just have the <title> stay static; no versioning, no "proposed" or "draft".
   3. If the update is a new TR, then ask Julie to update main TR page so that the new number is reflected in the left navigation bar. (Julie needs to know about any status change to the main TR page. Mark says: If it changes status at all, Julie needs to update. E.g. proposed to accepted, etc.)
3. Body
   1. Each section, subsection, etc. should have an anchor (aka bookmark) that will be linked from the table of contents. Use short, descriptive phrases for the anchor, without reference to the number of the section. Try not to change the anchors from version to version. Check section numbering to make sure it matches the contents.
   2. Check all table formats: no table must be set to 100% wide, nor may it use fixed pixel widths or it will not display/print correctly
   3. Verify that all images can be viewed.
   4. You can use the following style of HTML for images of the representative glyphs in the Standard, such as or :
                   <img alt="03E2"
                src="http://www.unicode.org/cgi-bin/refglyph?24-03E2"
                style="vertical-align:middle">
      (Note: The  integer "24" refers to the point size of the representative glyph, but at this time, only 24-point glyphs are supported. "03E2" is the Unicode character hex value.)
   5. Add the appropriate References (and remove ones that are not referenced). The standard style is: "For more information, see Unicode Frequently Asked Questions [FAQ]." The link on the long title is a direct link, the link on the abbreviation goes to the references. You can omit the direct link if it is cumbersome.
   6. Don't use typewriter style:
      1. Only use a single space after the end of a sentence.
      2. Use real punctuation instead of the ASCII fallbacks if possible. For example:

         Publishing	ASCII
         questions—and answers—about	questions--and answers--about
         “phthisic”	"phthisic"
         ‘fish’	'fish', `fish'
         can’t	can't

4. Tables

   1. Tables that contain code can use class="syntax". To set a class in FrontPage, select the table, right-click, table properties, Style..., class

      x y	the sequence consisting of x then y
      x*	zero or more occurences of x

   2. Examples can use class="example"

      Examples:

      [a-z | A-Z | 0-9]	Match ASCII alphanumerics
      [a-z A-Z 0-9]
      [a-zA-Z0-9]
      [^a-z A-Z 0-9]	Match anything but ASCII alphanumerics
      [\] \- \ ]	Match the literal characters ], -, ','

   3. Lists can use class="values"
      

      Abb.	Long form
      L	Letter
      Lu	Uppercase Letter
      Ll	Lowercase Letter
      Lt	Titlecase Letter
      Lm	Modifier Letter

   4. To get a table with no border, set the style to be noborder. The same for a cell with no border. 
5. End Part
   1. Verify that the References and Modifications sections exist and are populated.
   2. Verify that certain tables and their cells both have style set to "noborder". These include the References and Modifications sections at the end.
   3. Set the Modifications number to the new tracking number and list the modifications in the section at the end.

1. Validity
   1. Check that the TR file validates with the W3C HTML validator and CSS validator (accessible from the HTML validation results page).
   2. Then run Checking Bookmarks for Validity. That will verify that all links in the body of the report, both internal and external, are valid.

References

• References is a required section. It should not be numbered. Entries for FAQ, Feedback, Glossary, Reports, Unicode, and Versions are required entries.
• References is a table and should have cell and table styles both set to "noborder" and have ample cell spacing (e.g. 12).
• A specific file that is part of the UCD needs needs two links. See the boilerplate language under [NormProps].
• The References shown here are frequently used; this table may be copied and modified for new reports.
• The items marked in yellow below need to be added if they are not present.

[Charts]	The online code charts can be found at http://www.unicode.org/charts/ An index to characters names with links to the corresponding chart is found at http://www.unicode.org/charts/charindex.html
[Feedback]	Reporting Errors and Requesting Information Online http://www.unicode.org/reporting.html
[FAQ]	Unicode Frequently Asked Questions http://www.unicode.org/faq/ For answers to common questions on technical issues.
[Glossary]	Unicode Glossary http://www.unicode.org/glossary/ For explanations of terminology used in this and other documents.
[NormProps]	Derived Normalization Properties The file version at the time of this publication is: http://www.unicode.org/Public/3.2-Update/DerivedNormalizationProps-3.2.0.txt The latest version of the data file is: http://www.unicode.org/Public/UNIDATA/DerivedNormalizationProps.txt
[Reports]	Unicode Technical Reports http://www.unicode.org/reports/ For information on the status and development process for technical reports, and for a list of technical reports.
[UCD]	Unicode Character Database. http://www.unicode.org/UCD For and overview of the Unicode Character Database and a list of its associated files
[Unicode]	The Unicode Consortium. The Unicode Standard, Version 4.0. Reading, MA, Addison-Wesley, 2003. 0-321-18578-1.
[Versions]	Versions of the Unicode Standard http://www.unicode.org/standard/versions

Modifications

• This is a required section - it should not be numbered, make sure it contains a list of the latest modifications. Make sure that it has a bookmark that is linked from the header table.

The following summarizes modifications from the previous version of this document.

1	Sample version

---

• The copyright is a required section. Check format, boilerplate and copyright date (if more than one year is given, the last one should be the current year.)

Copyright © 2001-2003 Unicode, Inc. All Rights Reserved. The Unicode Consortium makes no expressed or implied warranty of any kind, and assumes no liability for errors or omissions. No liability is assumed for incidental and consequential damages in connection with or arising out of the use of the information or programs contained or accompanying this technical report.

Unicode and the Unicode logo are trademarks of Unicode, Inc., and are registered in some jurisdictions.