diff --git a/example/README.md b/example/README.md index 7a99eb6..8a6dc17 100644 --- a/example/README.md +++ b/example/README.md @@ -12,8 +12,7 @@ extension with the world. The first thing to do is determine if you can take the simple route or if your extension will require more effort. If your layout is already in the version of -[xkeyboard-config](https://github.com/freedesktop/xkeyboard-config) that is -available in Chrome OS you are nearly ready. +[xkeyboard-config] that is available in Chrome OS you are nearly ready. On your Chrome OS device, open a new browser tab and go to `chrome://version`. Find both the "Google Chrome" and the "Platform" version numbers. My device, as @@ -27,11 +26,8 @@ Click the 'x11-misc' and then 'xkeyboard-config' links. You will now need to compare the version number listed for the xkeyboard-config ebuild file. The revision I am using for this example is 2.27. -Going back to the -[xkeyboard-config](https://github.com/freedesktop/xkeyboard-config) repository -and update the source viewer to the tag based on that release version. In GitHub -you click the branch selection menu, click "Tags", and then select the -appropriate version. +Going back to the [xkeyboard-config] repository and update the source viewer to the tag based on that release version. +In GitHub you click the branch selection menu, click "Tags", and then select the appropriate version. ![branch select menu](branch_menu.png) @@ -58,3 +54,5 @@ take a while. The other option is to create your own extension using some sort of key combination mapping in JavaScript. Head over to the [remap](remap/README.md) section for details on how to proceed. + +[xkeyboard-config]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config diff --git a/example/remap/README.md b/example/remap/README.md index b6f2450..680aeef 100644 --- a/example/remap/README.md +++ b/example/remap/README.md @@ -39,9 +39,8 @@ unnecessary to add the country if the country is the default for that language. Always prefer to use the shortest viable value. Next we look at the `layouts` field which is used to reference a particular -keyboard layout in the -[xkeyboard-config](https://github.com/freedesktop/xkeyboard-config/blob/master/symbols/se) -package. Looking at the file `se` (for Sweden) we can find all of the pre-made +keyboard layout in the [xkeyboard-config] package. +Looking at the file `se` (for Sweden) we can find all of the pre-made layouts by looking for the lines that begin with "xkb\_symbols". The name in quotes after this token is the name of the layout variant. We'll take the Dvorak A5 layout as an example. The field should be `se(dvorak_a5)`. Note that @@ -72,3 +71,4 @@ You should fork the existing repository and create a new feature branch within that fork. Create a new directory at the top level of the repository with a descriptive but terse name. +[xkeyboard-config]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config \ No newline at end of file diff --git a/example/xkb/README.md b/example/xkb/README.md index d3aa921..44406c4 100644 --- a/example/xkb/README.md +++ b/example/xkb/README.md @@ -25,9 +25,8 @@ unnecessary to add the country if the country is the default for that language. Always prefer to use the shortest viable value. Next we look at the `layouts` field which is used to reference a particular -keyboard layout in the -[xkeyboard-config](https://github.com/freedesktop/xkeyboard-config/blob/master/symbols/se) -package. Looking at the file `se` (for Sweden) we can find all of the pre-made +keyboard layout in the [xkeyboard-config] package. +Looking at the file `se` (for Sweden) we can find all of the pre-made layouts by looking for the lines that begin with "xkb\_symbols". The name in quotes after this token is the name of the layout variant. We'll take the Dvorak A5 layout as an example. The field should be `se(dvorak_a5)`. Note that @@ -49,3 +48,4 @@ You should fork the existing repository and create a new feature branch within that fork. Create a new directory at the top level of the repository with a descriptive but terse name. +[xkeyboard-config]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config