Skip to content

Commit

Permalink
CLDR-17566 converting getting started p2 (#3819)
Browse files Browse the repository at this point in the history
  • Loading branch information
chpy04 authored Jun 25, 2024
1 parent 43b30f7 commit ed980db
Show file tree
Hide file tree
Showing 16 changed files with 280 additions and 0 deletions.
Binary file added docs/site/images/French-plural.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/Load-error.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/Review-Reports.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/Review-numbers.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/developer-settings.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/disable-check.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/refresh.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/images/review-zone.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions docs/site/translation/getting-started/data-stability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Data stability
---

# Data stability

**Please be mindful of data stability. Data change in the CLDR/Survey Tool will have impact to user experiences on devices and applications.**

Please follow below tips to help with data stability:

1. Carefully review the previously Approved data before suggesting for a change.
1. When it's clearly incorrect, Add your suggestion and start a forum discussion
2. Don't change the data when it is already acceptable (even if not optimal)-consider data preference vs. data inaccuracy.
3. Bring evidence of a variant being much better and in customary use than the existing Approved data to the Forum discussions and gain consensus to change the Approved value.

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
58 changes: 58 additions & 0 deletions docs/site/translation/getting-started/empty-cache.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: Empty Cache
---

# Empty Cache

**The Survey Tool depends on Javascript and you may run into issues because of JavaScript on your system being outdated.**

In the Survey tool, when going to pages like the Forum or Dashboard, you may see a Disconnect error. As shown in this example screenshot with the Details expanded.

![image](../../images/Load-error.PNG)

These errors are typically JavaScript being outdated on your system and clearing cache will resolve the problem.

To clear your cache, follow the steps below (Windows/macOS).

**Windows** (please scroll down for macOS/Safari)

1\. On the page that you are running in to the error, click F12 or open **Developer Tools** from the browser (**Settings > More tools > Developer tools**).

2\. Go to the settings, the ⚙️ icon:

![image](../../images/developer-settings.PNG)

3\. Find "**Disable Cache (while DevTools is open)**" and check.

![image](../../images/disable-check.PNG)

4\. Refresh the page by clicking on the Refresh button on the page.

![image](../../images/refresh.PNG)

For additional information about Browser cache tips, see https://www.getfilecloud.com/blog/2015/03/tech-tip-how-to-do-hard-refresh-in-browsers/#.XRJaApMzbuM for examples.

**macOS - Safari**

1. Open Safari's settings (cmd-, or go to **Preferences** under the Safari menu)
2. Go to the **Advanced** tab and enable the **Develop menu**
3. In the Develop menu, select **Empty Caches** (cmd-alt-E)
4. Now refresh the web-page (cmd-R)

~~When you run into case JavaScript is the issue, you may have to try the following:~~

~~**How do I stop JavaScript caching in Chrome?**~~

~~Open Google Chrome and navigate to the page you want to test.~~

~~Press **F12** (if available) or open **Developer Tools** from within Chrome's settings (**Settings > More tools > Developer tools**).~~

~~Click the cog in the top right of the pop-out box. Check the "**Disable Cache (while DevTools is open)**" setting box.~~

~~Then right-click the "Refresh" button (arrow going in a circle), and pick the last option (hard reload/empty cache).~~

~~Sometimes you need to flush your browser's cache when the Survey Tool updates.~~

~~See~~ https://www.getfilecloud.com/blog/2015/03/tech-tip-how-to-do-hard-refresh-in-browsers/#.XRJaApMzbuM ~~for examples.~~

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
88 changes: 88 additions & 0 deletions docs/site/translation/getting-started/plurals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Plurals & Units
---

# Plurals & Units

## Plurals

In CLDR, Plurals are used for localized Units and Compact numbers (under Numbers).

In the Survey Tool for translation purpose, plural forms shown per language will differ as only those that are relevant to that language are shown.

For example, in French, the distinction of the One and Other are available. Please see [Plural Rules](https://cldr.unicode.org/index/cldr-spec/plural-rules), and [file a ticket](https://github.com/unicode-org/cldr/blob/main/docs/requesting_changes.md) if you see a form in the Survey Tool that is not expected in your language.

![image](../../images/French-plural.PNG)

**Note:** Many of the sets of names form Logical Groups, and you need to make sure they have the same status or you will get error messages. See [Logical Groups](https://cldr.unicode.org/translation/getting-started/resolving-errors) for more information.

## Localized Units

Localized units provide more natural ways of expressing unit phrases that vary in plural form, such as "1 hour" vs "2 hours". While they cannot express all the intricacies of natural languages, the plural forms allow for more natural phrasing than constructions like "1 hour(s)".

As well as being used for durations, like "3.5 hours", they can also be used for relative times, such as:

- "3 hours ago" (regarding an event that took place 3 hours in the past; that is, 3 hours before now).
- "In 3 hours" (regarding an event that will take place 3 hours in the future; that is, 3 hours from now).

## Casing of Relative Times

**All of these should have the same casing for the first character (capitalized or not) if the pattern has letters coming before the placeholder.** For example, in the following, either #1 needs to have a lowercase 'd', or #2 needs to have an uppercase 'H'.

1. **D**entro de {0} horas
2. **h**ace {0} años

Each unit may have multiple plural forms, one for each category (see below). These are composed with numbers using a _unitPattern_. A formatted number will be substituted in place of the number placeholder.

For example, for English if the unit is an hour and the number is 1234, then the number is looked up to get the rule category _other_. The number is then formatted into "1,234" and composed with the unitPattern for _other_ to get the final result. Examples are in the table below for the unit **hour**.

| Locale | Number | Formatted number | Plural category | CLDR Unit Pattern | PH Unit Pattern | Final Result |
|---|:---:|:---:|---|---|---|:---:|
| en | 0 | "0" | other | {0} hours | [NUMBER] hours | "0 hours" |
| en | 1 | "1" | one | {0} hour | [NUMBER] hour | "1 hour" |
| en | 1234 | "1,234" | other | {0} hours | [NUMBER] hours | "1,234 hours" |
| fr | 0 | "0" | one | {0} heure | [NUMBER] heure | "0 heure" |
| fr | 1 | "1" | one | {0} heure | [NUMBER] heure | "1 heure" |
| fr | 1234 | "1 234" | other | {0} heures | [NUMBER] heures | "1 234 heures" |

## Narrow and Short Forms

### Unit formats

Whereas an expression like __{0} englische Meile pro Stunde” may be fine for the _long_ form of the unit speed-mile-per-hour, it does not work for the _short_ or _narrow_ forms. In particular, the _narrow_ form needs to be _**absolutely**_ as short as possible. _It is intended for circumstances where there is very little room in the UI._ However, the message will have additional context. Thus the user will typically know, for example, that the units are speed or distance. So a much shorter abbreviation can be used than would work in general.

In addition, when English units are used in languages that don't use them, they will typically be accompanied by the equivalent metric amount. For example, a map in Russian might show the distance between cities in the US both in metric units and in English units (since they are used in the US, and may be needed for reference there). Or an ad for computer monitors might have “60,9 cm (24 Zoll) Full-HD Monitor”, with Zoll for inches. The metric unit might not even be present where the English unit is in common use, such as when measuring computer screen sizes.

The _short_ form can be longer than the _narrow_ form, but should also be as short as possible, while still being clear and grammatical. It may have less context available than the _narrow_ form, and thus may need to be somewhat longer than the _narrow_ form in order to be clear.

Some techniques for shortening the _narrow_ or _short_ form include:

1. Drop the space between the value and the unit: “{0}km” instead of “{0} km”.
2. Use symbols like km² or / instead of longer terms like “Quadrat” or “ pro ”.
3. Use symbols that would be understood in context: eg “/h” for “ per hour” when the topic is speed, or "Mi" for mile(s) when the topic is distance.
4. Replace the qualifiers "English" or "American" by an abbreviation (UK, US), or drop if most people would understand that the measurement would be an English unit (and not, say, an obsolete German or French one).
5. Use narrow symbols for CJK languages, such as “/” instead of “/”.

Which of these techniques you can use will depend on your language, of course.

### Unit display names

The short and narrow forms of the display names for a unit need not be as short as the symbol used in the actual unit formats. In fact, since the display name may often provide the context necessary to properly understand a unit symbol, the display name will often be longer and more explicit than the short or narrow form of a unit symbol. Often the narrow display name is not specified so that it falls back to the short display name.

## Past and Future

Unit patterns for past and future (3 hours ago, In 4 hours) are related to [Relative Dates](https://cldr.unicode.org/translation/date-time/date-time-names), and occur in the same circumstances. They need to have the same casing behavior. That is, if the translation for "Yesterday" starts with an uppercase 'Y', then the translation for "In {0} hours" needs to start with an uppercase 'I' (if it doesn't start with the placeholder).

## Minimal Pairs

Minimal pairs are used to verify the different grammatical features used by a language. _**These messages are not to be translated literally; do not simply translate the English!**_

- **Plurals (cardinals) and Ordinals.** See [Determining Plural Categories](https://cldr.unicode.org/index/cldr-spec/plural-rules#TOC-Determining-Plural-Categories).
- **Grammatical Case and Gender.** See [Grammatical Inflection](https://cldr.unicode.org/translation/grammatical-inflection)


## Compound Units

Units of measurement can be formed from other units and other components. For more information, see [Compound Units](https://cldr.unicode.org/translation/units/unit-names-and-patterns).

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
41 changes: 41 additions & 0 deletions docs/site/translation/getting-started/resolving-errors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: Handling Logical Group Errors
---

# Handling Logical Group Errors

A "logical group" is a set of _items_ that need to be treated as a single unit in terms of voting.

Examples of common logical groups in the survey tool data are:
- Sets of month names or weekday names in a calendar.
- Any group of items that have plural categories associated with them ( for example, in currencies "1 US Dollar", "5 US Dollars" ).
- In compact decimals, groups of formats for 4-5-6 digits, 7-8-9 digits, 10-11-12 digits, or 13-14-15 digits.

All errors in logical groups must be resolved. All non-resolved errors must be resolved by the CLDR technical committee before a new version of CLDR can be released.

### Logical Group Errors

There are two Errors or Warnings that you may see in the SurveyTool, and these errors should fix from linguistic side if as much as possible.

1. **Error type 1: "Incomplete Logical Group"**
1. This is most serious and it means that one or more items in what's considered as a logical group has been added; however, in doing so at least one other is missing (✘).
1. To fix: Make sure that values for ALL of the items in the logical group are there.
2. An example: vote/enter values for **all** of the month names. Once you enter values for all the items in a logical group, this error will disappear.
2. Error type 2: "**Inconsistent Draft Status**"
1. This happens when the voting results would leave one of items in a group having a lower draft status (✔︎ approved, ✔︎ contributed, ✘ provisional, ✘ unconfirmed) than some other item in the group.
2. **All** of the items have to have the same status.
3. To fix: Go through all your votes and use the forum to coordinating with other vetters and come to an agreement on all items in the group.
3. Error type 3: "**This item has a lower draft status (in its logical group) than X.**".
1. same as Error type 2.
2. Inherited items can count as errors if they are part of a Logical Group. The easiest way to resolve these are to explicitly vote for the inherited or aliased items. Here is an example, before and after.


#### Before

![image](../../images/Screen-Shot-2017-08-22-at-12.11.26.png)

#### After

![image](../../images/Screen-Shot-2017-08-22-at-12.15.08.png)

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)
77 changes: 77 additions & 0 deletions docs/site/translation/getting-started/review-formats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: Review Reports
---

# Review Reports

The Reports provide a way to get an overview of some of the formats to help ensure consistency. They help you to see how the data from different sections will fit together to produce the results that users will see.

_**Some of the reports will not be relevant during a Limited Submission, because you will not be able to make changes to data. In v43, only the Person Names Report is relevant.**_

You should review the reports:

1. well before\* the end of the Submission phase
2. at the start of the Vetting phase
3. well before\* the end of the Vetting phase

\* Make sure you leave enough time that you can vote for any additional needed items. Often a fix will require cooperation from other vetters, so you will need to file at least one forum request so that they know that there is a problem and why you think it needs fixing.

Once you are done, check the appropriate item in the top window:

- **I have reviewed the items below, and they are all acceptable**
- **The items are not all acceptable, but I have entered in votes for the right ones and filed at least one forum post to explain the problems.**
- **I have not reviewed the items.**


Sometimes there will be a structural problem that cannot be fixed by votes, even if all the vetters agree. For example, Latvian needs [some extra support](https://unicode-org.atlassian.net/browse/CLDR-16231) for formatting person names. In that case, you should file a ticket to report the problem. Don't file a ticket if the problem can be solved by you and the other vetters changing your votes.

To get started, in the Survey tool, open the **Reports** from the left navigation.

![image](../../images/Review-Reports.PNG)

### General Tips

1. To correct the data, use the **View** links on the right of each line in Reports to go directly to the field and correct the data. Sometimes the 'view' can't go to the exact line, where there are multiple items involved in the formatting.
2. File at least one forum request where you need others to change their votes. If it is a general problem, such as the capitalization being wrong for all abbreviated months, you can file a forum request for the first one, and state the general problem there.

### Examples of Problems

Check for consistency between different forms by looking at them side by side.

1. The casing is inconsistent; (e.g. some months are capitalized and others are lower cased). see. capitalization rule.
2. Spelling consistency.
3. Use of hyphens in some rows/columns, but not in others.
4. Some abbreviations have periods and others don't, or some use native 'periods' and others use ASCII ".".


### Person Name tips

1. Please read the [Miscellaneous: Person Name Formats](https://cldr.unicode.org/translation/miscellaneous-person-name-formats) under "**Review Report**".


### Date & Time Review Tips

1. Even if your language preference is to use the 12 hour format, it's important to also pay attention to the **Times 24h** section. In applications using CLDR data, users can set their preference to 24 hour formats.
2. Lower down on the page are charts of weekdays, months, and quarters for review. When a language has two different forms depending on format vs stand-alone, there will be two rows for the same item. Russian, for example, uses the genitive for format (top row, highlighted in yellow in the screenshot), and the nominative for stand-alone (second row).

![image](../../images/Review-Stadalone-vs-formatting.PNG)

### Number formats Review tips

1. Each forms should be acceptable for your locale.
2. Review the cells within each row for consistency.
3. Also look for consistency across the rows for consistency.
4. Check that each cell has the correct plural form (if your language has plural forms).

![image](../../images/Review-numbers.PNG)

### Zones Review tips

1. The first two columns identify the timezone (metazone)
2. Compare the items in each row for consistency.
3. Compare the items in the same column across different rows.
4. City names that use hyphens do not show the hyphens in patterns because they are constructed from the city name and the pattern {0} Zeit. Consider whether it would be better to always remove the hyphens, or to add them to the pattern {0}-Zeit.

![image](../../images/review-zone.PNG)

![Unicode copyright](https://www.unicode.org/img/hb_notice.gif)

0 comments on commit ed980db

Please sign in to comment.