erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
spiegel-keyman/developer/docs/help/reference/api/kmc-analyze.analyzeoskcharacteruse.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

2.6 KiB
Raw Permalink Blame History

Home > @keymanapp/kmc-analyze > AnalyzeOskCharacterUse

AnalyzeOskCharacterUse class

Analyze the characters used in On Screen Keyboard files (.kvks, .keyman-touch-layout) for use with &displayMap.

Signature:

export declare class AnalyzeOskCharacterUse

Constructors

Constructor Modifiers Description
(constructor)(callbacks, options) Constructs a new instance of the AnalyzeOskCharacterUse class

Methods

Method Modifiers Description
analyze(file)

Analyzes a single source file for Unicode character usage. Can parse .kmn, .kvks, .keyman-touch-layout file formats. Can be called multiple times to collect results from more than one file. Use AnalyzeOskCharacterUse.getStrings() to retrieve results.

Note: analyze() collects key cap data, so calling this for a .kmn file will retrieve the key caps from the .kvks and .keyman-touch-layout files that it references, rather than key cap data from the .kmn file itself.
clear() Clears analysis data collected from previous calls to AnalyzeOskCharacterUse.analyze()
getStrings(format)

Returns the collected results from earlier calls to AnalyzeOskCharacterUse.analyze(). This generates a mapping from a key cap (one or more characters) to a PUA code, for use with &displayMap.

Three output formats are supported:

- .txt: tab-separated string format, with three columns: PUA, Key Cap, and plain string. The PUA and Key Cap columns are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string is the original key cap string.

- .md: formatted for documentation purposes. Generates a Markdown table (GFM) with PUA, Key Cap, and plain string. The PUA and Key Cap columns are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string is the original key cap string.

- .json: returns the final aggregated data as an array of strings, which can be joined to form a JSON blob of an object with a single member, map, which is an array of objects.