Skip to content

Commit 81673c6

Browse files
committed
refactor(windows): move windows Engine help in-repo
Relates-to: #12347
1 parent ed1c106 commit 81673c6

File tree

208 files changed

+5122
-1
lines changed

Some content is hidden

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

208 files changed

+5122
-1
lines changed

resources/build/help-keyman-com.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ function upload_keyman_help {
9393
windows)
9494
# Note: `/windows/src/desktop/help/build.sh web` must be run first
9595
upload windows/bin/help/md/desktop products/windows/$VERSION_RELEASE
96+
upload windows/help/engine developer/engine/windows/$VERSION_RELEASE
9697
;;
9798
developer)
9899
# Note: `/developer/build.sh api` must be run first - covers both uploads
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: IKeyman::Apply Method
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Apply` method applies the changes which have been made
8+
through the current API instantiation to the Keyman Engine. If
9+
[`IKeyman::AutoApply`](AutoApply) is set to `False`, `Apply` must be
10+
called after making changes through the Keyman API. The documentation
11+
for each method that makes changes documents whether or not `Apply`
12+
needs to be called.
13+
14+
## Specification
15+
16+
``` clike
17+
void Apply(void)
18+
```
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: IKeyman::AutoApply Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::AutoApply` property determines if the API will apply
8+
changes automatically to the Keyman Engine after each change is made.
9+
Some changes are applied immediately, such as installing a keyboard
10+
layout. However other changes will not be applied unless the
11+
[`Apply`](Apply) method is called, or unless `AutoApply` is set to
12+
`True`. The documentation for each method that makes changes documents
13+
whether or not `Apply` needs to be called.
14+
15+
`AutoApply` defaults to `True`.
16+
17+
## Specification
18+
19+
``` clike
20+
bool AutoApply
21+
```
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: IKeyman::Control Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Control` property returns the Keyman
8+
[`IKeymanControl`](../IKeymanControl) interface which provides methods
9+
to control various aspects of the Keyman process and user interface
10+
interactions.
11+
12+
## Specification
13+
14+
``` clike
15+
readonly IKeymanControl* Control
16+
```
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: IKeyman::Errors Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Errors` property returns the Keyman
8+
[`IKeymanErrors`](../IKeymanErrors) interface which provides a list of
9+
errors encountered by the Keyman API, for example when installing a
10+
keyboard or package. When the Keyman API raises an exception, e.g. when
11+
trying to install a corrupt package file, there may be additional
12+
details available in the `Errors` collection.
13+
14+
## Specification
15+
16+
``` clike
17+
readonly IKeymanErrors* Errors
18+
```
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: IKeyman::Hotkeys Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Hotkeys` property returns the Keyman
8+
[`IKeymanHotkeys`](../IKeymanHotkeys) interface which provides a list of
9+
configured user interface hotkeys. Hotkeys for activating a specific
10+
keyboard layout are not listed here; these are visible under the
11+
[`IKeymanLanguage::Hotkey`](../IKeymanLanguage/Hotkey) property.
12+
13+
## Specification
14+
15+
``` clike
16+
readonly IKeymanHotkeys* Hotkeys
17+
```
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: IKeyman::Keyboards Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Keyboards` property returns the Keyman
8+
[`IKeymanKeyboardsInstalled`](../IKeymanKeyboardsInstalled) interface
9+
which provides a list of installed Keyman keyboards.
10+
11+
## Specification
12+
13+
``` clike
14+
readonly IKeymanKeyboardsInstalled* Keyboards
15+
```
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: IKeyman::Languages Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Languages` property returns the Keyman
8+
[`IKeymanLanguages`](../IKeymanLanguages) interface which provides a
9+
list of all currently available Windows languages and input methods.
10+
11+
## Specification
12+
13+
``` clike
14+
readonly IKeymanLanguages* Languages
15+
```
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: IKeyman::Options Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Options` property returns the Keyman
8+
[`IKeymanOptions`](../IKeymanOptions) interface which provides a list of
9+
configuration settings and values in Keyman Engine for Windows.
10+
11+
## Specification
12+
13+
``` clike
14+
readonly IKeymanOptions* Options
15+
```
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: IKeyman::Packages Property
3+
---
4+
5+
## Introduction
6+
7+
The `IKeyman::Packages` property returns the Keyman
8+
[`IKeymanPackagesInstalled`](../IKeymanPackagesInstalled) interface
9+
which provides a list of installed Keyman keyboard packages.
10+
11+
## Specification
12+
13+
``` clike
14+
readonly IKeymanPackagesInstalled* Packages
15+
```

0 commit comments

Comments
 (0)