auto: Keyman for windows help deployment

developer/engine/windows/19.0/api/IKeymanKeyboardFile/Install.md

@@ -45,3 +45,7 @@ void Install(bool Force)
 [`IKeymanKeyboardFile2::Install2`](../IKeymanKeyboardFile2/Install2)
 :   Installs a keyboard file, optionally with input method for default
     language
+
+[`IKeymanKeyboardFile3::Install3()`](../IKeymanKeyboardFile3/Install3)
+:   Installs the keyboard file and compiles its layout against the
+    specified base keyboard.

developer/engine/windows/19.0/api/IKeymanKeyboardFile/index.md

@@ -17,7 +17,9 @@ will not have been installed but can be any keyboard file on disk.
 > >
 > > > **`IKeymanKeyboardFile`**  
 > > >
-> > > > [`IKeymanKeyboardFile2`](../IKeymanKeyboardFile2)  
+> > > > [`IKeymanKeyboardFile2`](../IKeymanKeyboardFile2)
+> > > >
+> > > > [`IKeymanKeyboardFile3`](../IKeymanKeyboardFile3)
 
 ## Properties
 

developer/engine/windows/19.0/api/IKeymanKeyboardFile2/Install2.md

@@ -48,3 +48,7 @@ void Install(bool Force, bool InstallDefaultLanguage)
 
 [`IKeymanKeyboardFile::Install`](../IKeymanKeyboardFile/Install)
 :   Installs a keyboard file and input method for default language
+
+[`IKeymanKeyboardFile3::Install3()`](../IKeymanKeyboardFile3/Install3)
+:   Installs the keyboard file and compiles its layout against the
+    specified base keyboard.

developer/engine/windows/19.0/api/IKeymanKeyboardFile2/index.md

@@ -9,15 +9,17 @@ will not have been installed but can be any keyboard file on disk.
 
 ## Interface Hierarchy
 
-`IDispatch`  
+`IDispatch`
 
-> [`IKeymanObject`](../IKeymanObject)  
+> [`IKeymanObject`](../IKeymanObject)
 >
-> > [`IKeymanKeyboard`](../IKeymanKeyboard)  
+> > [`IKeymanKeyboard`](../IKeymanKeyboard)
 > >
-> > > [`IKeymanKeyboardFile`](../IKeymanKeyboardFile)  
+> > > [`IKeymanKeyboardFile`](../IKeymanKeyboardFile)
 > > >
-> > > > **`IKeymanKeyboardFile2`**  
+> > > > **`IKeymanKeyboardFile2`**
+> > > >
+> > > > [`IKeymanKeyboardFile3`](../IKeymanKeyboardFile3)
 
 ## Methods
 

developer/engine/windows/19.0/api/IKeymanKeyboardFile3/Install3.md

@@ -0,0 +1,43 @@
+---
+title: IKeymanKeyboardFile3::Install3 Method
+---
+
+## Introduction
+
+The `IKeymanKeyboardFile3::Install3` method installs the keyboard file
+(.kmx) into Keyman Engine for Windows. During installation, the keyboard
+layout is compiled against the specified base keyboard. As installing
+Windows input methods is an asynchronous process, this method may not be
+complete when it returns.
+
+This method requires elevated privileges.
+
+## Specification
+
+``` clike
+void Install3(bool Force, int BaseKeyboardID)
+```
+
+## Parameters
+
+`Force`
+:   If `True`, overwrites an existing keyboard entry.
+
+`BaseKeyboardID`
+:   The ID of the base keyboard to compile the keyboard layout against.
+
+## See also
+
+[`IKeymanKeyboardsInstalled::Install`](../IKeymanKeyboardsInstalled/Install)
+:   Installs a keyboard file and input method for default language
+
+[`IKeymanKeyboardsInstalled::Install2`](../IKeymanKeyboardsInstalled2/Install2)
+:   Installs a keyboard file, optionally with input method for default
+    language
+
+[`IKeymanKeyboardFile::Install`](../IKeymanKeyboardFile/Install)
+:   Installs a keyboard file and input method for default language
+
+[`IKeymanKeyboardFile2::Install2`](../IKeymanKeyboardFile2/Install2)
+:   Installs a keyboard file, optionally with input method for default
+    language

