mingkwai-ncr

Table of Contents generated with DocToc

• MingKwai-NCR
  • Usage

MingKwai-NCR

A derivative of NCR with extra data for CJK character processing and typesetting.

Usage

Note—This module is intended to be used as is customary with NodeJS / npm modules, i.e. using require:

MKNCR = require 'mingkwai-ncr'

There are a few points to keep in mind:

• mingkwai-ncr only works properly in tandem with jizura-datasources and mojikura (the Jizura DB feeder);

• those modules are expected to be found within the same 'rack' folder as mingkwai-ncr itself;

• mingkwai-ncr/data/isl-entries.json contains a cached version of the data that is to be organized into an interval skip list for efficient per-codepoint retrieval;

• when any data source files are found to be newer than the cache at the point in time when mingkwai-ncr is required from another module, an exception with a helpful error message will be raised; depending on your current location in the file tree, that message might read

  cache file
  data/isl-entries.json
  is out of date
  run the command
  node lib/main.js
  to rebuild data/isl-entries.json
  

  You can then run node lib/main.js (that is, tell NodeJS to run mingkwai-ncr/lib/main.js as a script) to rebuild the cache.

  I see no way to make the cache-rebuilding step fully transparent; this is because require 'x' is a synchronous call, but rebuilding the cache is inherently asynchronous.