Skip to content

Commit 362ec98

Browse files
Update documentation instructing the users to use community snippets (#2733)
## Checklist - [/] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [x] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [/] I have not broken the cheatsheet --------- Co-authored-by: Phil Cohen <[email protected]>
1 parent ca1a80e commit 362ec98

File tree

1 file changed

+14
-10
lines changed
  • packages/cursorless-org-docs/src/docs/user/experimental

1 file changed

+14
-10
lines changed

packages/cursorless-org-docs/src/docs/user/experimental/snippets.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@
33
![Wrapper snippet demo](images/tryWrapFine.gif)
44
![Link wrap](images/linkWrap.gif)
55

6+
## Using community snippets (RECOMMENDED)
7+
8+
The community Talon files now support their own snippet format, which is now preferred.
9+
10+
If you'd like to use these snippets for wrapping and inserting with Cursorless instead of the legacy Cursorless snippets, add the following line to your `settings.talon` file:
11+
12+
```talon
13+
tag(): user.cursorless_use_community_snippets
14+
```
15+
16+
Note that this line will also disable any Cursorless snippets defined in your Cursorless customization CSVs. You will need to migrate your Cursorless snippets to the new community snippet format [described in community](https://github.com/talonhub/community/blob/main/core/snippets/README.md). If you'd be interested in a tool to help with this migration, please leave a comment on [cursorless-dev/cursorless#2149](https://github.com/cursorless-dev/cursorless/issues/2149), ideally with a link to your custom snippets for us to look at.
17+
18+
## Cursorless experimental snippets (DEPRECATED)
19+
620
Cursorless has its own experimental snippet engine that allows you to both insert snippets and wrap targets with snippets. Cursorless ships with a few built-in snippets, but users can also use their own snippets.
721

822
## Using snippets
@@ -88,16 +102,6 @@ Note that each snippet can use `insertionScopeTypes` to indicate that it will au
88102
| `"snippet funk"` | Function; phrase becomes name | Function ||
89103
| `"snippet link"` | Markdown link; phrase becomes link text | ||
90104

91-
## Using community snippets
92-
93-
The community Talon files now support their own snippet format. If you'd like to use these snippets for wrapping / cursorless insertion instead of snippets defined in Cursorless, add following line to your `settings.talon` file:
94-
95-
```talon
96-
tag(): user.cursorless_use_community_snippets
97-
```
98-
99-
Note that this line will also disable any Cursorless snippets defined in your Cursorless customization CSVs. You will need to migrate your Cursorless snippets to the new community snippet format [described in community](https://github.com/talonhub/community/blob/main/core/snippets/README.md). If you'd be interested in a tool to help with this migration, please leave a comment on [cursorless-dev/cursorless#2149](https://github.com/cursorless-dev/cursorless/issues/2149), ideally with a link to your custom snippets for us to look at.
100-
101105
## Customizing spoken forms
102106

103107
As usual, the spoken forms for these snippets can be [customized by csv](../customization.md). The csvs are in the files in `cursorless-settings/experimental` with `snippet` in their name.

0 commit comments

Comments
 (0)