diff --git a/docs/site/development/cldr-big-red-switch/generating-charts.md b/docs/site/development/cldr-big-red-switch/generating-charts.md index bd89516a8b1..556859ade3f 100644 --- a/docs/site/development/cldr-big-red-switch/generating-charts.md +++ b/docs/site/development/cldr-big-red-switch/generating-charts.md @@ -2,27 +2,26 @@ title: Generating Charts --- -# Generating Charts - ## Generate -The input for this is the cldr\-staging/production file, and the output is in github cldr\-staging. **(If for the development version, the input is main or the maint branch, but we should change that.)** +The input for this process is the `../cldr-staging/production` file, and the output is in the github repo [`cldr-staging`](https://github.com/unicode-org/cldr-staging). **(If for the development version, the input is `main` or the `maint` branch, but we should change that.)** `cldr-staging` is expected to be checked out as a _sibling_ directory to your CLDR source repository, hence `../cldr-staging`. 1. Make sure the settings and VM arguments are right for where you are in the release: 1. **Start, Mid\-release, Prefinal release,** or **Final release** (see below) -2. Run GenerateAllCharts. The results for each will be in ... cldr\-staging/docs/charts/by\_type/names.currency.html and so on. -3. Spot\-check for sanity. - 1. Start from the main page (eg cldr\-staging/docs/charts/index.html), and click on each of those links. +2. Build the keyboard charts, see if it was not run. +3. Run the Java tool `GenerateAllCharts`. The results for each will be in `../cldr-staging/docs/charts/by_type/names.currency.html` and so on. +4. Spot\-check for sanity. + 1. Start from the main page (eg `cldr-staging/docs/charts/index.html`), and click on each of those links. 2. On each of the subpages, take the first chart on each page, recursively. 3. Use the "Index" link to go back up (not the back button), and make sure it goes to the right version of the page. -4. Check into github on cldr\-staging +5. PR into github in the `cldr-staging` repo. ## Start Release -1. Make sure the version  (eg **99**) is right in ToolConstants +1. Make sure the version  (eg **`99`**) is right in `ToolConstants.java` 1. Make sure the *last* number (eg **99\.0**) is in CLDR\_VERSIONS 2. Set DEFAULT\_CHART\_VERSION \= "99"; -2. Add an new folder with that number, such as cldr\-staging/docs/charts/**99** +2. Add an new folder with that number, such as `cldr-staging/docs/charts/`**99** 3. Create the archive ([Creating the Archive](/development/creating-the-archive)) with at least the last release (if you don't have it already) 4. **Use the same VM arguments as Mid\-Release** @@ -37,30 +36,30 @@ The input for this is the cldr\-staging/production file, and the output is in gi 1. VM Arguments 1. \-DCHART\_VERSION\=**99** 2. \-DCHART\_STATUS\=**trunk** (uses trunk, no β. Used at the end of the release, but before the final data is in cldr\-archive) -2. In the printout from delta\_summary.txt, there is a listing of the sizes at the top +2. In the printout from `tsv/delta_summary.tsv`, there is a listing of the sizes at the top 1. Something like the following: 1. \# dir file added deleted changed total 1. TOTAL 30,276 3,601 10,909 2,153,094 - 2. Add those new figures to the release page + 2. Add those new figures to the release page _(TODO: where?)_ ## Final Release 1. Make sure the settings are: 1. \-DCHART\_VERSION\=**99** - 2. \-DCHART\_STATUS\=**release** (only uses the cldr\-archive, no β) -2. Change the page to add the new release -3. Check the redirection links on [test\-chart\-links](/development/cldr-big-red-switch/test-chart-links). -4. On index.html; open it, and fix the version (eg to 25β \=\> 25\) + 2. \-DCHART\_STATUS\=**release** (only uses the `cldr-archive`, no β) +2. Check the redirection links on [test\-chart\-links](/development/cldr-big-red-switch/test-chart-links). +3. On `index.html`; open it, and fix the version (eg to 25β \=\> 25\) ## Modifying the chart programs -The chart programs have grown over time, and need some cleanup. For example, the supplemental charts duplicate code that is now in SupplementalDataInfo.  - -### ShowLanguages. +The chart programs have grown over time, and need some cleanup. For example, the supplemental charts duplicate code that is now in `SupplementalDataInfo.java` -The messages that they use are in a file util/data/chart\_messages.html. The right cell contains the key, which is extracted by lines like: +### `ShowLanguages.java` - PrintWriter pw \= new PrintWriter(new FormattedFileWriter(index, "Zone \\u2192 Tzid", null)); +The messages that they use are in a file `util/data/chart_messages.html`. The right cell contains the key, which is extracted by lines like: -The key will be zone\_tzid, in this case. +```java +PrintWriter pw = new PrintWriter(new FormattedFileWriter(index, "Zone \u2192 Tzid", null)); +``` +The key will be `zone_tzid`, in this case.