Skip to content

📚 Custom dictionary formats

📚 Custom dictionaries suppor two file formats.

CSV like

Definitions

Row delimiter

Line breaks

Column delimiter

Value set in ⚙️ Column delimiter

Column definitions

Col1 Col2 Col3 and later
Inserted text/Displayed text Description Aliases

Comment syntax

If a line starts with %%, It regards the line as a comment line.

Escape syntax

syntax actual text
\n Line break
\t Tab

Other

Example

value1

%% with description %%
value2,description

%% with aliase %%
value3,,v3,val3

%% with \n %%
- one\n- two\n- three,,onetwo

%% Displayed text is different from Inserted text %%
Displayed >>> Inserted

It will load it as...

Inserted text Displayed text Description Aliases[0] Aliases[1]
value1 value1
value2 value2 description
value3 value3 v3 val3
- one
- two
- three		 - one
- two
- three		 onetwo
Inserted Displayed

JSON

Definitions

key type required description
caretSymbol string If set, take precedence over ⚙️ Caret location symbol after complement
ignoreSpaceAfterCompletion boolean If set, ignore ⚙️ Insert space after completion
words #Word[] yes

Word

key type required description
value string yes Inserted text
description string Description
aliases string[] Aliases
displayed string If set, use as Displayed text

Example

{
  "caretSymbol": "~CUR~",
  "ignoreSpaceAfterCompletion": true,
  "words": [
    { "value": "value1" },
    { "value": "value2", "description": "hogehoge" },
    { "value": "value3", "aliases": ["w3", "word3"] },
    { "value": "begin\n[[CARET]]\nend", "displayed": "code-json" }
  ]
}

It will load it as...

Inserted text Displayed text Description Aliases[0] Aliases[1]
value1 value1
value2 value2 hogehoge
value3 value3 w3 word3
begin
~CUR~
end		 code-json

~CUR~ is the caret location after completion.

Since

v6.1.0