From 5459af7b9cb0ff2a9a534e5e107d9ca305ee2688 Mon Sep 17 00:00:00 2001 From: Tom Bishop Date: Thu, 10 Oct 2024 13:36:45 -0400 Subject: [PATCH] CLDR-8038 Revise index.md, translation.md, getting-started.md, guide.md (#4115) --- docs/site/index.md | 32 +++---- docs/site/translation.md | 85 +++++++++---------- docs/site/translation/getting-started.md | 2 - .../site/translation/getting-started/guide.md | 66 ++++++-------- 4 files changed, 78 insertions(+), 107 deletions(-) diff --git a/docs/site/index.md b/docs/site/index.md index edccc253c5f..ffc78d7f36a 100644 --- a/docs/site/index.md +++ b/docs/site/index.md @@ -8,9 +8,9 @@ title: Unicode CLDR Project - **2024-09-26 [CLDR 46 Beta](https://blog.unicode.org/2024/09/unicode-cldr-46-beta-available-for.html) available for testing and specification review** - **2024-09-05 [CLDR 46 Alpha](https://blog.unicode.org/2024/09/unicode-cldr-v46-alpha-available-for.html) available for testing** -- **2024-04-17 [CLDR 45](/index/downloads/cldr-45) released** -- **2023-12-13 [CLDR 44.1](/index/downloads/cldr-44#h.nvqx283jwsx) released (an update to CLDR v44)** -- **2023-10-31 [CLDR 44](/index/downloads/cldr-44) released** +- **2024-04-17 [CLDR 45](downloads/cldr-45) released** +- **2023-12-13 [CLDR 44.1](downloads/cldr-44#h.nvqx283jwsx) released (an update to CLDR v44)** +- **2023-10-31 [CLDR 44](downloads/cldr-44) released** ## What is CLDR? @@ -23,7 +23,7 @@ The Unicode Common Locale Data Repository (CLDR) provides key building blocks fo - **Validity:** Definitions, aliases, and validity information for Unicode locales, languages, scripts, regions, and extensions,… -CLDR uses the XML format provided by [UTS #35: Unicode Locale Data Markup Language (LDML)](http://www.unicode.org/reports/tr35/). LDML is a format used not only for CLDR, but also for general interchange of locale data, such as in Microsoft's .NET. +CLDR uses the XML format provided by [UTS #35: Unicode Locale Data Markup Language (LDML)](https://www.unicode.org/reports/tr35/). LDML is a format used not only for CLDR, but also for general interchange of locale data, such as in Microsoft's .NET. ## Who uses CLDR? @@ -33,11 +33,7 @@ Some of the companies and organizations that use CLDR are: - IBM (DB2, Lotus, Websphere, Tivoli, Rational, AIX, i/OS, z/OS, …) - Meta (Facebook, Messenger, WhatsApp, …) - Microsoft (Windows, Office, Visual Studio, …) - - *and many others, including:* - -- ABAS Software, Adobe, Amazon (Kindle), Amdocs, Apache, Appian, Argonne National Laboratory, Avaya, Babel (Pocoo library), BAE Systems Geospatial eXploitation Products, BEA, BluePhoenix Solutions, BMC Software, Boost, BroadJump, Business Objects, caris, CERN, CLDR Engine, Debian Linux, Dell, Eclipse, eBay, elixir-cldr, EMC Corporation, ESRI, Firebird RDBMS, FreeBSD, Gentoo Linux, GroundWork Open Source, GTK+, Harman/Becker Automotive Systems GmbH, HP, Hyperion, Inktomi, Innodata Isogen, Informatica, Intel, Interlogics, IONA, IXOS, Jikes, jQuery, Library of Congress, Mathworks, Mozilla, Netezza, OpenOffice, Oracle (Solaris, Java), Lawson Software, Leica Geosystems GIS & Mapping LLC, Mandrake Linux, OCLC, Perl, Progress Software, Python, Qt, QNX, Rogue Wave, SAP, Shutterstock, SIL, SPSS, Software AG, SuSE, Symantec, Teradata (NCR), ToolAware, Trend Micro, Twitter, Virage, webMethods, Wikimedia Foundation (Wikipedia), Wine, WMS Gaming, XyEnterprise, Yahoo!, Yelp - +- *and many others, including:* ABAS Software, Adobe, Amazon (Kindle), Amdocs, Apache, Appian, Argonne National Laboratory, Avaya, Babel (Pocoo library), BAE Systems Geospatial eXploitation Products, BEA, BluePhoenix Solutions, BMC Software, Boost, BroadJump, Business Objects, caris, CERN, CLDR Engine, Debian Linux, Dell, Eclipse, eBay, elixir-cldr, EMC Corporation, ESRI, Firebird RDBMS, FreeBSD, Gentoo Linux, GroundWork Open Source, GTK+, Harman/Becker Automotive Systems GmbH, HP, Hyperion, Inktomi, Innodata Isogen, Informatica, Intel, Interlogics, IONA, IXOS, Jikes, jQuery, Library of Congress, Mathworks, Mozilla, Netezza, OpenOffice, Oracle (Solaris, Java), Lawson Software, Leica Geosystems GIS & Mapping LLC, Mandrake Linux, OCLC, Perl, Progress Software, Python, Qt, QNX, Rogue Wave, SAP, Shutterstock, SIL, SPSS, Software AG, SuSE, Symantec, Teradata (NCR), ToolAware, Trend Micro, Twitter, Virage, webMethods, Wikimedia Foundation (Wikipedia), Wine, WMS Gaming, XyEnterprise, Yahoo!, Yelp There are other projects which consume cldr-json directly, see [here](https://github.com/unicode-org/cldr-json/blob/master/USERS.md#projects) for a list. @@ -45,7 +41,7 @@ There are other projects which consume cldr-json directly, see [here](https://gi Most developers will use CLDR indirectly, via a set of software libraries, such as [ICU](https://icu.unicode.org/), [Closure](https://github.com/google/closure-library), or [TwitterCLDR](https://blog.x.com/engineering/en_us/a/2012/twittercldr-improving-internationalization-support-in-ruby). These libraries typically compile the CLDR data into a format that is compact and easy for the library to load and use. -For those interested in the source CLDR data, it is available for each release in the XML format specified by [LDML](http://www.unicode.org/reports/tr35/). There are also tools that will convert to JSON and POSIX format. For more information, see [CLDR Releases/Downloads](/index/downloads). +For those interested in the source CLDR data, it is available for each release in the XML format specified by [LDML](https://www.unicode.org/reports/tr35/). There are also tools that will convert to JSON and POSIX format. For more information, see [CLDR Releases/Downloads](downloads). ## How to Contribute? @@ -53,26 +49,26 @@ CLDR is a collaborative project, which benefits by having people join and contri #### Translations and other language data -CLDR has an online tool to gather data, the [Survey Tool](/index/survey-tool). The Survey Tool is open twice a year to gather data for new structure, and make corrections in previously-released data. +CLDR has an online tool to gather data, the [Survey Tool](index/survey-tool). The Survey Tool is open twice a year to gather data for new structure, and make corrections in previously-released data. -- For languages that are already available in the Survey Tool, see [picking a locale](/translation/getting-started/guide#h.6f2x50entpdr). If your locale is not already available in the Survey Tool, see [Adding new locales](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md#adding-new-locales). - - Contribute as an individual (vetter) for your language by [setting up an account](/index/survey-tool/survey-tool-accounts) - - Qualifying organizations (companies, governments, institutions, etc) can request for an Organization level contribution status. Please file a [ticket](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md#how-to-file-a-ticket) if you need organization set up. +- For languages that are already available in the Survey Tool, see [picking a locale](translation/getting-started/guide#picking-locales). If your locale is not already available in the Survey Tool, see [Adding new locales](requesting_changes#adding-new-locales). + - Contribute as an individual (vetter) for your language by [setting up an account](index/survey-tool/survey-tool-accounts) + - Qualifying organizations (companies, governments, institutions, etc) can request for an Organization level contribution status. Please file a [ticket](requesting_changes#how-to-file-a-ticket) if you need organization set up. - Unicode [voting members](https://home.unicode.org/membership/members/) can join the technical committee for bigger impact. The CLDR Technical committee is responsible for assessing the Survey Tool features, proposals for additions or changes to structure, bug fixes, and final resolution of each release of CLDR. #### Code and Structure -The CLDR tooling supports the interactive Survey Tool, plus all of the tooling necessary to test and process the release. Programmers interested in contributing to the tooling are welcome; they may also be interested in contributing to [ICU](http://site.icu-project.org/), which uses CLDR data. For more information, see http://cldr.unicode.org/development. +The CLDR tooling supports the interactive Survey Tool, plus all of the tooling necessary to test and process the release. Programmers interested in contributing to the tooling are welcome; they may also be interested in contributing to [ICU](https://icu.unicode.org/), which uses CLDR data. For more information, see [Development](development). -CLDR covers many different types of data, but not everything. For projects which may cover other types of data, see [Other Projects](/covered-by-other-projects). +CLDR covers many different types of data, but not everything. For projects which may cover other types of data, see [Other Projects](covered-by-other-projects). #### Tickets -People may file [tickets](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md) with bug fixes or feature requests. Once a ticket is approved, they can also create pull requests on [GitHub](https://github.com/unicode-org/cldr). +People may file [tickets](requesting_changes) with bug fixes or feature requests. Once a ticket is approved, they can also create pull requests on [GitHub](https://github.com/unicode-org/cldr). ## Who has contributed? -Many people have made significant contributions to CLDR and LDML; see the [Acknowledgments](/index/acknowledgments) page for a full listing. +Many people have made significant contributions to CLDR and LDML; see the [Acknowledgments](index/acknowledgments) page for a full listing. ## What is the Schedule? diff --git a/docs/site/translation.md b/docs/site/translation.md index a6a81dd5960..e2f60b8b4d9 100644 --- a/docs/site/translation.md +++ b/docs/site/translation.md @@ -6,14 +6,14 @@ title: Information Hub for Linguists ### Starting Submission -During Submission, please read the CLDR Training (if new to the survey tool), please focus on the missing, provisional, and errors. Please read the [**Announcements and Updates**](/translation#h.pfa5snbaw7ds). For more information about the priorities during Submission, see [Survey Tool stages](/translation/getting-started/survey-tool-phases) under **Survey Tool phase: General Submission**. The [Submission phase](/translation/getting-started/survey-tool-phases#h.wqmb27e55b4l) lasts until **June 11**; then the [Vetting phase](/translation/getting-started/survey-tool-phases#h.ddjb4w32ki37) lasts until **June 30**. +During Submission, please read the CLDR Training (if new to the survey tool), please focus on the missing, provisional, and errors. Please read the [Updates](#updates). For more information about the priorities during Submission, see [Survey Tool stages](translation/getting-started/survey-tool-phases). ### Prerequisites 1. If you're **new to CLDR**, take the CLDR training below. -2. If you're already **experienced with CLDR**, read the Critical reminders section (mandatory). -3. Review the **Status and Schedule, New Areas, Survey Tool**, and **Known Issues**. -4. Once you are ready, go to the [**Survey Tool**](https://st.unicode.org/cldr-apps/) and log in. +2. If you're already **experienced with CLDR**, read the [Critical reminders](#critical-reminders-for-all-linguists) section (mandatory). +3. Review the [Status and Schedule](#status-and-schedule), [New Areas](#new-areas), [Survey Tool](#survey-tool), and [Known Issues](#known-issues). +4. Once you are ready, go to the [Survey Tool](https://st.unicode.org/cldr-apps/) and log in. ### Updates @@ -24,13 +24,13 @@ When a section below changes, the date will be in the header. ## Status and Schedule -The Survey Tool is now open for [Submission](/translation/getting-started/survey-tool-phases#h.wqmb27e55b4l) until the start of [Vetting](/translation/getting-started/survey-tool-phases#h.ddjb4w32ki37) on June 12th ([schedule](https://docs.google.com/spreadsheets/d/1N6inI5R84UoYlRwuCNPBOAP7ri4q2CmJmh8DC5g-S6c/edit#gid=1680747936)); then the [Vetting phase](/translation/getting-started/survey-tool-phases#h.ddjb4w32ki37) lasts until **June 30**. +The Survey Tool has been closed for version 46. For version 47, it is not yet open for [General Submission](translation/getting-started/survey-tool-phases#survey-tool-phase-general-submission). The General Submission phase will be followed by the [Vetting phase](translation/getting-started/survey-tool-phases#survey-tool-phase-vetting). -- **Disconnect error**. If you see a persistent Loading error with a disconnect message or other odd behavior, please [empty your cache](/translation). +- **Disconnect error**. If you see a persistent Loading error with a disconnect message or other odd behavior, please [empty your cache](translation/getting-started/empty-cache). - Survey Tool email notification may be going to your spam folder. Check your spam folder regularly. - "**Same as code**" errors - when translating codes for items such as languages, regions, scripts, and keys, it is normally an error to select the code itself as the translated name. If the error appears under Typography, you can ignore it. \[[CLDR-13552](https://unicode-org.atlassian.net/browse/CLDR-13552)\] -## New Areas (2024-05-30) +## New Areas ![alt-text](./images/translation-horizontal-emojis.png) @@ -38,7 +38,7 @@ Most of the following are relevant to locales at the Modern Coverage Level. ### New emoji -Seven new emoji have been added (images above). These will be released in Unicode 16 in September, so they need short names and search keywords. +Seven new emoji have been added (images above). These were released in Unicode 16 in September 2024. ### Emoji search keywords @@ -86,7 +86,6 @@ Seven new emoji have been added (images above). These will be released in Unicod 4. Specific terms for sexuality, unless strongly associated with the emoji, eg \[lgbt|lgbtq |... \] for *rainbow* (🌈), *rainbow flag* (🏳️‍🌈), and *transgender flag* (🏳️‍⚧️). 5. **Note:** The English values have also been reviewed and modified for these rules. - ### New/expanded units 1. Additional units: @@ -99,7 +98,6 @@ Seven new emoji have been added (images above). These will be released in Unicod 3. millimeter-ofhg - used for pressure measurements 4. Beaufort - used for [wind speed](https://en.wikipedia.org/wiki/Beaufort_scale) (only in certain countries) - ### Language names As new locales reach Basic Coverage, their language names have been added for locales targeting modern coverage: Anii, Kuvi, …, Zhuang @@ -108,9 +106,9 @@ As new locales reach Basic Coverage, their language names have been added for lo There is a new metazone for Kazakhstan (which merged its two time zones). -## Survey Tool (2024-05-30) +## Survey Tool -Once trained and up to speed on Critical reminders (above), log in to the [Survey Tool](https://st.unicode.org/cldr-apps/) to begin your work. +Once trained and up to speed on [Critical reminders](#critical-reminders-for-all-linguists) (below), log in to the [Survey Tool](https://st.unicode.org/cldr-apps/) to begin your work. ### Survey Tool Changes @@ -123,10 +121,7 @@ Once trained and up to speed on Critical reminders (above), log in to the [Surve 1. Pages may be split, and/or retitled 2. Rows may move to a different page. 5. In the Dashboard, the Abstains items will now only have one entry per page. You can use that entry to go to its page, and then fix Abstains on that page. Once you are done on that page, hit the Dashboard refresh button (↺). This fixes a performance problem for people with a large number of Abstains, and reduces clutter in the Dashboard. -6. The symbols in the A column have been changed to be searchable in browsers (with *Find in Page*) and stand out - - -more on the page. See below for a table. They override the symbols in [Survey Tool Guide: Icons](/translation/getting-started/guide#h.fbq7vldvjuz4). +6. The symbols in the A column have been changed to be searchable in browsers (with *Find in Page*) and stand out more on the page. See below for a table. They override the symbols in [Survey Tool Guide: Icons](translation/getting-started/guide#icons). ### Important Notes @@ -143,24 +138,22 @@ more on the page. See below for a table. They override the symbols in [Survey To | 🕳️ | Missing | Completely missing | | ⬆️ | Inherited | Used in combination with ✖️ and ❌ | -## Known Issues (2024-06-03) +## Known Issues -This list will be updated as fixes are made available in Survey Tool Production. If you find a problem, please [file a ticket](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md), but please review this list first to avoid creating duplicate tickets. +This list will be updated as fixes are made available in Survey Tool Production. If you find a problem, please [file a ticket](requesting_changes), but please review this list first to avoid creating duplicate tickets. 1. [CLDR-17694](https://unicode-org.atlassian.net/browse/CLDR-17694) - Back button in browser fails in forum under certain conditions 2. [CLDR-17693](https://unicode-org.atlassian.net/browse/CLDR-17693) SurveyTool fatal in getDBConnection 3. [CLDR-17658](https://unicode-org.atlassian.net/browse/CLDR-17658) - Dashboard slowness -4. Images for the plain symbols. Non-emoji such as [€](https://cldr-smoke.unicode.org/smoketest/v#/fr/Symbols2/47925556fd2904b5), √, », ¹, §, ... do not have images in the info pane. \[[CLDR-13477](https://unicode-org.atlassian.net/browse/CLDR-13477)\]**Workaround**: Look at the Code column; unlike the new emoji, your browser should display them there. +4. Images for the plain symbols. Non-emoji such as [€](https://cldr-smoke.unicode.org/smoketest/v#/fr/Symbols2/47925556fd2904b5), √, », ¹, §, ... do not have images in the Info Panell. \[[CLDR-13477](https://unicode-org.atlassian.net/browse/CLDR-13477)\]**Workaround**: Look at the Code column; unlike the new emoji, your browser should display them there. 5. [CLDR-17683](https://unicode-org.atlassian.net/browse/CLDR-17683) - Some items are not able to be flagged for TC review. This is being investigated.Meanwhile, Please enter forum posts meanwhile with any comments. - ## Resolved Issues 1. [CLDR-17465](https://unicode-org.atlassian.net/browse/CLDR-17465) - dashboard download fails 2. [CLDR-17671](https://unicode-org.atlassian.net/browse/CLDR-17671) - survey tool search fails 3. [CLDR-17652](https://unicode-org.atlassian.net/browse/CLDR-17652) - Manual import of votes fails - ## Recent Changes 1. [*CLDR-17658*](https://unicode-org.atlassian.net/browse/CLDR-17658) - In the Dashboard, the Abstains items will only have one entry per page. You can use that entry to go to its page, and then fix Abstains on that page. Once you are done on that page, hit the Dashboard refresh button (↺). This fixes a performance problem for people with a large number of Abstains, and reduces clutter in the Dashboard. @@ -169,41 +162,39 @@ This list will be updated as fixes are made available in Survey Tool Production. Before getting started to contribute data in CLDR, and jumping in to using the Survey Tool, it is important that you understand the CLDR process & take the CLDR training. It takes about 2-3 hours to complete the training. -1. **Understand the basics about the CLDR process** read the [Survey Tool Guide](/translation/getting-started/guide) and an overview of the [Survey Tool Stages](/translation/getting-started/survey-tool-phases). +1. **Understand the basics about the CLDR process** read the [Survey Tool Guide](translation/getting-started/guide) and an overview of the [Survey Tool Stages](translation/getting-started/survey-tool-phases). - New: A [video is available](https://www.youtube.com/watch?v=Wxs0TZl7Ljk) which shows how to login and begin contributing data for your locale. 2. **Read the Getting Started topics** on the Information Hub: - General translation guide - - [Capitalization](/translation/translation-guide-general/capitalization) - - [Default Content](/translation/translation-guide-general/default-content) - - [References](/translation/translation-guide-general/references) - - [Handling Errors and Warnings](/translation/getting-started/errors-and-warnings) - - [Handling Logical Group Errors](/translation/getting-started/resolving-errors) - - [Plurals & Units](/translation/getting-started/plurals) - - [Review Date & Time](/translation/date-time) - - [Review Numbers](/translation/number-currency-formats) - - [Review Zones](/translation/time-zones-and-city-names) - - [Data stability](/translation/getting-started/data-stability) - - [Empty cache](/translation/getting-started/empty-cache) - -\*If you (individual or your organization) have not established a connection with the CLDR technical committee, start with [Survey Tool Accounts](/index/survey-tool/survey-tool-accounts). + - [Capitalization](translation/translation-guide-general/capitalization) + - [Default Content](translation/translation-guide-general/default-content) + - [References](translation/translation-guide-general/references) + - [Handling Errors and Warnings](translation/getting-started/errors-and-warnings) + - [Handling Logical Group Errors](translation/getting-started/resolving-errors) + - [Plurals & Units](translation/getting-started/plurals) + - [Review Date & Time](translation/date-time) + - [Review Numbers](translation/number-currency-formats) + - [Review Zones](translation/time-zones-and-city-names) + - [Data stability](translation/getting-started/data-stability) + - [Empty cache](translation/getting-started/empty-cache) + +\*If you (individual or your organization) have not established a connection with the CLDR technical committee, start with [Survey Tool Accounts](index/survey-tool/survey-tool-accounts). ## Critical reminders (for all linguists) You're already familiar with the CLDR process, but do keep the following in mind: 1. **Aim at commonly used language** - CLDR should reflect *common-usage* standards **not** *academic /official* standards (unless commonly followed). Keep that perspective in mind. -2. **Carefully consider changes to existing standards** - any change to an existing CLDR standard should be carefully considered and discussed with your fellow linguists in the CLDR [Forum](/translation/getting-started/guide#h.fx4wl2fl31az). Remember your change will be reflected across thousands of online products! +2. **Carefully consider changes to existing standards** - any change to an existing CLDR standard should be carefully considered and discussed with your fellow linguists in the CLDR [Forum](translation/getting-started/guide#forum). Remember your change will be reflected across thousands of online products! 3. **Keep consistency across logical groups** - ensure that all related entries are consistent. If you change the name of a weekday, make sure it's reflected across all related items. Check that the order of month and day are consistent in all the date formats, etc. - - *Tip: The [Reports](/translation/getting-started/review-formats) are a great way to validate consistency across related logical groups, e.g. translations of date formats. Use them to proofread your work for consistency.* + - *Tip: The [Reports](translation/getting-started/review-formats) are a great way to validate consistency across related logical groups, e.g. translations of date formats. Use them to proofread your work for consistency.* 4. **Avoid voting for English** - for items that do not work in your language, don't simply use English. Find a solution that works for your language. For example, if your language doesn't have a concept of calendar "quarters", use a translation that describes the concept "three-month period" rather than "quarter-of-a-year". 5. **Watch out for complex sections** and read the instructions carefully if in doubt: - 1. [Date & Time](/translation/date-time/date-time-names) - - [Names](/translation/date-time/date-time-names) - - [Patterns](/translation/date-time) - - [Symbols](/translation/date-time/date-time-symbols) - 2. [Time zones](/translation/time-zones-and-city-names) - 3. [Plural forms](/translation/getting-started/plurals) - - -*Tip: The links in the [Info Panel](/translation/getting-started/guide#h.2jch1980f8sy) will point you to relevant instructions for the entry you're editing/vetting. Use it if in doubt.* - + 1. [Date & Time](translation/date-time/date-time-names) + - [Names](translation/date-time/date-time-names) + - [Patterns](translation/date-time) + - [Symbols](translation/date-time/date-time-symbols) + 2. [Time zones](translation/time-zones-and-city-names) + 3. [Plural forms](translation/getting-started/plurals) + +*Tip: The links in the [Info Panel](translation/getting-started/guide#info-panel) will point you to relevant instructions for the entry you're editing/vetting. Use it if in doubt.* diff --git a/docs/site/translation/getting-started.md b/docs/site/translation/getting-started.md index 92092978beb..39a9aa5e3d6 100644 --- a/docs/site/translation/getting-started.md +++ b/docs/site/translation/getting-started.md @@ -20,5 +20,3 @@ Before getting started to contribute data in CLDR, and jumping in to using the S - [Empty cache](/translation/getting-started/empty-cache) \*If you (individual or your organization) have not established a connection with the CLDR technical committee, start with [Survey Tool Accounts](/index/survey-tool/survey-tool-accounts). - - diff --git a/docs/site/translation/getting-started/guide.md b/docs/site/translation/getting-started/guide.md index c76ec4885af..32d2c3fddab 100644 --- a/docs/site/translation/getting-started/guide.md +++ b/docs/site/translation/getting-started/guide.md @@ -6,10 +6,6 @@ title: Survey Tool Guide ### _News_ -_2022-11-28 Updated several images and instructions to reflect improvements, such as revised menus, buttons,regional inheritance, and the Dashboard and Forum._ - -[**Survey Tool**](https://st.unicode.org/cldr-apps/v#locales///) **|** [**Accounts**](/index/survey-tool/survey-tool-accounts) **|** [**Guide**](/translation/getting-started/guide) **|** [**FAQ and Known Bugs**](/index/survey-tool/faq-and-known-bugs) - The Survey tool is a web based tool for collecting CLDR data and includes various features that the contributors (vetters) should know before getting started. Note that the exact appearance in screenshots may change as the tool is enhanced over time and based on your vetter level. @@ -19,7 +15,7 @@ Note that the exact appearance in screenshots may change as the tool is enhanced - Please read the home page of the [Translation Guidelines](/translation) before starting your data contribution. - If you experience a **Loading...** problem with the Survey Tool, try clearing your browser cache. See [Reloading JavaScript](https://www.filecloud.com/blog/2015/03/tech-tip-how-to-do-hard-refresh-in-browsers/#.XOjGNtMzbuM). - **Browser support** for Survey Tool includes the latest versions of Edge, Safari, Chrome, and Firefox. -- Use [Reports](/translation/getting-started/guide#TOC-Reports) at the beginning to review the data in your language in a holistic manner for Date & time, Zones, and Numbers. +- Use [Reports](#reports) at the beginning to review the data in your language in a holistic manner for Date & time, Zones, and Numbers. - 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](/translation/translation-guide-general/capitalization) for more details. - Plurals: For important information regarding the use of plural forms for your language, please read [Plurals](/translation/getting-started/plurals). @@ -29,7 +25,7 @@ At a point towards the end of Survey Tool period, the Technical Committee will c ## Login and Import of old votes -1. Go to http://st.unicode.org/cldr-apps/survey/ and log in. +1. Go to https://st.unicode.org/cldr-apps/survey/ and log in. ![alt-text](../../images/gettingStartedGuideNotOpenYet.jpeg) 1. **Import of old votes** is automatically handled when you log in for all your votes **matching** the latest released data. If you have voted previously, upon first log-in, you will see a message showing the number of your votes that matched the currently winning votes that have been auto-imported. 2. Import of your old votes will take some time, but this will be done at 1st log-in only. @@ -46,7 +42,6 @@ At a point towards the end of Survey Tool period, the Technical Committee will c 3. Go to the data categories in the Survey tool where you have imported your old votes, these will show up in the Others column with no votes. 4. Review and add your vote. The best practice is to create a forum entry explaining why this is the data that should be changed to and drive to gain consensus with other vetters. - ### 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. @@ -59,13 +54,12 @@ At a point towards the end of Survey Tool period, the Technical Committee will c 1. 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**_](/translation/getting-started/guide%23TOC-No-Information-Panel)_**.**_ +_If the [Info Panel](#info-panel) was turned off, click on the **Open Info Panel** button near the top right of the window._ ### Voting view 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**](/translation/getting-started/guide) below. +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 the [Dashboard](#dashboard) (below). 3. Once you have selected a section, you'll see a table to enter votes in. The main table has these columns: - **Code**: the code CLDR uses to identify this data point. - **English**: the plain English value of the data point (the text you are to translate). @@ -76,8 +70,8 @@ _Make sure that you haven't mistakenly turned the Information Panel off! See_ [_ - If what you want is a variation of what is in Winning or Others, you can cut & paste, and then modify. - **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. - 1. Look at the Regional Variants to see if any should be changed: see **Information Panel** below. -5. Once you are done with all the sections, go to the [**Dashboard**](/translation/getting-started/guide)**.** + 1. Look at the Regional Variants to see if any should be changed: see **Info Panel** below. +5. Once you are done with all the sections, go to [Dashboard](#dashboard) (below). 6. Under the English column, look for "**i**" for additional information and "**e**" for an example. ![alt-text](../../images/gettingStartedGuideArabic.png) ![alt-text](../../images/gettingStartedGuideEnglish.jpg) @@ -88,25 +82,25 @@ The main panel uses icons to indicate important information and possible problem ![alt-text](../../images/gettingStartedGuideIcon.png) -(Icons for the **Dashboard** are listed in the [**Dashboard Icons**](/translation/getting-started/guide) section below.) +(Icons for the **Dashboard** are listed in the [Dashboard Icons](#dashboard-icons) section below.) ### Examples An example with an ❌ shows a case where the pattern has an inappropriate placeholder substituted. That example should be ungrammatical; if it is grammatical, then either the translated unit or the minimal pair pattern itself is incorrect. The example will show in the Info Panel, and also if you hover over the item. -### Information Panel +### Info 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. +2. When you select an item (the text, **NOT** the radio button), additional information will show in the right-hand **Info 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; _vetters which are not representing a Unicode organization usually have 1 vote_. 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). 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 _to the right_). 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](/translation/getting-started/guide). -10. **No Information Panel?** - - If you click on the **Code** cell and there is no **Information Panel**, you may have turned it off accidentally. Click on the **Open Info Panel** button near the top right of the window. +9. You'll also see the New Forum Post button (as shown in the screenshot _to the right_). 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](#forum). +10. **No Info Panel?** + - If you click on the **Code** cell and there is no **Info Panel**, you may have turned it off accidentally. Click on the **Open Info Panel** button near the top right of the window. ![alt-text](../../images/gettingStartedGuideSideBar.png) ![alt-text](../../images/gettingStartedGuideCookies.png) @@ -133,8 +127,7 @@ Language variants by Region are differentiated as Parent-locale and sub-locales. - **Spanish (Argentina) es\_AR** is one of the sub-locales for Spanish (Latin 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). +The regional variants menu for a data point is shown on the right navigation Info Panel. 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 the screenshot on the right. @@ -174,7 +167,6 @@ _**Note:**_ _The total progress widget is currently only visible when the dashbo _Progress bar shows progress of items on page for your coverage level._ ![alt-text](../../images/gettingStartedGuidePageProgress.png) - ### _Overall progress_ _Progress bar shows progress of items overall for your coverage level._ @@ -187,7 +179,7 @@ The Dashboard will show you a list of data items with warnings of different kind ![alt-text](../../images/gettingStartedGuideDashboard.png) -The goal is that you should work the Dashboard down to show zero items, then review the [**Reports**](/index/survey-tool/guide#TOC-Reports), below. +The goal is that you should work the Dashboard down to show zero items, then review the [Reports](#reports) (below). _The first priority is to fix all the_ _**Missing**_ _items by supplying the correct translations._ @@ -246,7 +238,6 @@ There are two ways to clear items from the **Dashboard** list: - _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. @@ -319,7 +310,6 @@ Forum posts work with the following workflow: 2. Responses by other vetters in your language with Agree, Decline, or Comment. 3. Once resolved, the creators of the the initial Request or Discuss closes the post. - ### How to create a new forum post A forum post can be specific to a particular data point or a general issue. In either case, create a new forum post to an item. @@ -327,14 +317,13 @@ A forum post can be specific to a particular data point or a general issue. In e - A post that is specific to a particular data point. - A general issue that impacts multiple data points. In a general case that impacts multiple data points, you do not need to post new forum posts for every item impacted. The general issue should be flagged to other vetters and once a consensus is reached, it is expected that vetters update their votes on all impacted items. New forum posts can be used to flag to other vetters if others fail to update their votes on all impacted items. ONLY request if others have missed or have not updated consistently. - -**Create forum posts from the** [**Information pane**](/translation/getting-started/guide#TOC-Information-Panel)**l in the voting window.** +**Create forum posts from the [Info Panel](#info-panel) in the voting window.** 1. Vote on an item (or add new +) for the item you want to suggest changing. ![alt-text](../../images/gettingStartedGuideVote.png) -2. In the Information panel on the right, there are two buttons to indicate the type of forum posts: +2. In the Info Panel on the right, there are two buttons to indicate the type of forum posts: 1. **Request** You have voted on a non-winning item, and you want to Request others to change their votes. 2. **Discuss -** Currently only TC members can make discuss posts. @@ -353,9 +342,9 @@ A forum post can be specific to a particular data point or a general issue. In e There are two ways to respond to forum posts: - Info Panel (This is the recommended option.) -- In the Forum view (See [Working in the Forum view](/translation/getting-started/guide#TOC-Working-in-the-Forum-view-)) +- In the Forum view (See [Working in the Forum view](#working-in-the-forum-view)) -**Respond from the** [**Info Panel**](/translation/getting-started/guide#TOC-Information-Panel) **in the voting window.** +**Respond from the [Info Panel](#info-panel) in the voting window.** In the **Info Panel**, select the **Comment** button - Each posted response is labeled in Red and its response type: Agree, Decline or Comment. @@ -375,10 +364,9 @@ In the **Info Panel**, select the **Comment** button There are two ways to respond to new forum post: - Info Panel (This is the recommended option.) -- In the Forum view (See [Working in the Forum view](/translation/getting-started/guide#TOC-Working-in-the-Forum-view-)) +- In the Forum view (See [Working in the Forum view](#working-in-the-forum-view)) - -**Respond to forum posts from the** [**Info Panel**](/translation/getting-started/guide#TOC-Information-Panel) **in the voting window.** +**Respond to forum posts from the [Info Panel](#info-panel) in the voting window.** 1. In the Info Panel click the **Comment** button and add your input to the open discussion. 2. The label **Discuss** in Red indicates that this is a Discuss post (to distinguish from Request posts) @@ -387,6 +375,7 @@ There are two ways to respond to new forum post: ### Working in the Forum view In the Survey Tool [Forum](https://st.unicode.org/cldr-apps/v#forum/fr//) view, there are multiple filtering options available for you to work more effectively. + 1. The Forum view can be accessed from the left navigation **Forum.** ![alt-text](../../images/gettingStartedGuideForum.jpeg) @@ -408,13 +397,13 @@ In the Forum view, you can respond to Request and Discuss posts. For **Request posts**, you can select your decision using the 3 available buttons: **Agree, Decline, Comment.** -See [Responding to Request posts in Information Pane](/translation/getting-started/guide#TOC-Responding-to-Request-posts). +See [Responding to Request posts in Info Panel](#responding-to-request-posts). ![alt-text](../../images/gettingStartedGuideForumPosts.png) ## Reporting Survey Tool issues -If you run into a problem with the Survey Tool functionalities, please see [FAQ & Known Bugs](/index/survey-tool/faq-and-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](/index/bug-reports#TOC-Filing-a-Ticket). +If you run into a problem with the Survey Tool functionalities, please see [FAQ & Known Bugs](../../index/survey-tool/faq-and-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](../requesting_changes#how-to-file-a-ticket). ![alt-text](../../images/gettingStartedGuideCoverage.png) @@ -423,10 +412,9 @@ If you run into a problem with the Survey Tool functionalities, please see [FAQ 1. 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. 2. 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. - ### Forum posts for CLDR ticket feedback -CLDR users can send in data feedback using [JIRA](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md). Tickets filed in JIRA will be processed as described below. Please expect to see posts by CLDR Technical Committee members (TCs) in Forums, and participate by providing your response to any tickets needing your input. +CLDR users can send in data feedback using [JIRA](/requesting_changes). Tickets filed in JIRA will be processed as described below. Please expect to see posts by CLDR Technical Committee members (TCs) in Forums, and participate by providing your response to any tickets needing your input. The goal is to bring it to the attention to all linguists contributing in a particular language, and gather their input, so an informed decision can be made and/or suggested. @@ -435,12 +423,10 @@ The goal is to bring it to the attention to all linguists contributing in a part 3. A reason for not changing could be for example that it is a reasonable change, but doesn't exceed the 'stability' bar in the translation guidelines. 4. TC members will monitor the forum discussion/change during the Submission phase, and will close the JIRA ticket after the forum discussion is concluded. - ## Advanced Features -1. Users familiar with CLDR XML format can upload votes (and submissions) for multiple items at once. See [**Bulk Data Upload**](/index/survey-tool/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**](/index/survey-tool/managing-users)**.** +1. Users familiar with CLDR XML format can upload votes (and submissions) for multiple items at once. See [Bulk Data Upload](/index/survey-tool/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](/index/survey-tool/managing-users). 1. Some users may want to reset their Coverage Level, with the menu that looks like the image to the right. 2. 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. 3. _Note that some companies won't use the data until it is complete at a certain coverage level, typically_ _**Modern**._ -