Skip to content

auto: Keyman for developer help deployment #1794

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

Merged
keyman-status merged 1 commit into from
Jan 15, 2025
Merged

auto: Keyman for developer help deployment #1794

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions developer/18.0/context/keyboard-editor.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,7 @@ ID
similar to the overloaded behaviour for `K_` ids. Thus `####`
must be valid Unicode characters.
The square bracket characters `[` and `]` indicate an optional portion of the sequence
and are not to be included in the shortcut.
E.g. `U_0259` would generate a
and are not to be included in the shortcut. E.g. `U_0259` would generate a
schwa if no rule matches. It is still valid to have a rule such
as `+ [U_0259] > ...`

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/guides/distribute/tutorial/step-2.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ welcome.htm
> ### Tip
If you want links to your website to open in the user's preferred
browser, preface the href link with `link:`, e.g.
`<a href="http://keyman.com/">website</a>`
`<a href="https://keyman.com/">website</a>`
The `link:` sceheme will open the referred file in the default
application - that is, a web browser for URLs and links, Notepad for
.txt files, Adobe Reader for PDFs. You can use `link:` to open any
Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/guides/distribute/tutorial/step-4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Website

: Enter the name of the website where you will have information about
this keyboard. If you want to host it on keyman.com, you could enter
`http://www.keyman.com/`
`https://keyman.com/`

Image file
: Select the splash image file that you created in Step 2 from the
Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/guides/lexical-models/distribute/tutorial/step-5.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ recommendations:
ZIP archive file!) and you won't save much space by recompressing
it.
3. Include a link to the Keyman download page:
`http://keyman.com/downloads/`
`https://keyman.com/downloads/`

## Distributing a package by email

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km04003.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM04003: ERROR_FileDoesNotExist

| | |
|------------|---------- |
| Message | File &lt;param&gt; does not exist\. |
| Message | File '&lt;param&gt;' does not exist\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `ERROR_FileDoesNotExist` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km04004.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM04004: ERROR_FileCouldNotBeRead

| | |
|------------|---------- |
| Message | File &lt;param&gt; could not be read: unknown error\. |
| Message | File '&lt;param&gt;' could not be read: unknown error\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `ERROR_FileCouldNotBeRead` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km04005.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM04005: WARN_FileIsNotABinaryKvkFile

| | |
|------------|---------- |
| Message | File &lt;param&gt; does not appear to be a valid binary \.kvk file; this may be an old package that includes an xml\-format \.kvk file\. You must update the package to include the compiled \.kvk file in the package\. |
| Message | File '&lt;param&gt;' does not appear to be a valid binary \.kvk file; this may be an old package that includes an xml\-format \.kvk file\. You must update the package to include the compiled \.kvk file in the package\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `WARN_FileIsNotABinaryKvkFile` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km04008.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM04008: ERROR_KeyboardContentFileNotFound

| | |
|------------|---------- |
| Message | Keyboard &lt;param&gt; was listed in &lt;Keyboards&gt; but a corresponding \.kmx file was not found in &lt;Files&gt; |
| Message | Keyboard '&lt;param&gt;' was listed in &lt;Keyboards&gt; but a corresponding \.kmx file was not found in &lt;Files&gt; |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `ERROR_KeyboardContentFileNotFound` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km04009.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM04009: ERROR_KeyboardFileNotValid

| | |
|------------|---------- |
| Message | Keyboard file &lt;param&gt; is not a valid \.kmx file: unknown error |
| Message | Keyboard file '&lt;param&gt;' is not a valid \.kmx file: unknown error |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `ERROR_KeyboardFileNotValid` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km0400a.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM0400A: INFO_KeyboardFileHasNoKeyboardVersion

| | |
|------------|---------- |
| Message | Keyboard file &lt;param&gt; has no &amp;KeyboardVersion store, using default '0\.0' |
| Message | Keyboard file '&lt;param&gt;' has no &amp;KeyboardVersion store, using default '0\.0' |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `INFO_KeyboardFileHasNoKeyboardVersion` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km0400d.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM0400D: WARN_PackageNameDoesNotFollowLexicalModelConventions

