Survey Tool Guide


Survey Tool | Accounts | Guide | FAQ and Known Bugs 


This page explains the different views used in entering in CLDR data. The exact appearance in screenshots may change as the tool is enhanced over time.

Please read the home page of the Translation Guidelines before starting your data contribution.

Navigating the Survey Tool and Workflow

Login

  1. Go to http://st.unicode.org/cldr-apps/survey/ and log in.

    Login

  2. For your first login for this version of the CLDR tool, you may be asked if you want to import old votes.
    • If you have submitted votes in the previous releases, you have the option to carry forward your votes from the previous CLDR data submission period and you don't have to vote on each item again. 
    • By default, all of your votes that match the most recently published CLDR value will be pre-selected and can be imported with a single click. 
    • Any non-winning votes from previous vetting can also be reviewed and imported as well, but these should be reviewed individually to see if they are the correct value.

Picking Locales

  1. On the left sidebar, you will see the CLDR locale(s). Your default view will be the languages you have permissions for. All the locales that you have permission to contribute submissions to are marked with PENCIL icon. You can view the others but not submit contributions. For example, if you have permissions to the default language Afrikaans (af), you will not have permissions to Afrikaans (Namibia), and vice versa.

  2. Each language is followed by a list of regions that represent specific locales. The locale that is grayed out and preceded by an × is the default. The others are considered “sub-locales”. If you are working on the default locale, select the language name. For example, if you work on Spanish in general (default = Spain), you will see that that Spain is grayed out in the list below: choosing Spanish means that you are working on the default (Spanish for Spain).

    default locale

  3. Only those of you working on a specific variant language (or "sub-locale") will pick a non-default region. If you work on Mexican Spanish, pick Mexico. (This should already be pre-selected for you.)
Make sure that you haven't mistakenly turned the Information Panel off! See No Information Panel.

Main Sections

  1. Once you have selected your locale, more options show up in the left sidebar. (You’ll note that the sidebar only shows if you mouse over the > character on the left.)
  2. If the locale is relatively new and very complete, start working on the Core Data section and go through the rest of the sections. If the locale is mostly complete, then go to Dashboard below.
  3. Once you have selected a section, you'll see a table to enter votes in. The main table has these columns:

    1. Code: the code CLDR uses to identify this data point.
    2. English: the plain English value of the data point (the text you are to translate).
    3. Abstain: the default vote value for you. Only use abstain if you don't know a good value to be used.
    4. A: The value’s current status. A checkmark means it’s approved and is slated to be used. A cross means it’s a missing value. (Note, for sub-locales, a cross is not necessarily bad. If the parent locale has a good value, the sub-locale will inherit it. Check the Winning column.)
    5. Winning: this is the currently winning value. If the survey tool would close now, this is the value we would publish. If the value has a blue star next to it, that means it’s also the value that was published in the previous version. Normally it takes at least two votes from two different organizations to change value: in some locales the bar is lower, and for some items it is higher.
    6. Add: If the winning value is not correct and is not listed under Others, then use the plus button here to enter the correct value. If you enter a new value, your vote will be applied to it automatically.
      • If what you want is a variation of what is in Winning or Others, you can cut & paste, and then modify.
    7. Others: other suggested values, not currently winning, but available to vote for. 
  4. Click on one of the radio buttons to make your vote. The winning status changes in real-time so depending on vote requirements and existing votes, your vote may move your desired value to the winning column right away.
  5. Look at the Regional Variants to see if any should be changed: see Information Panel below.
  6. Once you are done with all the sections, go to the Dashboard.

Icons

The main panel uses icons to indicate important information and possible problems. After clicking on the Code cell, look to the right-side info panel for more details.

 
Icon Description
⊗ There is a serious error in the translation.
⚠ There is a warning on the translation. This might or might not indicate a problem.
ⓘ Hover over this icon to see important information about translating the item.
ⓔ Hover over this icon to see an example of the item in context. This is also important for correct translation.
✓, ✓ The item has enough votes to be used in CLDR.
✘, ✘, ✘ The item does not have enough votes to be used in CLDR, by most implementations (or is completely missing: ✘)
⚐ Committee approval is needed for this item. Click the button in the right-side info panel to request approval.
✩ The item was Winning in the last release of CLDR.

