Milestone Schedule

Date Phase
2013-03-15 v23 Released
2013-09-18
 v24 Release

Survey Tool Guide

Contents

  1. 1 Main Page
    1. 1.1 Coverage Level
    2. 1.2 Navigation
  2. 2 Page View
    1. 2.1 Column Key
    2. 2.2 Icons
    3. 2.3 Entering new values
    4. 2.4 Detail Panel
  3. 3 Forum
  4. 4 Manage page
    1. 4.1 My Account
    2. 4.2 Import my Old Votes 
    3. 4.3 My Recent Activity
    4. 4.4 Manage Users or List Users
    5. 4.5  If your account has sufficient privileges, you can list or modify information about other users in your organization. See the Managing Users page.
    6. 4.6 Statistics
    7. 4.7 Upload XML
    8. 4.8 Priority Items Summary
    9. 4.9 RSS Feed
    10. 4.10 Coverage, Show Delete, Show Controls, "Advanced Options", etc...
This page explains the different views used in entering in CLDR data. The exact appearance may change as the tool is enhanced over time.

See also, What's New.

Main Page

The main page (http://st.unicode.org/cldr-apps/survey) will look something like the following. You can pick the locale to work on there.


You can look at any of these locales, but you can only submit changes ("edit) to the ones with an "edit" icon. For example, below the icon indicates that you can edit German, German (Austria), German (Belgium),... Greek, and so on. You can't edit Gujarati with this account, for you that is read-only. Note that you also can't edit German (Germany) or Greek (Greece). That is because these are default content locales: their contents are in German and Greek, respectively.


Coverage Level

Once you pick your locale, at the top-left, you'll see your current Coverage Level, which looks something like the following:


The Coverage Level determines the items that you will see for translation: the minimal level has the highest priority items, and the fewest. Each successively higher level adds more items, at successively lower priorities. The comprehensive level includes all the items. You normally start with "Automatic" (which may vary by your organization and locale).

Navigation

Once you start on a particular locale, most windows have a navigation bar at the top. It looks something like the following:



Under the General Info button you can change to the main navigation sections: Code Lists, Calendars, Time Zones and so on. Each has a submenu where you can go to the pages in that section.

Picking "CLDR Survey Tool" goes back to the main page.

Page View

Below the navigation, you'll see a number of columns. If you are looking at a read-only locale, some columns and icons don't show up.

You can resize the window panes by dragging them.


Column Key

Each column contains information which can help you to find values and vote for them. Most of the buttons have a short explanation if you "hover" your mouse over them. When clicked (outside of the voting buttons), the detail box is updated, which we'll talk about in a moment.

Code This is an code that indicates what you are voting for. That is, even the English is a "translation" of this code. It is sometimes a longer value, like available date formats:[@id="Hm"] 
English  The corresponding English value. 
To Vote
 
For each of the following, pick the voting button to register a vote. The filled-in button indicates what your current vote is.
Abstain  To remove your vote from other items, vote Abstain. 
Proposed   The current "winning" value.
Others   Other values that have been proposed, but don't have enough votes to win.

Icons

Alert[Warning] There is at least one mechanically generated warning message for this value. If an item you try to submit has a warning, you should look carefully at it. This icon may also show up attached to an item in the Others or Change columns. 
Errors[Error] There is a mechanically detected error with the value. If an item you try to submit has an error, you'll have to change it. This icon may also show up attached to an item in the Others or Change columns.
Approved[OK] The current Proposed item will be approved for the release, unless votes change.  
Approved[Unconfirmed]The current Proposed item will not be approved for the release, unless it gets more votes.

Notes:
  1. The green outline indicates the winning value.
  2. A black outline over blue indicates that the item is "inherited". For example:
    1. Most values in German (Austria) would be inherited from German.
  3. A  red outline indicates that the item is completely missing.
    1. Some values in German may be missing, and thus get a "neutral" value from what is called root.
  4. A light shading indicates a special alias. For example, the stand-alone names may inherit from the format names [TBD] 
  5. Examples of the use of a value in context may appear below the example, such as 1:25 PM Zentralafrikanische Zeit. 

Entering new values

To enter a new value, click on any existing item. If you have permission to change the text, it will turn into an editable text box. Press the Enter or Tab key to accept your value, or press the Esc key to cancel your change. You will automatically vote for any change you make, you don't have to click your value.

Detail Panel

The Detail panel on the right side shows the status of the currently selected cell. For example, the cell below has a warning, indicated by the warning icon. Clicking in the cell fills the detail panel with a message. The first line of the message is for general information about the whole row. To avoid problems, please read the referenced page at least once. The rest of the detail panel gives information depending on the particular cell. In the case below, it show more information about why there is an alert.

Forum

The SurveyTool forum allows you to communicate with other Vetters . . .
(This section under construction.)

Manage page

These are less commonly used features, which are accessed from the "Manage" link in the SurveyTool. They include features for managing your account and other user's accounts, if applicable. (Note, the documentation in this section is still being written as of SurveyTool 24.) 

My Account

This page lets you view, and for some users, modify information about your account. For more information, see the Managing Users page.

Import my Old Votes 

See the What's New page for a description of this feature.
(This section under construction.)

My Recent Activity

This page gives a summary of recent items you have voted for, as well as a list of all locales you have been active in.
There is also an option to download individual locales you have modified as .XML files, or to download all of your changes as a single .CSV file.

Manage Users or List Users

 If your account has sufficient privileges, you can list or modify information about other users in your organization. See the Managing Users page.

Statistics

This page presents SurveyTool-wide information about vetting statistics.

Upload XML

This page allows you to upload XML files (such as those downloaded in My Recent Activity) to bulk-upload votes on your behalf.
(This section under construction.)

Priority Items Summary

This page shows a summary of items requiring attention.
(This section under construction.)

[feed]RSS Feed

The [feed]RSS Feed link presents an RSS feed with which you can follow forum posts for locales assigned to you, or which you have indicated an interest in. See the section on Forum use.

Coverage, Show Delete, Show Controls, "Advanced Options", etc...

These items are mostly obsolete or not up to date. It's advised to not use these options.
Comments