Skip to content

Commit 8bec30c

Browse files
keyman-serverkeyman-server
committed
auto: Keyman for developer help deployment
1 parent 22a90a5 commit 8bec30c

File tree

86 files changed

+6229
-488
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+6229
-488
lines changed

‎developer/19.0/reference/api/index.md‎

Lines changed: 97 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,101 @@
66

77
## Packages
88

9-
| Package | Description |
10-
| --- | --- |
11-
| [@keymanapp/kmc-analyze](./kmc-analyze.md) | kmc-analyze - keyboard analysis classes, including tools for <code>&amp;displayMap</code>. |
12-
| [@keymanapp/kmc-copy](./kmc-copy.md) | |
13-
| [@keymanapp/kmc-generate](./kmc-generate.md) | |
14-
| [@keymanapp/kmc-keyboard-info](./kmc-keyboard-info.md) | |
15-
| [@keymanapp/kmc-kmn](./kmc-kmn.md) | kmc-kmn - Keyman keyboard compiler |
16-
| [@keymanapp/kmc-ldml](./kmc-ldml.md) | |
17-
| [@keymanapp/kmc-model](./kmc-model.md) | |
18-
| [@keymanapp/kmc-model-info](./kmc-model-info.md) | |
19-
| [@keymanapp/kmc-package](./kmc-package.md) | |
9+
<table><thead><tr><th>
10+
11+
Package
12+
13+
14+
</th><th>
15+
16+
Description
17+
18+
19+
</th></tr></thead>
20+
<tbody><tr><td>
21+
22+
[@keymanapp/kmc-analyze](./kmc-analyze.md)
23+
24+
25+
</td><td>
26+
27+
kmc-analyze - keyboard analysis classes, including tools for `&displayMap`<!-- -->.
28+
29+
30+
</td></tr>
31+
<tr><td>
32+
33+
[@keymanapp/kmc-copy](./kmc-copy.md)
34+
35+
36+
</td><td>
37+
38+
39+
</td></tr>
40+
<tr><td>
41+
42+
[@keymanapp/kmc-generate](./kmc-generate.md)
43+
44+
45+
</td><td>
46+
47+
48+
</td></tr>
49+
<tr><td>
50+
51+
[@keymanapp/kmc-keyboard-info](./kmc-keyboard-info.md)
52+
53+
54+
</td><td>
55+
56+
57+
</td></tr>
58+
<tr><td>
59+
60+
[@keymanapp/kmc-kmn](./kmc-kmn.md)
61+
62+
63+
</td><td>
64+
65+
kmc-kmn - Keyman keyboard compiler
66+
67+
68+
</td></tr>
69+
<tr><td>
70+
71+
[@keymanapp/kmc-ldml](./kmc-ldml.md)
72+
73+
74+
</td><td>
75+
76+
77+
</td></tr>
78+
<tr><td>
79+
80+
[@keymanapp/kmc-model](./kmc-model.md)
81+
82+
83+
</td><td>
84+
85+
86+
</td></tr>
87+
<tr><td>
88+
89+
[@keymanapp/kmc-model-info](./kmc-model-info.md)
90+
91+
92+
</td><td>
93+
94+
95+
</td></tr>
96+
<tr><td>
97+
98+
[@keymanapp/kmc-package](./kmc-package.md)
99+
100+
101+
</td><td>
102+
103+
104+
</td></tr>
105+
</tbody></table>
20106

