Skip to content

doc: add documentation on ICU #13916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
TimothyGu wants to merge 6 commits into from
Closed

doc: add documentation on ICU #13916

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ed3386b
doc: add documentation on ICU
TimothyGu Jun 26, 2017
a844e1f
Address jasnell's comments
TimothyGu Jun 27, 2017
1ac1491
use relative links to api docs
TimothyGu Jun 27, 2017
379d7b3
address vsemozhetbyt's comment
TimothyGu Jun 27, 2017
36e3695
mention repl line editing
TimothyGu Jun 27, 2017
10beb9c
Adjust for linting
TimothyGu Jul 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Address jasnell's comments
  • Loading branch information
@TimothyGu
TimothyGu committed Jul 5, 2017
commit a844e1f5bcca0e015e093de21824847cfe92bf0a
18 changes: 10 additions & 8 deletions doc/api/intl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ programs. Some of them are:

Node.js (and its underlying V8 engine) uses [ICU][] to implement these features
in native C/C++ code. However, some of them require a very large ICU data file
in order to support all locales of the world. Since most Node.js users will
make use of only a small section in the full ICU data set, we provide several
options for customizing ICU support in a Node.js build.
in order to support all locales of the world. Because it is expected that most
Node.js users will make use of only a small portion of ICU functionality, only
a subset of the full ICU data set is provided by Node.js by default. Several
options are provided for customizing and expanding the ICU data set either when
building or running Node.js.

## Options for building Node.js

Expand Down Expand Up @@ -62,7 +64,7 @@ will be **unavailable** in the resulting `node` binary.

Node.js can link against an ICU build already installed on the system. In fact,
most Linux distributions already come with ICU installed, and this option would
make it possible to reuse the same set of data used by other components in your
make it possible to reuse the same set of data used by other components in the
OS.

Functionalities that only require the ICU library itself, such as
Expand Down Expand Up @@ -101,9 +103,9 @@ are also built in this mode.

#### Providing ICU data at runtime

If you use the `small-icu` option, you can still provide additional locale data
If the `small-icu` option is used, one can still provide additional locale data
at runtime so that the JS methods would work for all ICU locales. Assuming the
data file is stored at `/some/directory`, you could make ICU be aware of it
data file is stored at `/some/directory`, it can be made available to ICU
through either:

* The [`NODE_ICU_DATA`][] environmental variable:
Expand All @@ -124,7 +126,7 @@ ICU is able to automatically find and load a variety of data formats, but the
data must be appropriate for the ICU version, and the file correctly named.
The most common name for the data file is `icudt5X[bl].dat`, where `5X` denotes
the intended ICU version, and `b` or `l` indicates the system's endianness.
Check "[ICU Data][]" article in the ICU User Guide for other supported formats
Check ["ICU Data"][] article in the ICU User Guide for other supported formats
and more details on ICU data in general.

The [full-icu][] npm module can greatly simplify ICU data installation by
Expand Down Expand Up @@ -188,7 +190,7 @@ to be helpful:
[ECMA-402]: https://tc39.github.io/ecma402/
[full-icu]: https://www.npmjs.com/package/full-icu
[ICU]: http://icu-project.org/
[ICU Data]: http://userguide.icu-project.org/icudata
["ICU Data"]: http://userguide.icu-project.org/icudata
[`--icu-data-dir`]: https://nodejs.org/api/cli.html#cli_icu_data_dir_file
[internationalized domain names]: https://en.wikipedia.org/wiki/Internationalized_domain_name
[`Intl`]: https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Intl
Expand Down