developer/engine/windows/19.0/api/IKeymanKeyboardFile3/index.md

@@ -0,0 +1,33 @@
+---
+title: IKeymanKeyboardFile3 Interface
+---
+
+## Introduction
+
+The `IKeymanKeyboardFile3` interface describes a keyboard file and adds an
+installation method that compiles the keyboard layout against a specified
+base keyboard.
+
+## Interface Hierarchy
+
+`IDispatch`
+
+> [`IKeymanObject`](../IKeymanObject)
+>
+> > [`IKeymanKeyboard`](../IKeymanKeyboard)
+> >
+> > > [`IKeymanKeyboardFile`](../IKeymanKeyboardFile)
+> > >
+> > > > [`IKeymanKeyboardFile2`](../IKeymanKeyboardFile2)
+> > > >
+> > > > **`IKeymanKeyboardFile3`**
+
+## Methods
+
+[`Install3()`](Install3)
+:   Installs the keyboard file and compiles its layout against the
+    specified base keyboard.
+
+## History
+
+Added in Keyman Engine for Windows 19.0.

developer/engine/windows/19.0/api/IKeymanKeyboardInstalled/index.md

@@ -6,17 +6,19 @@ title: IKeymanKeyboardInstalled Interface
 
 The `IKeymanKeyboardInstalled` interface describes a keyboard file that
 has been installed and allows modification of [keyboard option
-values](Options) for the keyboard file.
+values](../IKeymanKeyboardInstalled/Options) for the keyboard file.
 
 ## Interface Hierarchy
 
-`IDispatch`  
+`IDispatch`
 
-> [`IKeymanObject`](../IKeymanObject)  
+> [`IKeymanObject`](../IKeymanObject)
 >
-> > [`IKeymanKeyboard`](../IKeymanKeyboard)  
+> > [`IKeymanKeyboard`](../IKeymanKeyboard)
 > >
-> > > **`IKeymanKeyboardInstalled`**  
+> > > **`IKeymanKeyboardInstalled`**
+> > >
+> > > [`IKeymanKeyboardInstalled2`](../IKeymanKeyboardInstalled2)
 
 ## Properties
 

developer/engine/windows/19.0/api/IKeymanKeyboardInstalled2/MCompileForBaseKeyboard.md

@@ -0,0 +1,22 @@
+---
+title: IKeymanKeyboardInstalled2::MCompileForBaseKeyboard Method
+---
+
+## Introduction
+
+The `IKeymanKeyboardInstalled2::MCompileForBaseKeyboard` method recompiles
+an installed keyboard layout against the specified Windows base
+keyboard layout. The base layout is identified by its Windows Keyboard
+Layout ID (KLID).
+
+## Specification
+
+``` clike
+void MCompileForBaseKeyboard(integer KLID)
+```
+
+## Parameters
+
+`KLID`
+:   The Windows Keyboard Layout ID of the base keyboard layout to compile
+    this keyboard against.

developer/engine/windows/19.0/api/IKeymanKeyboardInstalled2/index.md

@@ -0,0 +1,31 @@
+---
+title: IKeymanKeyboardInstalled2 Interface
+---
+
+## Introduction
+
+The `IKeymanKeyboardInstalled2` interface describes a keyboard file that
+has been installed and allows modification of [keyboard option
+values](../IKeymanKeyboardInstalled/Options) for the keyboard file.
+
+## Interface Hierarchy
+
+`IDispatch`
+
+> [`IKeymanObject`](../IKeymanObject)
+>
+> > [`IKeymanKeyboard`](../IKeymanKeyboard)
+> >
+> > > [`IKeymanKeyboardInstalled`](../IKeymanKeyboardInstalled)
+> > >
+> > > > **`IKeymanKeyboardInstalled2`**
+
+
+## Methods
+
+[`MCompileForBaseKeyboard()`](MCompileForBaseKeyboard)
+:  Recompiles the keyboard layout against the supplied base keyboard ID.
+
+## History
+
+Added in Keyman Engine for Windows 19.0.

