summaryrefslogtreecommitdiff
path: root/input/layout/README.md
diff options
context:
space:
mode:
authorBarry Golden <[email protected]>2019-09-05 20:18:16 -0700
committerGitHub <[email protected]>2019-09-05 20:18:16 -0700
commit22af24719daf72029a70119cc6653d2a3b940549 (patch)
tree6677b85dbdae81db047b97a51533ea356abb13e3 /input/layout/README.md
parent516d94ce47bd535dc813d654297ace02c61d46f6 (diff)
* Update README.md * Update README.md
Diffstat (limited to 'input/layout/README.md')
-rw-r--r--input/layout/README.md53
1 files changed, 22 insertions, 31 deletions
diff --git a/input/layout/README.md b/input/layout/README.md
index 32fb84c6..eb654d31 100644
--- a/input/layout/README.md
+++ b/input/layout/README.md
@@ -8,66 +8,59 @@ products:
- windows-wdk
---
-
-<!---
- name: Keyboard Layout Samples
- platform: Application
- language: cpp
- category: HID
- description: Demonstrates how to generate layouts for various keyboards and locales.
- samplefwlink: https://aka.ms/rapjms
---->
-
# Keyboard Layout Samples
The keyboard layout samples demonstrate how to generate layouts for various keyboards and locales.
-Build the sample
-----------------
+## Build the sample
Starting in the WDK, you can build the sample in two ways: using the Visual Studio Integrated Development Environment (IDE) or from the command line using the Visual Studio Command Prompt window and the Microsoft Build Engine (MSBuild.exe).
### Building the sample using Visual Studio
-1. Open Visual Studio. From the **File** menu, select **Open Project/Solution**. Within your WDK installation, navigate to src\\input\\layout and open the kbd.sln project file.
-2. Right-click the solution in the **Solution Explorer** and select **Configuration Manager**.
-3. From the **Configuration Manager**, select the **Active Solution Configuration** (for example, Windows 8.1 Debug or Windows 8.1 Release) and the **Active Solution Platform** (for example, Win32) that correspond to the type of build you are interested in.
-4. From the **Build** menu, click **Build Solution** (Ctrl+Shift+B).
+1. Open Visual Studio. From the **File** menu, select **Open Project/Solution**. Within your WDK installation, navigate to src\\input\\layout and open the kbd.sln project file.
+
+1. Right-click the solution in the **Solution Explorer** and select **Configuration Manager**.
+
+1. From the **Configuration Manager**, select the **Active Solution Configuration** (for example, Windows 8.1 Debug or Windows 8.1 Release) and the **Active Solution Platform** (for example, Win32) that correspond to the type of build you are interested in.
+
+1. From the **Build** menu, click **Build Solution** (Ctrl+Shift+B).
Previous versions of the WDK used the Windows Build utility (Build.exe) and provided separate build environment windows for each of the supported build configurations. Starting in the WDK, you can use the Visual Studio Command Prompt window for all build configurations.
### Building the sample using the command line (MSBuild)
-1. Open a Visual Studio Command Prompt window. Click **Start** and search for **Developer Command Prompt**. If your project is under %PROGRAMFILES%, you need to open the command prompt window using elevated permissions (**Run as administrator**). From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
-2. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called kbdus.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\kbdus.vcxproj**.
-3. If the build succeeds, you will find the driver (kbdus.dll) in the binary output directory corresponding to the target platform, for example src\\input\\layout\\kbdus\\Windows 8.1 Debug.
+1. Open a Visual Studio Command Prompt window. Click **Start** and search for **Developer Command Prompt**. If your project is under %PROGRAMFILES%, you need to open the command prompt window using elevated permissions (**Run as administrator**). From this window you can use MsBuild.exe to build any Visual Studio project by specifying the project (.VcxProj) or solutions (.Sln) file.
+
+1. Navigate to the project directory and enter the **MSbuild** command for your target. For example, to perform a clean build of a Visual Studio driver project called kbdus.vcxproj, navigate to the project directory and enter the following MSBuild command: **msbuild /t:clean /t:build .\\kbdus.vcxproj**.
+
+1. If the build succeeds, you will find the driver (kbdus.dll) in the binary output directory corresponding to the target platform, for example src\\input\\layout\\kbdus\\Windows 8.1 Debug.
-Design and Operation
---------------------
+## Design and Operation
-### Keyboard Layout Samples
+### Keyboard Layout Samples details
The layout DLL is loaded by the window manager when needed. One of the examples is the logon. The default set of the input locales is set in the HKCU registry, according to user's preference, which can be customized by the Regional and Language Options application in Control Panel. The window manager reads the HKCU registry and loads the keyboard layouts accordingly.
The samples under input/layout include the following keyboard layouts:
-- kbdus
+- kbdus
US-English keyboard layout
-- kbdfr
+- kbdfr
French keyboard layout
-- kbdgr
+- kbdgr
German keyboard layout
-- kbd101
+- kbd101
Japanese 101 keyboard layout
-- kbd106
+- kbd106
Japanese 106 keyboard layout
@@ -87,13 +80,11 @@ The layout DLLs export one or more entry points, which are called by the window
For the East Asian keyboard layouts, the keyboard layout DLL has to provide language-specific entry points. Those additional entries expose the language-specific information, such as the kana conversion table, or the special conversion rule, including the VK\_KANJI generation.
-Installation
-------------
+## Installation
To install a customized version of a layout DLL, it is recommended to substitute the existing DLL installed by the operating system with the customized DLL. The layout DLLs should be installed in the %windir%\\system32 directory (exceptions may apply on 64-bit platforms). You may need to disable the System File Protection (SFP) before replacing the layout DLLs. After the layout DLLs are installed, you may need to reboot the system to ensure the new layouts are used..
-Loading the Sample
-------------------
+## Loading the Sample
In order to load the layout DLLs, you may need to turn to the Regional and Language Options application in Control Panel and add input locales that use the keyboard layouts you installed.