Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/konn/vscode-generic-input-method
Generic Input Method for VSCode, mainly focusing on Unicode Symbol input for Theorem Provers, and YaTeX-like image completion for LaTeX
https://github.com/konn/vscode-generic-input-method
input-method latex math symbols unicode vscode vscode-extension
Last synced: 3 months ago
JSON representation
Generic Input Method for VSCode, mainly focusing on Unicode Symbol input for Theorem Provers, and YaTeX-like image completion for LaTeX
- Host: GitHub
- URL: https://github.com/konn/vscode-generic-input-method
- Owner: konn
- License: bsd-3-clause
- Created: 2018-11-06T15:14:37.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-19T13:54:55.000Z (over 1 year ago)
- Last Synced: 2024-05-01T22:44:08.826Z (9 months ago)
- Topics: input-method, latex, math, symbols, unicode, vscode, vscode-extension
- Language: TypeScript
- Homepage:
- Size: 1.13 MB
- Stars: 11
- Watchers: 4
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Generic Input Method for VSCode
[](https://marketplace.visualstudio.com/items?itemName=mr-konn.generic-input-method)
[](https://marketplace.visualstudio.com/items?itemName=mr-konn.generic-input-method)
This extension provides a generic input method within VSCode.
It can be used as a [YaTeX][yatex]-like image completion for LaTeX or Unicode Math input for theorem provers such as Agda or Lean.
[yatex]: http://yatex.org
## Features
- ~~[YaTeX][yatex]-like image-completion for LaTeX~~
- Since version 0.0.8, LaTeX-related functionalities are moved to [CaTeX] extension.
- Unicode Math input for Markdown
- Ability to configure your own custom input methods!
- Automatic configuration update
[CaTeX]: https://marketplace.visualstudio.com/items?itemName=mr-konn.catex
## Demos
### Unicode Math Input
## Configuration
You can define and/or modify input methods in `generic-input-method.input-methods`.
This must be an array of input method.
Each input method is defined as follows:
```javascript
{
// Unique name for the input method
"name": "Example Math Input",
// Languages where the IM is activated.
"languages": ["markdown", "latex"],
// Characters to trigger conversion
"triggers": ["\\"],
// How to render each items?
// Available: "string" or "snippet"; other extension can add more.
// `string` just prints the content of "body" property.
// See `defaults/images.json` for examples.
// You can also define custom expander for render.
"renderMode": "string",
// Suffix for a text-editor command;
// you can invoke it as `extension.complete.custom.example-math`.
"commandName": "custom.example-math",
// An array of items or a reference to the default dictionary.
"dictionary": [
// Default Math dictionary shipped with this extension
"defaults/math.json",
// Push `\||-` to input `\Vvdash`.
// Shows `⊪` as a preview.
{ "label": "|||-", "body": "\\Vvdash", "description": "⊪" }
]
}
```
Currently, you can only refer to the default dictionaries shipped with the `generic-input-method` extension.
## External API
This extension provides an API to un/register custom input methods.
### Registering a new Input Method dynamically
```typescript
import { extensions, ExtensionContext } from "vscode";
function async activate(context: ExtensionContext) {
let ims = extensions.getExtension("mr-konn.generic-input-method");
if (gim) {
const api: any = await gim.activate();
const im: any = {
name: "My Great IM Dynamically Registered",
languages: ["redtt"],
triggers: ["\\"],
dictionary: ["defaults/math.json", { label: "to", body: "→" }]
};
api.registerInputMethod(im);
}
}
```
See [CaTeX][catex-repo] and [`redtt-diagnostics`][redtt-diag] for an example usage.
[catex-repo]: https://github.com/konn/catex
[redtt-diag]: https://github.com/konn/vscode-redtt-diagnostics
### Invoking Input Method Forcedly
You can use `api.invokeInputMethod(editor?, nameOrIM?)` to invoke an input method, regardless of the language of editor.
## TODOs
- Cool screenshot GIFs
- Underlining converted input
- Contextual completion based on scopes
- Split LaTeX-related input methods as an external extension?