erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-06 17:05:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 16
spiegel-keyman/developer/docs/help/reference/api/kmc-analyze.analyzeoskrewritepua.analyze.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

1.2 KiB
Raw Blame History

Home > @keymanapp/kmc-analyze > AnalyzeOskRewritePua > analyze

AnalyzeOskRewritePua.analyze() method

Analyze a keyboard file or files, and provide a remapped output. Accepts a .kmn, .kvks, .keyman-touch-layout file formats. For .kmn, will rewrite associated On Screen Keyboard file formats. Can be called multiple times to rewrite multiple files. Use the AnalyzeOskRewritePua.data property to retrieve the output file content for writing. This does not modify the source file.

Signature:

analyze(file: string, mapping: Osk.StringResult[]): Promise<boolean>;

Parameters

Parameter Type Description
file string relative or absolute path to a Keyman source file
mapping Osk.StringResult[] OSK keycap map provided by AnalyzeOskCharacterUse

Returns:

Promise<boolean>

true if the file is successfully loaded and rewritten