| | |
|------------|---------- |
| Message | The package file &lt;param&gt; does not follow the recommended model filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), not start with a digit, and should have the structure &lt;author&gt;\.&lt;bcp47&gt;\.&lt;uniq&gt;\.model\.kps\. |
| Message | The package file '&lt;param&gt;' does not follow the recommended model filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), not start with a digit, and should have the structure &lt;author&gt;\.&lt;bcp47&gt;\.&lt;uniq&gt;\.model\.kps\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `WARN_PackageNameDoesNotFollowLexicalModelConventions` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km0400e.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM0400E: WARN_PackageNameDoesNotFollowKeyboardConventions

| | |
|------------|---------- |
| Message | The package file &lt;param&gt; does not follow the recommended keyboard filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), and not start with a digit\. |
| Message | The package file '&lt;param&gt;' does not follow the recommended keyboard filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), and not start with a digit\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `WARN_PackageNameDoesNotFollowKeyboardConventions` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km0400f.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM0400F: WARN_FileInPackageDoesNotFollowFilenameConventions

| | |
|------------|---------- |
| Message | The file &lt;param&gt; does not follow the recommended filename conventions\. The extension should be all lower case, and the filename should include only alphanumeric characters, \-, \_, \+ and \. |
| Message | The file '&lt;param&gt;' does not follow the recommended filename conventions\. The extension should be all lower case, and the filename should include only alphanumeric characters, \-, \_, \+ and \. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `WARN_FileInPackageDoesNotFollowFilenameConventions` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km04011.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM04011: ERROR_KeyboardFileNotFound

| | |
|------------|---------- |
| Message | Keyboard file &lt;param&gt; was not found\. Has it been compiled? |
| Message | Keyboard file '&lt;param&gt;' was not found\. Has it been compiled? |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `ERROR_KeyboardFileNotFound` |

Expand Down
2 changes: 1 addition & 1 deletion developer/18.0/reference/messages/km0401d.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: KM0401D: HINT_PackageContainsSourceFile

| | |
|------------|---------- |
| Message | The source file &lt;param&gt; should not be included in the package; instead include the compiled result\. |
| Message | The source file '&lt;param&gt;' should not be included in the package; instead include the compiled result\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `HINT_PackageContainsSourceFile` |

Expand Down
11 changes: 11 additions & 0 deletions developer/18.0/reference/messages/km04022.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: KM04022: ERROR_RequiredParameterMissing
---

| | |
|------------|---------- |
| Message | Source parameter '&lt;param&gt;' is required\. |
| Module | [kmc-package.PackageCompilerMessages](kmc-package.packagecompilermessages) |
| Identifier | `ERROR_RequiredParameterMissing` |