developer/engine/windows/19.0/api/IKeymanKeyboardsInstalled/Install.md

@@ -42,3 +42,7 @@ void Install(string Filename, bool Force)
 [`IKeymanKeyboardFile2::Install2`](../IKeymanKeyboardFile2/Install2)
 :   Installs a keyboard file, optionally with input method for default
     language
+
+[`IKeymanKeyboardsInstalled3::Install3()`](../IKeymanKeyboardsInstalled3/Install3)
+:   Installs the keyboard file and compiles its layout against the
+    specified base keyboard

developer/engine/windows/19.0/api/IKeymanKeyboardsInstalled/index.md

@@ -9,17 +9,19 @@ in Keyman Engine for Windows API.
 
 ## Interface Hierarchy
 
-`IDispatch`  
+`IDispatch`
 
-> [`IKeymanObject`](../IKeymanObject)  
+> [`IKeymanObject`](../IKeymanObject)
 >
-> > [`IKeymanCollection`](../IKeymanCollection)  
+> > [`IKeymanCollection`](../IKeymanCollection)
 > >
-> > > [`IKeymanKeyboards`](../IKeymanKeyboards)  
+> > > [`IKeymanKeyboards`](../IKeymanKeyboards)
 > > >
-> > > > **`IKeymanKeyboardsInstalled`**  
+> > > > **`IKeymanKeyboardsInstalled`**
 > > > >
-> > > > > [`IKeymanKeyboardsInstalled2`](../IKeymanKeyboardsInstalled2)  
+> > > > > [`IKeymanKeyboardsInstalled2`](../IKeymanKeyboardsInstalled2)
+> > > > >
+> > > > > [`IKeymanKeyboardsInstalled3`](../IKeymanKeyboardsInstalled3)
 
 ## Properties
 

developer/engine/windows/19.0/api/IKeymanKeyboardsInstalled2/Install2.md

@@ -46,3 +46,7 @@ void Install2(string Filename, bool Force, bool InstallDefaultLanguage)
 [`IKeymanKeyboardFile2::Install2`](../IKeymanKeyboardFile2/Install2)
 :   Installs a keyboard file, optionally with input method for default
     language
+
+[`IKeymanKeyboardsInstalled3::Install3()`](../IKeymanKeyboardsInstalled3/Install3)
+:   Installs the keyboard file and compiles its layout against the
+    specified base keyboard

developer/engine/windows/19.0/api/IKeymanKeyboardsInstalled2/index.md

@@ -9,17 +9,19 @@ for installing additional keyboards.
 
 ## Interface Hierarchy
 
-`IDispatch`  
+`IDispatch`
 
-> [`IKeymanObject`](../IKeymanObject)  
+> [`IKeymanObject`](../IKeymanObject)
 >
-> > [`IKeymanCollection`](../IKeymanCollection)  
+> > [`IKeymanCollection`](../IKeymanCollection)
 > >
-> > > [`IKeymanKeyboards`](../IKeymanKeyboards)  
+> > > [`IKeymanKeyboards`](../IKeymanKeyboards)
 > > >
-> > > > [`IKeymanKeyboardsInstalled`](../IKeymanKeyboardsInstalled)  
+> > > > [`IKeymanKeyboardsInstalled`](../IKeymanKeyboardsInstalled)
 > > > >
-> > > > > **`IKeymanKeyboardsInstalled2`**  
+> > > > > **`IKeymanKeyboardsInstalled2`**
+> > > > >
+> > > > > [`IKeymanKeyboardsInstalled3`](../IKeymanKeyboardsInstalled3)
 
 ## Methods
 

developer/engine/windows/19.0/api/IKeymanKeyboardsInstalled3/Install3.md

