CLDR-17566 Converting Survey Tool (#4014)

docs/site/index/survey-tool/bulk-data-upload.md

@@ -0,0 +1,94 @@
+---
+title: Bulk Data Upload
+---
+
+# Bulk Data Upload
+
+Here are the instructions for a bulk upload (of an XML file in LDML format) to the Survey Tool. You must be reasonably conversant with XML and the [LDML format](http://unicode.org/reports/tr35/) to use this method.
+
+1. Prepare your xml files \- one per locale. Each file must be valid XML and LDML for a single file. The file doesn't have to be "complete": it might contain only translations of territories, for example.
+	- *(Note: There is a new option that allows you to download from the Dashboard as a spreadsheet, modify the spreadsheet, and then convert that spreadsheet into an XML.  To access this option:<br> In the menu, choose **Upload(Bulk Import)** and then **Convert XLSX to XML**. Follow the steps from there.)*
+2. The locale must exist. 
+	- If not, see [Adding New Locales](https://cldr.unicode.org/index/bug-reports#New_Locales).
+3. You must be logged in, and under an account with permission to write to it.
+	- If you don't have an account, see [Survey Tool Accounts](http://cldr.unicode.org/index/survey-tool/accounts).
+	- Managers and TC Members can submit on behalf of another user.
+4. Go to the menu, under the **Upload ( Bulk Import)**  section. Choose **Upload XML as your Vote**.
+5. Put in your email address to submit as yourself. If you manage other users, you may put the email address associated with their survey tool account in to submit a vote as that user.
+6. Click **Choose File** to pick the XML file for that locale on your locale disk
+7. Click **Upload as my Submission/Vetting choices**
+8. You will see a raw listing of lines in XML, and an error line if the file doesn't validate.
+	1. If the file does not validate, fix the file, hit the back button, and go to Step 4. 	
+	2. If the file does validate, you'll see a list of XML paths and values.
+9. Click **Submit \<locale\>**.
+10. You will see a detailed list of the test results for the items you're submitting.
+	- You can click on an item's path link (left hand side) to view that item in the surveytool
+	- Any items with an error icon  will not be submitted.
+	- If the message is "Item is not writable in the Survey Tool. Please file a ticket." then you will need to [file a ticket](https://cldr.unicode.org/index/bug-reports#TOC-Filing-a-Ticket) instead. These can be filed in a single ticket. Include all the paths and the respective values.
+	1. Press "Really Submit As My Vote" to submit all passing items as your vote, or revise the file and start back at Step 4. 
+
+### Example XML:
+
+```xml
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<!DOCTYPE ldml SYSTEM "../../common/dtd/ldml.dtd">  <!-- Not important. Latest DTD will be used. -->
+
+<ldml>
+
+  <identity>
+
+    <version number="$Revision: 6546 $"/> <!-- ignored -->
+
+    <generation date="$Date: 2012-02-07 10:32:35 -0800 (Tue, 07 Feb 2012) $"/> <!-- ignored -->
+
+    <!-- CRITICAL: you must supply a valid identity block specifying language,
+
+          and if part of the identity, the script, region, variant, etc. -->
+
+    <language type="aa"/>  <!-- Required -->
+
+  </identity>
+
+  <localeDisplayNames>
+
+    <scripts>
+
+      <!-- The draft attribute and alt=proposed value are ignored. Comments are ignored.  -->
+
+      <script alt="proposed-ABCDEF" type="Latn" draft="unconfirmed">Latin</script>  <!-- OK. -->
+
+      <!-- The rest indicate errors people might have. -->
+
+      <script alt="proposed-ABCDEF" type="Mong" draft="unconfirmed">Latin</script> <!-- ERR: duplicate -->
+
+      <script alt="proposed-ABCDEF" type="Brai" draft="unconfirmed">Latin</script> <!-- ERR: duplicate -->
+
+      <script alt="proposed-ABCDEF" type="Hant" draft="unconfirmed">Latin</script> <!-- ERR: duplicate -->
+
+      <script alt="proposed-ABCDEF" type="Deva" draft="unconfirmed">Latin</script> <!-- ERR: duplicate -->
+
+      <script alt="proposed-ABCDEF" type="0" draft="unconfirmed">Latin</script>    <!-- ERR: bad 'type' -->
+
+    </scripts>            
+
+  </localeDisplayNames>
+
+  <numbers>
+
+    <defaultNumberingSystem>brai</defaultNumberingSystem>  <!-- ERR: can't change via survey tool -->
+
+  </numbers>
+
+</ldml>
+```
+
+Note: the filename of the XML file doesn't matter
+
+### Example Submission View:
+
+**Note to Organization Managers**: if you are submitting on behalf of another user, clicking these links will switch your user to that user.
+
+![image](../../images/index/bulkDataUpload0.png)
+
+![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)

docs/site/index/survey-tool/coverage.md

@@ -0,0 +1,44 @@
+---
+title: Setting Default Coverage Levels
+---
+# Setting Default Coverage Levels
+
+## Introduction to Coverage Level
+
+- For an introduction to coverage level, see the appropriate section in TR\#35, "[Coverage Levels](https://www.unicode.org/reports/tr35/tr35-info.html#Coverage_Levels)".
+- To see how coverage level is used in the Survey Tool, see "[Advanced Features](https://cldr.unicode.org/translation/getting-started/guide#TOC-Advanced-Features)" in the Survey Tool guide
+
+## To set your organization's default coverage levels
+
+The **Coverage Level** determines the number of items that your people will see for translation in each locale. The best target in general is *modern*: some companies that use CLDR data require coverage at a *modern* level before they will use the locale; others will use data that is less complete, such as *moderate* or *basic*. If it is not feasible to attain modern coverage in a given cycle, it is still best to set the coverage as high as feasible, such as *moderate*. 
+
+The number of items at each level varies by locale, but is roughly the following:
+
+| Approximate Count | Coverage Level |
+|---|---|
+| 200 | minimal/( **also known as Core?** ) |
+| +300 | basic |
+| +200 | moderate |
+| + 1500 | modern |
+
+To see your current coverage levels, look for your organization in [Locales.txt](https://github.com/unicode-org/cldr/blob/main/tools/cldr-code/src/main/resources/org/unicode/cldr/util/data/Locales.txt). It is a simple plaintext file, where each line is of the form:
+
+\<organization\> ; \<language\_code\> ; \<coverage\_level\> ; \<language name \- optional\>
+
+A \# starts a comment, and a \* for the language\_code means "all others".
+
+An organization that focuses on a small number of locales will probably want to have just a line added for those locales, such as: 
+
+Breton ; br ; modern Breton ; \*  ; moderate
+
+To request a change in the default coverage for your locale, file a [new ticket](https://cldr.unicode.org/index/bug-reports#TOC-Filing-a-Ticket).
+
+As part of CLDR v35, the coverage level has been refined further. See ticket \#[11498](https://unicode-org.atlassian.net/browse/CLDR-11498)
+
+1. *Basic Level*. The flexible date and time formats, such as day \+ month patterns, are moved down from *Moderate* to reflect the increased use of these patterns for the minimally viable locale data.
+2. *Modern Level*. Some lesser\-used language names are pushed up to *Comprehensive*. (No data is removed: these are still accessible in the *Comprehensive* level.)
+3. Languages. The following languages have higher target levels, and can have missing items added.
+	1. *Basic Level* : Cebuano (ceb), Hausa (ha), Igbo (ig), Yoruba (yo)
+	2. *Modern Level*: Somali (so), Javanese (jv)
+
+![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)

docs/site/index/survey-tool/managing-users.md

@@ -0,0 +1,127 @@
+---
+title: Managing Users
+---
+
+# Managing Users
+
+If you have a TC or Manager level account, you can manage other translators (users). When data submission starts, you'll want to Lock the users who are no longer active, add new users, and send messages to your users. For the old users you'll want to resend passwords \-\- it is simplest just to do that for everyone once you've added new users.
+
+When you create users, you give them permissions and choose which locales they are to work on. It is also important that you set your organization's coverage levels appropriately, see "[Setting your Organization's Coverage levels](https://cldr.unicode.org/index/survey-tool/coverage)".
+
+## Managing Users
+
+Open the survey tool, and click on the gear icon in the top left, then pick **List \<myorg\> Users**
+
+![image](../../images/index/managingUsers0.png)
+
+The tool is still a bit awkward to use, so ask if you have any questions. Note that you shouldn't use your TC or Manager account for voting; that should only be done for carrying out committee decisions. What most people do is open a second account as a Vetter if they have a language they want to contribute to.
+
+## To add a user
+
+Click on \[Add User] at the top:
+![image](../../images/index/managingUsers1.png)
+
+➡️
+
+![image](../../images/index/managingUsers2.png)
+
+Set the name, email, and locales responsible. To see the locale codes, go to http://unicode.org/cldr/apps/survey?p_codes=t. Just use the language codes in on the right side\-\- the country parts are ignored.
+- *Note that you must use the right code in the case of synonyms: use he* ***not*** *iw, use pt* ***not*** *pt\_BR...*
+
+![image](../../images/index/managingUsers3.jpg)
+
+Set the Userlevel based on your assessment of the person's skill. Normally this is "Vetter". You can use "Street" for volunteers whom you don't know. People don't have to come from your organization as long as you have confidence in them.
+- See the [CLDR Process](https://cldr.unicode.org/index/process) page for a description of the user levels and their privileges.
+
+*Known bug: if you try to create a user when the user already has an account, you get an unknown error message. Often this is because the user is locked. Click on "Show locked users", find the person, and change the status (see below).*
+
+## To resend a password
+
+**Make sure you let your users know that they should use their Survey Tool password only for the Survey Tool, since it is often sent to them in email.**
+
+1. In the Action column, pick Send Password for each user you want to send. Then hit the \[Do Action] button at the top or bottom of the screen to send the password to all selected users.
+2. If you want to do a bunch at a time, use the "Set menus" box on the left to fill in the Action columns
+	1. "all" means the type of user, so pick one or more of those. (eg TC)
+	2. "to" means what you want to do (eg Resend password)
+	3. Hit the "list" button to set the Action menus for those users.
+
+![image](../../images/index/managingUsers4.jpg)
+
+You'll see a \[Change] button; click to do the action (eg resending passwords to TC users)
+
+![image](../../images/index/managingUsers5.jpg)
+
+## To log in as one of your users
+
+You will sometimes want to log in as one of your users, for testing. Click on the magnifying glass:
+
+![image](../../images/index/managingUsers6.png)
+
+Then use the action Show Password:
+
+![image](../../images/index/managingUsers7.png)
+
+You will then get a blue link for Login for XXX. Click on it to log in **as that user.**
+
+![image](../../images/index/managingUsers8.png)
+
+## To send a message to all your users
+
+At the bottom, click the box for "Check this box to compose a message to..."
+
+![image](../../images/index/managingUsers9.jpg)
+
+Click \[Do Action], and it will take you to a box to compose the message.
+
+![image](../../images/index/managingUsers10.jpg)
+
+1. Once you have entered the message, click \[Do Action]
+2. Next, you need to confirm the message before it goes out.
+3. Fill in your address (you can copy and paste) in the box (*this is just to prevent mistakes*), and click \[Do Action]
+
+![image](../../images/index/managingUsers11.jpg)
+
+Later on, in the vetting phase, you can send messages with the outstanding disputes (cases where people disagree on the translation) by checking the box marked "Check this box to send a Dispute complaint"
+
+## To change users' status
+
+1. Click on the magnifying glass in the left column. You zoom in on that user, and have more Actions in the action column.
+2. Click the one you want, and hit \[Do Action]
+3. Normally you don't want to delete users \-\- you want to Lock them. (Deleting removes information about what they've submitted so far.)
+
+## To check that all of your important locales have vetters assigned
+
+1. Click the "Show Vetting Participation" link at the left, under the top gray bar.
+2. The Gray locales are ones that are not a priority for your organization according to coverage information. (If that's wrong, see "[Changing Your Organization's Coverage Levels](https://cldr.unicode.org/index/survey-tool/coverage)" )
+3. If you need new locales added, let your committee representative know.
+4. To see what the participation of your vetters has been recently, click on the Participation Shown link at the top
+	1. Note: this has a bug currently where the table becomes very wide \-\- you'll have to scroll or expand your window.
+
+## To see how your translators are doing
+
+1. Open the Priority Items Summary (slow) in the Gear menu.
+2. Click on Recalculate
+3. Take a break, get a cup of coffee (may take 10 minutes or so).
+4. You then get a table that summarizes the status for each locale.
+5. We often find it useful to copy parts of that table into a spreadsheet for comparison.
+6. ~~To see what your translators have done, in the Gear menu go to~~ ~~**Priority Items Summary**~~
+7. ~~login to the Survey Tool and go to 'Manage … Users' and then to 'Show Vetting Participation' (link at top left).~~
+8. ~~You get a view of your translators.~~
+9. ~~Click on the link "Participation Shown (click to toggle) is currently On / Off ".~~
+	1. ~~Note: there is a bug with the top table causing it to be too wide. Maximize your screen size (and use a wide screen if you have one).~~
+10. ~~Go get a cup of coffee (this will take a little while)~~
+11. ~~At the bottom of the screen, you'll see a list of who has participated, and how many submits and votes they've each made.~~
+
+## To check if you have "bad" locales (locales assigned that aren't in CLDR)
+
+- 1. Go to Coverage (up at the top right in the survey tool)
+	2. If you see the following message, then some of your users have bogus locales OR locales that aren't in CLDR.
+	3. **Warning: locale designations not matching locales in CLDR: X....**
+	4. Go to Manage Users (top right), and look at the users signed up to these locales
+	5. When they are bogus fix them (work with translator to replace by real locale ids)
+	6. When they are valid, you may propose to the committee that we add a locale:
+		1. Valid ones are under languages in en.xml
+		2. OR (unusual case) under languages in http://www.ietf.org/internet\-drafts/draft\-ietf\-ltru\-4645bis\-04\.txt
+		3. However, watch for mistakes, eg someone using "tw" to mean Taiwanese, when it actually means "Twi"
+
+![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)

docs/site/index/survey-tool/survey-tool-accounts.md

@@ -0,0 +1,26 @@
+---
+title: Survey Tool Accounts
+---
+
+# Survey Tool Accounts
+
+[**Survey Tool**](http://st.unicode.org/cldr-apps/survey) **\|** [**Accounts**](https://cldr.unicode.org/index/survey-tool/survey-tool-accounts) **\|** [**Guide**](https://cldr.unicode.org/translation/getting-started/guide) **\|** [**FAQ and Known Bugs**](https://cldr.unicode.org/index/survey-tool/faq-and-known-bugs)
+
+Anyone is welcome to try out the [**Survey Tool**](http://st.unicode.org/cldr-apps/survey), although only those with accounts will be able to make changes. To get an account, or if you have forgotten your login ID or password, please contact your CLDR TC representative. If you don't belong to a Unicode member organization, and are a native speaker of a language other than American English, you can obtain a guest account.
+
+To determine whether you need an account for what you want to do, see [When Do You Need a Survey Tool Account?](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md#when-to-fix-in-survey-tool) If you only wish to report a bug, you may be able to simply [file a ticket](http://unicode.org/cldr/trac/newticket).
+
+There are three types of accounts:
+
+- Representatives belonging to Unicode member organizations in the CLDR technical committee will receive instructions from their CLDR contacts.
+- Representatives from other [Unicode member organizations](http://unicode.org/consortium/memblogo.html) (including [liaison members](http://unicode.org/consortium/memblogo.html#liais)) also get more weight in resolving conflicts. So if you are associated with a Unicode member organization, be sure to have that member's Unicode contact submit your name directly for an account.
+- If there is an official organization for your language that would like to have liaison status for contributing data, please file a separate ticket under [CLDR Change Requests](https://cldr.unicode.org/index/bug-reports).
+- Other individuals can request accounts via the [Unicode contact form](http://www.unicode.org/reporting.html). In resolving conflicts, they are treated as if they all belong to a single organization ("Guest").
+
+When you request an account, you must list all of the locale(s) that you would like to provide data for, using the locale codes on [Locales](http://unicode.org/cldr/apps/survey?p_codes=t). If the locale is not present in CLDR, you can request that it be added, and you will be expected to provide certain core data to begin the process. Please see [Adding New Locales](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md#adding-new-locales) under [CLDR Change Requests](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md#requesting-changes).
+
+## Logging in
+
+Once you have an account, open the [Unicode CLDR Survey Tool](http://unicode.org/cldr/apps/survey), click the 'Login' button and fill in your email address and password.
+
+![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)