(Icons for the Dashboard are listed in the Dashboard Icons section below.)

Information Panel

  1. If you hover over an item (including the English item), a tooltip will appear showing a sample value and usage of the item in context. The item itself will have a white background; other text in context will have a gray background.
  2. When you select an item (the text, NOT the radio button), additional information will show in the right-hand Information Panel. See screenshot below. 
     
  3. Make sure you use a wide-screen monitor and enlarge your window until you can see it, something like the image below.
     
  4. The box at the top shows information about the code you are translating. It also has a link that you should click on the first type you encounter that kind of item that will explain any "gotchas".
  5. If there is an error or warning for the item, you see that in the middle.
  6. Below that, you'll see an example. This is the same as you get by hovering over the item in the center section.
  7. If there are votes, you'll see a breakdown of them; you also see the number of votes required to change the value. Unicode organization members usually have 4 votes; others usually 1. Your vote value and the vote value required for change will show on the right navigation for the selected item as shown in this screenshot (4 and 8 respectively in this case).

    ST vote values

  8. Near the bottom, you'll see a pulldown menu that shows the values for different regional Variants. Here, you can quickly compare the values and go to different sub-locales to correct inconsistencies.

  9. You'll also see the New Forum Post button (as shown in the screenshot above). This is the easiest way to post discussions for the selected item. Remember that the Forum posts are at language level and not at Sub-locale level. For more information, see Forum.

Inheritance

Some items are by default inherited from other places in the data. You have the option of voting for the inherited value or entering a different one.
 
