Milestone Schedule

Survey Tool Guide

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).

Note that some companies won't use the date until it is complete at a certain coverage level, such as modern.

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, something like the following. 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.


Key

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 a 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

Approved value The "Proposed" (winning) value will be in the release.
Contributed value The "Proposed" (winning) value will be in the release (with a slightly lower status).
Unconfirmed value There is a "Proposed" (winning) value, but it doesn't have enough votes. The data will typically be discarded by implementations, and treated like Missing Value, below.
Missing value There is no winning value. The inherited value will be used.
  • For region locales (like fr-CA), this is fine, since they only need a value if it would be different than the language locale (like fr). 
  • For language locales, this means there is no value, so users will typically see a code, like "DE" for Germany.
Last Release’s value The value from the last release.
Voted-for losing item This at least one vote for this value, but it is losing (in the "Others" column).
Warning There is a mechanically detected warning for the value. Please review to see if it needs to be changed.
Error There is a mechanically detected error for the value. If an item you try to submit has an error, you'll have to change it.

Colors

BE Winning (proposed) value
zh_Hans Missing value (inherited from Root)
E d Aliased value (from another value in this locale). For example, "stand-alone" values may inherit from "format" values.
1 295,00 EUR Example of use in context. This is only an example: be sure not to translate this.

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.
In summary, to vote for items:
  • Click on a cell in the 'Code' column.
  • Read the details that appear for that row.
  • To vote for an existing item in the Proposed or Others column of that row, click on the  for that item.
  • To vote for a value not already shown in that row, click on any other text item in the Proposed or Others column of that row. A new editing box will open, and you can enter a new value; you will automatically be voting for it once you hit RETURN on your keyboard.
  • To abstain (including retracting a vote), click on the  in the Abstain column.
  • Don’t worry about incorrect values that aren't winning (eg in the Proposed column). They will disappear later on.
(These instructions also appear in the detail pane of each Page, when the Page is first opened.)

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 "for more information" 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. Use this especially during the Vetting phase if the correct item is present, but not winning: that is, it is not in the Proposed column. When you request other users to vote for an item, be sure to say why you think it is better.


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.

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