From 29046310f7910f48b44164a9fd7e65f41356b6c7 Mon Sep 17 00:00:00 2001 From: Pokey Rule Date: Fri, 3 Sep 2021 14:30:32 +0100 Subject: [PATCH 1/2] Add new shape documentation --- docs/README.md | 33 ++++++++++++++++++++++++--------- 1 file changed, 24 insertions(+), 9 deletions(-) diff --git a/docs/README.md b/docs/README.md index 4973681c..5ffde267 100644 --- a/docs/README.md +++ b/docs/README.md @@ -63,31 +63,46 @@ There are several types of marks: ##### Decorated symbol -This is the first type of mark you'll notice when you start using cursorless. You'll see that for every token on the screen, one of its characters will have a hat on top of it. We can refer to the given token by saying the name of the character that has a hat, along with the color if the hat is not gray: +This is the first type of mark you'll notice when you start using cursorless. You'll see that for every token on the screen, one of its characters will have a hat on top of it. We can refer to the given token by saying the name of the character that has a hat, along with the color if the hat is not gray, and the shape of the hat if the hat is not the default dot: - `"air"` (if the color is gray) - `"blue bat"` - `"blue dash"` - `"blue five"` +- `"fox bat"` +- `"blue fox bat"` The general form of this type of mark is: -`"[] ( | | )"` +`"[] [] ( | | )"` Combining this with an action, we might say `"take blue air"` to select the token containing letter `'a'` with a blue hat over it. ###### Colors -The following colors are supported. As mentioned above, note that gray is optional: `"gray air"` and `"air"` are equivalent +The following colors are supported: | Command | Visible color | | ---------- | ------------- | -| `"gray"` | default | -| `"blue"` | blue | -| `"green"` | green | -| `"rose"` | red | -| `"squash"` | yellow | -| `"plum"` | mauve | +| `"blue"` | Blue | +| `"green"` | Green | +| `"rose"` | Red | +| `"squash"` | Yellow | +| `"plum"` | Purple | + +###### Shapes + +The following shapes are supported: + +| Command | Visible color | Enabled by default? | +| --------- | ---------------- | ------------------- | +| `"splat"` | Four-point star | ✅ | +| `"fox"` | Chevron | ✅ | +| `"wing"` | Three-point star | ❌ | +| `"hole"` | Hole | ❌ | +| `"frame"` | Frame | ❌ | +| `"curve"` | Curve | ❌ | +| `"stare"` | Eye | ❌ | ##### `"this"` From 5194da3c66ab12c0f7b80b005c283c232314d460 Mon Sep 17 00:00:00 2001 From: Pokey Rule Date: Fri, 3 Sep 2021 14:38:04 +0100 Subject: [PATCH 2/2] Add documentation for enabling and disabling shapes --- docs/README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/README.md b/docs/README.md index 5ffde267..9d7ce9f5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -104,6 +104,11 @@ The following shapes are supported: | `"curve"` | Curve | ❌ | | `"stare"` | Eye | ❌ | +To enable or disable shapes requires the following two steps: + +1. Check the box corresponding to the given shape in the `cursorless.hatEnablement.shapes` field of the cursorless vscode settings +2. Enable the corresponding spoken form in the [spoken form customization csvs](customization.md) for cursorless talon + ##### `"this"` The word `"this"` can be used as a mark to refer to the current cursor(s) or selection(s). Note that when combined with a modifier, the `"this"` mark can be omitted, and it will be implied.