The inherited values are color coded:
    1. Darker The original is from a parent locale, such as if you are working in Latin American Spanish (es_419), this value is inherited from European Spanish (es).
    2. Lighter The original is in the same locale, but has a different ID (row).
    3. Red The original is from the root.
     
    You can click on the link in the right sidebar to see the original value.
     
    Note: Voting on inheritance means "always use the inherited value, even if it changes.” An inheritance vote is advised if there are no differences in spelling conventions and political relations between your locale and the parent locale. Voting for inheritance minimizes duplication of data.

    Regional Variants (also known as Sub-locales)

     
    Language variants by Region are differentiated as Parent-locale and sub-locales. For example,
    • Spanish es is the parent (or the default) locale for all Spanish locales. Its default content is for Spanish (Spain) es_ES.
    • Spanish (Latin America) es_419 is one of the sub-locales for Spanish. Votes on inheritance will ensure that it will only contain content that is different than what is in Spanish.
    • Spanish (Argentina) es_AR is one of the sub-locales for Spanish (Lain America). Votes on inheritance will ensure that it will only contain content that is different than what is in Spanish (Latin America)
    The regional variants menu for a data point is shown on the right navigation information pane. It will look something like the following (the exact appearance depends on the browser).

     
    When you pull it down, it will show which regional variants have different values than the main language locale. The current locale will show as darker gray as shown in this screenshot below
     

    In the example in the screenshot above, Switzerland and Liechtenstein have different regional data than German (=Germany).  Hover over the menu item to see the value it has. In the above diagram, you'll see "." as the decimal separator for Switzerland in the yellow hover box above as shown in the screenshot above.
     
    If any values are incorrect, please correct them. You can do that by selecting the menu item, which will take you to the same item, but in the regional locale. For example, selecting “Belgium” above goes to the decimal separator for German (Belgium). You can then correct the item.
     
    Normally, the only values that should be different are in date and number formats. In some locales there are other variations: for example, German (Switzerland) spells words with “ss” instead of “ß”, so differences can occur on many different pages.

    Regional Inheritance


    If you are voting in in a sub-locales such as en_AU, es_MX etc.. you have two options on how you vote:  

    1. a vote to actively follow whatever the translation is for the locale you inherit from. You do this by voting for the translation highlighted in blue box. When you do this, you are essentially saying "always use the inherited value, even if it changes in the source parent value". Only vote for the blue value if you feel confident the parent value will always be suitable for your locale. In the screenshot below, this is the case for the vote for "inglês".
    2. vote for a firm value in your locale, that should not follow the parent locale. You do this by simply clicking the plus button and enter the value you want. This could be the same value as what is currently being inherited, but this shows that your locale should not change with the parent value. When you do this, you'll notice after your vote that the value is not highlighted in blue, indicating it's a hard vote, as in the case of "embu" shown in the screenshot below in the Winning column.

     
     
    Importance of Voting for inheritance (option 1 above)


    An inheritance vote is useful if there are no differences in spelling conventions and political relations between your locale and the parent locale. Abstaining from voting may have the same effect, but if another vetter votes for something different, your Abstained vote means that it's not opposed by you; thus, your intention is not known to others. By voting for the blue inheritance value you make your opinion known to other vetters.
     
    • Inheritance is important, to prevent data duplication.
    • Inheritance is not only limited to “sub locales”. Parent locales (or default language locales) also have inheritance from either other fields or the root.
    • By default, all data are inherited if there are no contributions. The data are indicated as Missing or Abstain. Sub-locales have inherited values that are generally from the parent locale (e.g. de_CH will inherit values from de_DE).
    • The inherited values appear in the Others column highlighted in blue box (e.g. “embu” and "inglês"). By clicking the radio button in front of those values, you are voting for inheritance.
    • If the inherited value is not correct for your locale or it’s likely for your locale to change the data in the future, click the + button, and enter a new suggestion (this is considered as a hard vote and will be retained as the value for the sub-locale even if the value in the parent-locale changes ).

    Dashboard

    The Dashboard will show you a list of data items with warnings of different kinds. Some will require action, some may be false positives. (For the veterans, this is the redesigned Priority Viewer.) 


    The goal is that you should work the Dashboard down to show zero items, then review the Reports, below.

    The first priority is to fix all the Missing items by supplying the correct translations.

    Dashboard Sections

    Go through each of the sections to address the problems. These sections are explained below.

    At the top of each section is an arrow symbols to show the items in the section, the title (such as Missing), the number of items, and an "Unhide" button. Below that header are a series of rows.

    Dashboard Columns

    There are five columns in the Dashboard view.
    • Code: this links to the field in survey tool. Click on it to go to the item in the Survey Tool.
    • English: this is the English value 
    • CLDR XX: The previous version’s value. In the below screenshot, this is indicated as CLDR 31
    • Winning XX: The currently winning value. In the below screenshot, this is indicated as Winning 32. If the currently winning value and previous version’s value are equal, then the winning value is shown with “=”.
    • Action: There are  3-4 action buttons, as shown in the screenshot below on the right.


    Best practices for handling items in each category

    • Missing

    These are items where there is no localization provided by any contributor. Click on the blue Code on the left (such as Famagusta in the screenshot below). It opens a new window with the survey tool where items are highlighted and you can add a translation. When you fix a Missing item it will turn to New.

    • Losing

    These are items that you already voted on. This indicates that your vote is not for the currently winning value. If you can live with the winning item—if it is reasonable, even if you don't think it is optimal—chang your vote to be for the winning item. If not, click the Forum button and give reasons for people to change their vote to what you have suggested. If not all users have voted yet, these values may still be approved before the end of the cycle. Engage with others on the Forum discussions. Make sure to post the reasons why others should change their votes and respond to others’ postings. You can list a number of items in the same forum post, to make it easier for people to read.

    • Disputed

    This is very similar to Losing, except in this case your vote is winning and someone else's is losing. Review all of the items to see if someone else’s item is better and read the forum posting, and whether you want to change your vote. Discuss in the forum, then use the Hide button to hide disputes you’ve addressed in the forum.
    • New

    The New items are the newly entered items for this release. These are provided in Dashboard only as a reference. You don’t need to look at them if you will be going through all the pages that you need to vote on.
    • English Changed

    These are items where the English source has changed. You need to re re-checked in order assess the impact to your language and update as appropriate.
    • Warnings

    These are issues which appear after automatic checks.  (For examples, a message could be "The value is the same as English", which is a quite common warning for languages that are close to English in the spelling of languages or territories. If the value is actually ok, then click on the Hide button (crossed eye). If not, then vote for a fix, or post on the Forum for discussion.




    Dashboard icons


    Icon Description
    Code: This will bring up a new main window with the context for the item, where you can make changes.
    Fix: This will bring up a Quick Fix Panel where you can change or edit your vote (see below).
    Hide: If you are sure that the warning is a false positive, you can hide it from view. Click on the other eye button on top of the section to unhide hidden lines.
    Forum: Enter a forum post to be seen by other linguists regarding this specific item. This is useful if your item is losing and an incorrect item is about to win. Also use the forum to discuss the translation with other vetters.
    Info: Warnings or errors will have additional info here.

    Quick Fix Panel

    If you click on the Fix button, you'll see a pop-up Quick Fix Panel like the following.
    This Action panel on the right shows a summary of what you'd see in the main page for the item, and allows you to make a quick change. If, however, you haven't changed an item of this type before, it is best to click on the link at the top to go to the main page for the item. That way, you can see other items of the same type.










    Summary

    There are two ways to clear items from the Dashboard list:
    1. fix them (such as adding a translation for a missing item)
    2. hide them (such as when the English has changed but the translation doesn’t need to change).
      • Only hide items if it really is a false positive, not because you gave up on fixing it…
      • If you hide an item by mistake: 
        • Unhide all the lines with the top eye button.
        • Click on the orange eye button in the line (a “Show" tooltip will appear).
        • Hide all the lines again by clicking the top eye button.

    Reports

    The reports show lists of items that need to be reviewed for consistency. You should look through these after you do the Dashboard to make sure that the items are consistent, when viewed in the context of others. Each of them has a link to instructions at the top. Please read these before continuing.

    Example:




    Special Notes

    Capitalization

    Translations should be what is most appropriate for ”middle-of-sentence” use. So, for example, if your language normally doesn't spell languages with a capital letter, then you shouldn’t do that here. Please see Capitalization for more details.

    Plurals

    For important information regarding the use of plural forms for your language, please read Plurals.

    Problems

    If you find a problem, you may want to review FAQ & Known Bugs to see whether it has already been reported (and whether there is a work-around). If not, or if you have suggestions for improvements, please file a bug using the Feedback link at the bottom of each window. If you encounter problems or have enhancement suggestions for the survey tool, please file a ticket.

    If there are other issues, you can raise them on the Unicode CLDR Mailing List.

    For unofficial SurveyTool support, visit #cldr on freenode webchat — Once connected, enter your text at the very bottom of the page, and press the enter key to send text). Alternatively, use your own client to log into the #cldr channel on the freenode.net network.

    No Information Panel

    If you click on the Code cell and there is no Information Panel, you may have turned it off accidentally. Go to the Gear icon at the top and make sure that the Toggle is set right.

    Screen Shot 2014-06-06 at 17.05.53.png

    May not be modified—see details

    You may sometimes see a message that indicates that you cannot take any action. For example "May not be modified-see details" as shown in the screenshot below. This indicates that the item is particularly sensitive and has a broader impact, and require Technical Committee review. To handle them, read the details shown in the right-hand information panel. 




    To change it, you have to flag the item for committee review:
    1. Click on the “Flag for Review button”.
    2. On the new page, you'll see a message box.
    3. Enter the change that you want to make, and the justification for it.
    4. Then click “Post”.

    Forum

    After the data submission phase, any differences in the submitted data will be resolved according to the data resolution processHowever, you should collaborate with the other translators where you have questions, via email and the Forum.

    Forum is the place to discuss issues in your language. Use the Forum for general topics and consistency questions, including proposed changes and new suggestions. When you make a forum entry, it will be emailed to all other linguists working on locales with the same language, parent or sub-locale (i.e. forum is at Language level and not at sub-locale level). If you are talking about a translation in a sub-locale, be sure that you are clear about that.

    A best practice is to create a Forum post whenever you propose a change to a previously approved value, and provide an explanation and links to references, if available. Including the value itself in the body of the post will make your suggestion clearer, even when viewed outside of the detailed view. Your post will alert other participants to the proposed change, and encourage them to vote to approve it, or to explain why they support a different variant.
    • To create a Forum post linked to a special data point, click on the item in the Survey tool or in the Dashboard, then click the New Forum Post or use the Forum entry point in the left-navigation as shown in the screenshot above.



    • If a new post from another user proposes a change you agree with, there is no need to respond, because you can simply vote to approve. Inside the Forum window, you can click the Item link in the post to open a detailed view of the item and see voting status.


    • Another way to check for posts that may need your attention is to review email notifications to the e-mail account for your locale. You can delete these notifications if they are for changes initiated by you. You can open the post directly from a link in the email.

    Forum Etiquette

    While creating New Posts on Forum or participating in discussions please follow these general etiquette guidelines for best productive outcomes:
    • Be professional. Provide accurate, reasoned answers so that other participants can easily understand what you are talking about.
    • Be courteous. Refrain from inappropriate language and derogatory or personal attacks.
    • Don’t “SHOUT”; that is don’t use all capitals.
    • In case of disagreement, focus on the data and provide evidence to support your position. Avoid challenges that may be interpreted as a personal attack.
    • Be prepared to have your own opinions challenged or questioned, but don’t take answers personally.
    • It’s possible that participants have different expectations on the intent of the data. Clarify what you think is the intent may help especially if disputes continue.
    • Remember that open discussion is an important part of the process; abiding by these guidelines will encourage active participation by all vetters and a better end result.
     


    Old Forum Posts

    Forum posts from the most recent Survey Tool release can be accessed using the Old Forum Post navigation in the left-navigation pane.

    (This is a new feature introduced with CLDR v32 data collection, May 2017.)

    Old Forum Post Navigation


    There are a few known limitation that you should know:
    • The old forum posts are not linked from individual items or the current Forum. But it but you can navigate To the item from the old post.
    • The old forum posts are only from the most recent data collection release. For example, if you are contributing to CLDR v32, the old forum posts are discussions from CLDR v30.
     

    When to use the Old Forum Posts

    Here are a few sample cases when you may want to use the Old Forum Posts:

    • You remember postings in the last contribution period, and you want to refresh your memory.
    • You don’t agree with the current Approved item, and you want to see if your new suggestion was already discussed in the last period.

    Ways to use the Old Forum Posts  

    Here are a few tips for using the Old Forum posts:

    • Search for the item using the browser search feature (CTRL+F)
    • Search for your profile name, the Term, or the data category path (For example, Currencies)
    • Click on the Item link on the right side of the post to go to the item directly. The item will take you to the current version of the data.
    • Click on Reply to continue the thread. This action in the Old Forum Posts will post a new thread in the current Forum. Go to Forum to see your posting of the reply. Your reply will not be shown in the Old Forum Posts even though you initiated the Reply there. This ensures that your thread will be captured for the current release.
    • The last TC user action on a thread typically means that it was discussed by the committee, and actions were taken to resolve errors. This does not mean that you can reactivate the discussion if you do not see a resolution on discussions among linguists.

    Advanced Features

    1. Users familiar with CLDR XML format can upload votes (and submissions) for multiple items at once. See Bulk Data Upload.
    2. Organization managers can manage users for their organization (add, remove, send passwords, set locales, etc.) For more information, see Managing Users.
    3. CoverageSome users may want to reset their Coverage Level, with the menu that looks like the image to the right.

      The Coverage Level determines the items that you will see for translation: the minimal level has the highest priority items. You normally start with the level marked "Default" (which will vary by your organization and locale). Each successively higher level adds more items, at successively lower priorities. You will not normally go beyond "Modern", unless you have special instructions for your organization.

      Note that some companies won't use the data until it is complete at a certain coverage level, typically Modern.








































































    Comments