‎developer/19.0/reference/api/kmc-analyze.analyzeoskcharacteruse._constructor_.md‎

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,51 @@ constructor(callbacks: CompilerCallbacks, options?: AnalyzeOskCharacterUseOption
1414

1515
## Parameters
1616

17-
| Parameter | Type | Description |
18-
| --- | --- | --- |
19-
| callbacks | CompilerCallbacks | |
20-
| options | [AnalyzeOskCharacterUseOptions](./kmc-analyze.analyzeoskcharacteruseoptions.md) | _(Optional)_ |
17+
<table><thead><tr><th>
18+
19+
Parameter
20+
21+
22+
</th><th>
23+
24+
Type
25+
26+
27+
</th><th>
28+
29+
Description
30+
31+
32+
</th></tr></thead>
33+
<tbody><tr><td>
34+
35+
callbacks
36+
37+
38+
</td><td>
39+
40+
CompilerCallbacks
41+
42+
43+
</td><td>
44+
45+
46+
</td></tr>
47+
<tr><td>
48+
49+
options
50+
51+
52+
</td><td>
53+
54+
[AnalyzeOskCharacterUseOptions](./kmc-analyze.analyzeoskcharacteruseoptions.md)
55+
56+
57+
</td><td>
58+
59+
_(Optional)_
60+
61+
62+
</td></tr>
63+
</tbody></table>
2164

‎developer/19.0/reference/api/kmc-analyze.analyzeoskcharacteruse.analyze.md‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,39 @@ analyze(file: string): Promise<boolean>;
1616

1717
## Parameters
1818

19-
| Parameter | Type | Description |
20-
| --- | --- | --- |
21-
| file | string | relative or absolute path to a Keyman source file |
19+
<table><thead><tr><th>
20+
21+
Parameter
22+
23+
24+
</th><th>
25+
26+
Type
27+
28+
29+
</th><th>
30+
31+
Description
32+
33+
34+
</th></tr></thead>
35+
<tbody><tr><td>
36+
37+
file
38+
39+
40+
</td><td>
41+
42+
string
43+
44+
45+
</td><td>
46+
47+
relative or absolute path to a Keyman source file
48+
49+
50+
</td></tr>
51+
</tbody></table>
2252

2353
**Returns:**
2454

‎developer/19.0/reference/api/kmc-analyze.analyzeoskcharacteruse.getstrings.md‎

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,39 @@ getStrings(format?: '.txt' | '.md' | '.json'): string[];
2222

2323
## Parameters
2424

25-
| Parameter | Type | Description |
26-
| --- | --- | --- |
27-
| format | '.txt' \| '.md' \| '.json' | _(Optional)_ file format to return - can be '.txt', '.md', or '.json' |
25+
<table><thead><tr><th>
26+
27+
Parameter
28+
29+
30+
</th><th>
31+
32+
Type
33+
34+
35+
</th><th>
36+
37+
Description
38+
39+
40+
</th></tr></thead>
41+
<tbody><tr><td>
42+
43+
format
44+
45+
46+
</td><td>
47+
48+
'.txt' \| '.md' \| '.json'
49+
50+
51+
</td><td>
52+
53+
_(Optional)_ file format to return - can be '.txt', '.md', or '.json'
54+
55+
56+
</td></tr>
57+
</tbody></table>
2858

2959
**Returns:**
3060

‎developer/19.0/reference/api/kmc-analyze.analyzeoskcharacteruse.md‎

Lines changed: 100 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,107 @@ export declare class AnalyzeOskCharacterUse
1414

1515
## Constructors
1616

17-
| Constructor | Modifiers | Description |
18-
| --- | --- | --- |
19-
| [(constructor)(callbacks, options)](./kmc-analyze.analyzeoskcharacteruse._constructor_.md) | | Constructs a new instance of the <code>AnalyzeOskCharacterUse</code> class |
17+
<table><thead><tr><th>
18+
19+
Constructor
20+
21+
22+
</th><th>
23+
24+
Modifiers
25+
26+
27+
</th><th>
28+
29+
Description
30+
31+
32+
</th></tr></thead>
33+
<tbody><tr><td>
34+
35+
[(constructor)(callbacks, options)](./kmc-analyze.analyzeoskcharacteruse._constructor_.md)
36+
37+
38+
</td><td>
39+
40+
41+
</td><td>
42+
43+
Constructs a new instance of the `AnalyzeOskCharacterUse` class
44+
45+
46+
</td></tr>
47+
</tbody></table>
2048

2149
## Methods
2250

23-
| Method | Modifiers | Description |
24-
| --- | --- | --- |
25-
| [analyze(file)](./kmc-analyze.analyzeoskcharacteruse.analyze.md) | | <p>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()](./kmc-analyze.analyzeoskcharacteruse.getstrings.md) to retrieve results.</p><p>Note: <code>analyze()</code> 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.</p> |
26-
| [clear()](./kmc-analyze.analyzeoskcharacteruse.clear.md) | | Clears analysis data collected from previous calls to [AnalyzeOskCharacterUse.analyze()](./kmc-analyze.analyzeoskcharacteruse.analyze.md) |
27-
| [getStrings(format)](./kmc-analyze.analyzeoskcharacteruse.getstrings.md) | | <p>Returns the collected results from earlier calls to [AnalyzeOskCharacterUse.analyze()](./kmc-analyze.analyzeoskcharacteruse.analyze.md)<!-- -->. This generates a mapping from a key cap (one or more characters) to a PUA code, for use with <code>&amp;displayMap</code>.</p><p>Three output formats are supported:</p><p>- .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.</p><p>- .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.</p><p>- .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, <code>map</code>, which is an array of objects.</p> |
51+
<table><thead><tr><th>
52+
53+
Method
54+
55+
56+
</th><th>
57+
58+
Modifiers
59+
60+
61+
</th><th>
62+
63+
Description
64+
65+
66+
</th></tr></thead>
67+
<tbody><tr><td>
68+
69+
[analyze(file)](./kmc-analyze.analyzeoskcharacteruse.analyze.md)
70+
71+
72+
</td><td>
73+
74+
75+
</td><td>
76+
77+
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()](./kmc-analyze.analyzeoskcharacteruse.getstrings.md) to retrieve results.
78+
79+
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.
80+
81+
82+
</td></tr>
83+
<tr><td>
84+
85+
[clear()](./kmc-analyze.analyzeoskcharacteruse.clear.md)
86+
87+
88+
</td><td>
89+
90+
91+
</td><td>
92+
93+
Clears analysis data collected from previous calls to [AnalyzeOskCharacterUse.analyze()](./kmc-analyze.analyzeoskcharacteruse.analyze.md)
94+
95+
96+
</td></tr>
97+
<tr><td>
98+
99+
[getStrings(format)](./kmc-analyze.analyzeoskcharacteruse.getstrings.md)
100+
101+
102+
</td><td>
103+
104+
105+
</td><td>
106+
107+
Returns the collected results from earlier calls to [AnalyzeOskCharacterUse.analyze()](./kmc-analyze.analyzeoskcharacteruse.analyze.md)<!-- -->. This generates a mapping from a key cap (one or more characters) to a PUA code, for use with `&displayMap`<!-- -->.
108+
109+
Three output formats are supported:
110+
111+
- .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.
112+
113+
- .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.
114+
115+
- .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.
116+
117+
118+
</td></tr>
119+
</tbody></table>
28120

0 commit comments

Comments
 (0)