@@ -0,0 +1,48 @@
+---
+title: IKeymanKeyboardsInstalled3::Install3 Method
+---
+
+## Introduction
+
+The `IKeymanKeyboardsInstalled3::Install3` method installs a keyboard
+file (.kmx) into Keyman Engine for Windows. This includes copying the
+file into the Keyman Engine keyboard store, adding registry settings,
+and optionally installing the Windows input method. During installation,
+the keyboard layout is compiled against the specified base keyboard. As
+installing Windows input methods is an asynchronous process, this method
+may not be complete when it returns.
+
+If the input method is installed, this method adds the keyboard to the
+default language as specified in the
+[`IKeymanKeyboard::DefaultBCP47Languages`](../IKeymanKeyboard/DefaultBCP47Languages)
+property.
+
+This method requires elevated privileges.
+
+## Specification
+
+``` clike
+void Install3(string Filename, bool Force, int BaseKeyboardID)
+```
+
+## Parameters
+
+`Filename`
+:   The fully-qualified path to the .kmx file to be installed. This file
+    will be copied to the Keyman keyboard store.
+
+`Force`
+:   If `True`, overwrites an existing keyboard entry.
+
+`BaseKeyboardID`
+:   The ID of the base keyboard to compile the keyboard layout against.
+
+## See also
+
+[`IKeymanKeyboardsInstalled2::Install2`](../IKeymanKeyboardsInstalled2/Install2)
+:   Installs a keyboard file, optionally with input method for default
+    language
+
+[`IKeymanKeyboardFile3::Install3`](../IKeymanKeyboardFile3/Install3)
+:   Installs a keyboard file and compiles its layout against a specified
+    base keyboard

developer/engine/windows/19.0/api/IKeymanKeyboardsInstalled3/index.md

@@ -0,0 +1,35 @@
+---
+title: IKeymanKeyboardsInstalled3 Interface
+---
+
+## Introduction
+
+The `IKeymanKeyboardsInstalled3` interface extends the installed keyboard
+collection with a method to install a keyboard and compile its layout
+against a specified base keyboard.
+
+## Interface Hierarchy
+
+`IDispatch`
+
+> [`IKeymanObject`](../IKeymanObject)
+>
+> > [`IKeymanCollection`](../IKeymanCollection)
+> >
+> > > [`IKeymanKeyboards`](../IKeymanKeyboards)
+> > >
+> > > > [`IKeymanKeyboardsInstalled`](../IKeymanKeyboardsInstalled)
+> > > >
+> > > > > [`IKeymanKeyboardsInstalled2`](../IKeymanKeyboardsInstalled2)
+> > > > >
+> > > > > **`IKeymanKeyboardsInstalled3`**
+
+## Methods
+
+[`Install3()`](Install3)
+:   Installs a keyboard file and compiles its layout against the
+    specified base keyboard.
+
+## History
+
+Added in Keyman Engine for Windows 19.0.

developer/engine/windows/19.0/api/IKeymanPackageFile/Install.md

@@ -35,6 +35,14 @@ void Install(bool Force)
 :   Installs a package file, optionally with input method for default
     language
 
+[`IKeymanPackagesInstalled3::Install3`](../IKeymanPackagesInstalled3/Install3)
+:   Installs a package from a path and compiles its keyboard layouts
+    against a specified base keyboard
+
 [`IKeymanPackageFile2::Install2`](../IKeymanPackageFile2/Install2)
 :   Installs a package file, optionally with input method for default
     language
+
+[`IKeymanPackageFile3::Install3`](../IKeymanPackageFile3/Install3)
+Installs a package file and compiles its keyboard layouts
+    against a specified base keyboard

developer/engine/windows/19.0/api/IKeymanPackageFile/index.md

@@ -11,15 +11,17 @@ simplify distribution of keyboard layouts.
 
 ## Interface Hierarchy
 
-`IDispatch`  
+`IDispatch`
 
-> [`IKeymanObject`](../IKeymanObject)  
+> [`IKeymanObject`](../IKeymanObject)
 >
-> > [`IKeymanPackage`](../IKeymanPackage)  
+> > [`IKeymanPackage`](../IKeymanPackage)
 > >
-> > > **`IKeymanPackageFile`**  
+> > > **`IKeymanPackageFile`**
 > > >
-> > > > [`IKeymanPackageFile2`](../IKeymanPackageFile2)  
+> > > > [`IKeymanPackageFile2`](../IKeymanPackageFile2)
+> > > >
+> > > > [`IKeymanPackageFile3`](../IKeymanPackageFile3)
 
 ## Methods