23 changes: 12 additions & 11 deletions developer/18.0/reference/messages/kmc-package.packagecompilermessages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,21 @@ title: Compiler Messages Reference for @keymanapp/kmc-package
------|------------|---------
[KM04001](km04001) | `FATAL_UnexpectedException` | This is an internal error; the message will vary
[KM04002](km04002) | `WARN_AbsolutePath` | File &lt;param&gt; has an absolute path, which is not portable\.
[KM04003](km04003) | `ERROR_FileDoesNotExist` | File &lt;param&gt; does not exist\.
[KM04004](km04004) | `ERROR_FileCouldNotBeRead` | File &lt;param&gt; could not be read: unknown error\.
[KM04005](km04005) | `WARN_FileIsNotABinaryKvkFile` | File &lt;param&gt; does not appear to be a valid binary \.kvk file; this may be an old package that includes an xml\-format \.kvk file\. You must update the package to include the compiled \.kvk file in the package\.
[KM04003](km04003) | `ERROR_FileDoesNotExist` | File '&lt;param&gt;' does not exist\.
[KM04004](km04004) | `ERROR_FileCouldNotBeRead` | File '&lt;param&gt;' could not be read: unknown error\.
[KM04005](km04005) | `WARN_FileIsNotABinaryKvkFile` | File '&lt;param&gt;' does not appear to be a valid binary \.kvk file; this may be an old package that includes an xml\-format \.kvk file\. You must update the package to include the compiled \.kvk file in the package\.
[KM04006](km04006) | `ERROR_FollowKeyboardVersionNotAllowedForModelPackages` | FollowKeyboardVersion is not allowed in model packages
[KM04007](km04007) | `ERROR_FollowKeyboardVersionButNoKeyboards` | FollowKeyboardVersion is set, but the package contains no keyboards
[KM04008](km04008) | `ERROR_KeyboardContentFileNotFound` | Keyboard &lt;param&gt; was listed in &lt;Keyboards&gt; but a corresponding \.kmx file was not found in &lt;Files&gt;
[KM04009](km04009) | `ERROR_KeyboardFileNotValid` | Keyboard file &lt;param&gt; is not a valid \.kmx file: unknown error
[KM0400A](km0400a) | `INFO_KeyboardFileHasNoKeyboardVersion` | Keyboard file &lt;param&gt; has no &amp;KeyboardVersion store, using default '0\.0'
[KM04008](km04008) | `ERROR_KeyboardContentFileNotFound` | Keyboard '&lt;param&gt;' was listed in &lt;Keyboards&gt; but a corresponding \.kmx file was not found in &lt;Files&gt;
[KM04009](km04009) | `ERROR_KeyboardFileNotValid` | Keyboard file '&lt;param&gt;' is not a valid \.kmx file: unknown error
[KM0400A](km0400a) | `INFO_KeyboardFileHasNoKeyboardVersion` | Keyboard file '&lt;param&gt;' has no &amp;KeyboardVersion store, using default '0\.0'
[KM0400B](km0400b) | `ERROR_PackageCannotContainBothModelsAndKeyboards` | The package contains both lexical models and keyboards, which is not permitted\.
[KM0400C](km0400c) | `HINT_PackageShouldNotRepeatLanguages` | Two language tags in &lt;param&gt; &lt;param&gt;, '&lt;param&gt;' and '&lt;param&gt;', reduce to the same minimal tag '&lt;param&gt;'\.
[KM0400D](km0400d) | `WARN_PackageNameDoesNotFollowLexicalModelConventions` | The package file &lt;param&gt; does not follow the recommended model filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), not start with a digit, and should have the structure &lt;author&gt;\.&lt;bcp47&gt;\.&lt;uniq&gt;\.model\.kps\.
[KM0400E](km0400e) | `WARN_PackageNameDoesNotFollowKeyboardConventions` | The package file &lt;param&gt; does not follow the recommended keyboard filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), and not start with a digit\.
[KM0400F](km0400f) | `WARN_FileInPackageDoesNotFollowFilenameConventions` | The file &lt;param&gt; does not follow the recommended filename conventions\. The extension should be all lower case, and the filename should include only alphanumeric characters, \-, \_, \+ and \.
[KM0400D](km0400d) | `WARN_PackageNameDoesNotFollowLexicalModelConventions` | The package file '&lt;param&gt;' does not follow the recommended model filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), not start with a digit, and should have the structure &lt;author&gt;\.&lt;bcp47&gt;\.&lt;uniq&gt;\.model\.kps\.
[KM0400E](km0400e) | `WARN_PackageNameDoesNotFollowKeyboardConventions` | The package file '&lt;param&gt;' does not follow the recommended keyboard filename conventions\. The name should be all lower case, include only alphanumeric characters and underscore \(\_\), and not start with a digit\.
[KM0400F](km0400f) | `WARN_FileInPackageDoesNotFollowFilenameConventions` | The file '&lt;param&gt;' does not follow the recommended filename conventions\. The extension should be all lower case, and the filename should include only alphanumeric characters, \-, \_, \+ and \.
[KM04010](km04010) | `ERROR_PackageNameCannotBeBlank` | Package name cannot be an empty string\.
[KM04011](km04011) | `ERROR_KeyboardFileNotFound` | Keyboard file &lt;param&gt; was not found\. Has it been compiled?
[KM04011](km04011) | `ERROR_KeyboardFileNotFound` | Keyboard file '&lt;param&gt;' was not found\. Has it been compiled?
[KM04012](km04012) | `WARN_KeyboardVersionsDoNotMatch` | Keyboard &lt;param&gt; version &lt;param&gt; does not match keyboard &lt;param&gt; version &lt;param&gt;\.
[KM04014](km04014) | `ERROR_LanguageTagIsNotValid` | Language tag '&lt;param&gt;' in &lt;param&gt; &lt;param&gt; is invalid\.
[KM04015](km04015) | `HINT_LanguageTagIsNotMinimal` | Language tag '&lt;param&gt;' in &lt;param&gt; &lt;param&gt; is not minimal, and should be '&lt;param&gt;'\.
Expand All @@ -31,7 +31,8 @@ title: Compiler Messages Reference for @keymanapp/kmc-package
[KM0401A](km0401a) | `WARN_JsKeyboardFileIsMissing` | Keyboard &lt;param&gt; targets touch devices but corresponding &lt;param&gt;\.js file is not in the package\.
[KM0401B](km0401b) | `WARN_KeyboardShouldHaveAtLeastOneLanguage` | The keyboard &lt;param&gt; should have at least one language specified\.
[KM0401C](km0401c) | `HINT_JsKeyboardFileHasNoTouchTargets` | The keyboard &lt;param&gt; has been included for touch platforms, but does not include a touch layout\.
[KM0401D](km0401d) | `HINT_PackageContainsSourceFile` | The source file &lt;param&gt; should not be included in the package; instead include the compiled result\.
[KM0401D](km0401d) | `HINT_PackageContainsSourceFile` | The source file '&lt;param&gt;' should not be included in the package; instead include the compiled result\.
[KM0401F](km0401f) | `ERROR_FileRecordIsMissingName` | File record in the package with description 'undefined' is missing a filename\.
[KM04020](km04020) | `ERROR_InvalidAuthorEmail` | Invalid author email: &lt;param&gt;
[KM04021](km04021) | `ERROR_PackageFileHasEmptyVersion` | Package version is not following keyboard version, but the package version field is blank\.
[KM04022](km04022) | `ERROR_RequiredParameterMissing` | Source parameter '&lt;param&gt;' is required\.
10 changes: 5 additions & 5 deletions developer/core/18.0/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ value.

-------------------------------------------------------------------------------

# km_core_option_scope enum {#km_core_option_scope}
# km_core_option_scope enum

## Description

Expand Down Expand Up @@ -48,7 +48,7 @@ enum km_core_option_scope {

-------------------------------------------------------------------------------

# km_core_option_item struct {#km_core_option_item}
# km_core_option_item struct

## Description

Expand Down Expand Up @@ -78,7 +78,7 @@ struct km_core_option_item {

-------------------------------------------------------------------------------

# km_core_options_list_size() {#km_core_options_list_size}
# km_core_options_list_size()

## Description
Return the length of a terminated [km_core_option_item] array (options
Expand Down Expand Up @@ -150,7 +150,7 @@ km_core_state_option_lookup(km_core_state const *state,

-------------------------------------------------------------------------------

# km_core_state_options_update() {#km_core_state_options_update}
# km_core_state_options_update()

## Description

Expand Down Expand Up @@ -188,7 +188,7 @@ km_core_state_options_update(km_core_state *state,

-------------------------------------------------------------------------------

# km_core_state_options_to_json() {#km_core_state_options_to_json}
# km_core_state_options_to_json()

## Description

Expand Down
Loading