---
title: CLDRModify using Config file
---

# CLDRModify using Config file

The CLDRModify tool can be used to make changes to a number of files, based on a configuration file.

* Either put your changes into `cldr/tool/modify_config.txt`, or use `-k config_file` to specify a different file.
  * Use the format specified below.
  * The path is relative to cldr/tool/
* Remember to specify the target directory, if different than common/main
* Run CLDRModify with the \-fk option, and as usual, diff your changes. For more info, see [CLDRModify Passes](cldrmodify-passes).
* Use the `-I` option so that the original files are overwritten in-place.
* Hint: Try with a subset of locales first, before applying to all.
* The format may change in the future\!
* Be aware that if a value starts with `/` indicating a regex,
  `[@` in the path is automatically replaced with `\[@`.

As an example of how this is done, and the results, see: [TODO ADD EXAMPLE]

## File Format

The file format is a series of lines of the form:

ConfigKeys1=ConfigMatch1 ; ConfigKeys2=ConfigMatch2 ; ...

### Debugging

The following line shows the number of file lines that are applicable to this locale. It may be helpful in debugging.

\# Checking entries & adding: 2

You can also search for /fixList.add('k',/ in the file, and put a breakpoint in handleStart or handlePath.

### ConfigKeys

*locale*, *action*, *path*, *value, new\_path, new\_value*, *draft*

A locale (regex) must be present.

Not all of {*path*, *value, new\_path, new\_value*} will be present (or can be), depending on the action.

### ConfigMatch

For the action, see below. Everything else can be a regex or an exact string.

   // Use a string of "/.../" for a regex match, otherwise an action, otherwise an exact string match.

   // The regex match is a "find", so use /^...$/ for a whole string match.

If the locale is /./, then any locale matches.

***Warning\! This won't work if you need certain literal characters (such as ; or a leading or trailing space, etc.).*** See [TODO](#todo)

* *If it is in a regex, you can use the **\\x3B** format to work around this.*
* *If it is in a UnicodeSet use **\\u003B** format.*

### ConfigAction

**action=delete**

If there is a match for the value and path and locale, then the action is taken.

If the path is empty, any path matches. If the value is empty, any value matches.

**action=add**

The new\_path and new\_value are explicit strings, and the \<new\_path, new\_value\> are added to the files that match the locale.

**action=addNew**

Same as add, but only for paths that don't have values in the original value.

**action=replace**

Replace \<path, value\> with \<newPath, newValue\>

**action=copy**

Add \<newPath\> with any values at paths matched by \<path\>.
If *draft* is set, draft status will be *draft*.

- TODO: optional match *value* as a regex
- TODO: optional *newValue* with regex-replacement from matched *value*

Example:

```
# CLDR-19394 copy Off/On from "ss" to the new typeValues (as unconfirmed)
locale=/^.*/ ; action=copy ; path=//ldml/localeDisplayNames/types/type[@key="ss"][@type="none"][@scope="core"] ; new_path=//ldml/localeDisplayNames/typeValues/typeValue[@type="no"] ; draft=unconfirmed
locale=/^.*/ ; action=copy ; path=//ldml/localeDisplayNames/types/type[@key="ss"][@type="standard"][@scope="core"] ; new_path=//ldml/localeDisplayNames/typeValues/typeValue[@type="yes"] ; draft=unconfirmed
```

If **path** begins with `/^` then it is a regex match, and **new_path** can contain replacement values such as `$0`…`$9`

**action=copyNew**

Same as **copy** but only for paths that don't have values in the original value.

Example:

```
# CLDR-19640 copy 'other' to 'many' for certain locales.
locale=/^(ca|es|fr|it|pt|pt_PT)$/ ; action=copyNew ; path=/^(.*)[@count="other"](.*)$/ ; new_path=$1[@count="many"]$2 ; draft=unconfirmed
```

### Example file

locale= sv ; action=delete; value= YER ; path= //ldml/numbers/currencies/currency\[@type="YER"\]/symbol ;

locale=en ; action=delete ; path=/.\*short.\*/

locale=en ; action=add ; new\_path=//ldml/localeDisplayNames/territories/territory\[@type="PS"\]\[@alt="short"\] ; new\_value=Palestine

### Path Ids

An exact path can be either the literal string or a hex id. So the following are equivalent:

locale= sk ; action=add ; new\_path=68e706b7c7873181 ; new\_value=honduraskej lempiry

locale= sk ; action=add ; new\_path=//ldml/numbers/currencies/currency\[@type="HNL"\]/displayName\[@count="many"\] ; new\_value=honduraskej lempiry

### TODO

Change **add** so that path and/or value can be present, and if so, $0..$9 will be substituted for in the respective new\_path or new\_value.

After splitting at ";", change \\x3B and other \\x{H..H} characters into ";".