alpha
/
Kaleidoscope
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

README.md: Minor documentation updates

Browse Source 
Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 7 years ago
parent 588e332d12
commit 6cf2b82dd3
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File

12
README.md
Unescape View File

@ -19,7 +19,7 @@ codepoints.
## Using the extension ## Using the extension
Using the extension is as simple as including the header, registering it with Using the extension is as simple as including the header, registering it with
`Kaleidoscope.use()`, and then using any of the methods provided by the `Unicode` `USE_PLUGINS()`, and then using any of the methods provided by the `Unicode`
singleton object. singleton object.
```c++ ```c++
@ -40,19 +40,19 @@ The extension provides a number of methods on the `Unicode` object, but also has
symbols that can be [overridden](#overrideable-methods), to add custom symbols that can be [overridden](#overrideable-methods), to add custom
functionality. functionality.
### `.type(codePoint)` ### `.type(code_point)`
> Starts the Unicode input method using the [`.start()`](#start) method, inputs > Starts the Unicode input method using the [`.start()`](#start) method, inputs
> the `codePoint` using [`.typeCode()`](#typeCode), and finishes up with > the `code_point` using [`.typeCode()`](#typeCode), and finishes up with
> the [`.end()`](#end) method. For each hexadecimal digit sent to the host, > the [`.end()`](#end) method. For each hexadecimal digit sent to the host,
> the [`.input()`](#input) method will also be called. > the [`.input()`](#input) method will also be called.
> >
> This method is most useful when one knows the code point of the Unicode symbol > This method is most useful when one knows the code point of the Unicode symbol
> to enter ahead of time, when the code point does not depend on anything else. > to enter ahead of time, when the code point does not depend on anything else.
### `.typeCode(codePoint)` ### `.typeCode(code_point)`
> Inputs the hex codes for `codePoint`, and the hex codes only. Use when the > Inputs the hex codes for `code_point`, and the hex codes only. Use when the
> input method is to be started and ended separately. > input method is to be started and ended separately.
> >
> For example, a macro that starts Unicode input, and switches to a layer full > For example, a macro that starts Unicode input, and switches to a layer full
@ -75,7 +75,7 @@ functionality.
## Overrideable methods ## Overrideable methods
### `hexToKey(hexDigit)` ### `hexToKey(hex_digit)`
> A function that returns a `Key` struct, given a 8-bit hex digit. For most > A function that returns a `Key` struct, given a 8-bit hex digit. For most
> uses, the built-in version of this function is sufficient, but if the keymap > uses, the built-in version of this function is sufficient, but if the keymap

Write Preview
Loading…
Cancel
Save