from <= 4.4.0 to 5.0.0

Where v4 documents go? To keep simplicity, the document pages describes only for latest version. Therefore you cannot read web page style documents of conventional win-vind, but you can read old documents in markdown preview style in GitHub.
For v4.3.3, please refer to this documents.

1. Syntax of .vindrc

Discussed in #96

The difference between map and noremap

The conventional map and noremap have different purposes. The map is designed to propagate defined macros to other applications except for win-vind, whereas the noremap effects in win-vind score only.

However, the NEW map and the NEW noremap have similar features of Vim and are separated on whether allow remapping like Vim.

Specifically, the map allows remapping with user-defined mapping like the following.

nmap f h  " f --> h
nmap t f  " t --> h

The noremap performs only the default map.

nnoremap f h  " f --> h
nnoremap t f  " t --> f

Arguments of map/noremap

The command kind is the same, but the way to interpret the arguments.

Note: The syntax is not included [ and ].

The [trigger-cmd] is assumed to key typing only and the [target-cmd] has three types of intepretation.

These [target-cmd] can be incorporated into a single map as follows.

map g <easy_click_left>b{This text is inserted}<switch_window>hh<cr>

The mapping represents a macro that is triggered by g, activates easy_click, jumps to the position of the hint in b, enters the string “This text is inserted”, and then selects the two-left window with switch_window.

This version will preform an optimization process that merges several maps into one map, unless it contains a command to change the mode. For example, the following mappings will be merged into one.

• Raw map

  nmap b h
  nmap o b
  nmap p o
  

• Optimized map (THIS VERSION)

  nmap p h
  

Below are some examples of use.

1. Define mode change mapping

   imap <win-[> <to_edi_normal>
   imap <win-]> <to_gui_normal>
   

2. Text input macros

   nmap mail {win-vind@example.com}
   

3. Web page launcher

   nmap <ctrl-1> :execute https://example.com<cr>
   

4. Application launcher

   nmap <ctrl-2> :! notepad<cr>
   

5. Copy the current line to the bottom line as in Vim.

   enmap t yyGp
   

Mode Prefix

Mentioned in #91

We received many requests to register maps across several modes, so we added batch-mapping with the same grouping as in Vim.

You can mode prefix to specify modes.

However, external macros in cmap and cnoremap are not input to other applications and behave the same as internal macros.

2. Self-Mapping

Discussed in #123

You can disable the absorption of some keys and allow them to be input, as in map <alt> {<alt>}. However, this is only valid for a single key. If the target command consists of multiple characters like map g abcgd and contains a trigger command, the following warning statement will be printed to log and no mapping will be done.

[Warning] Some part of the command generated from mapping `g * :e https://google.com<return>` was ignored to avoid an infinite loop because it was mapped to itself by mapping `g * :e https://google.com<return>`. If you wish to enter the generated command as is, enclose it in `{}`.

3. Changed default mapping

Discussed in #118

Since the mode transition combined with ESC in win-vind was not well received, we adopted the same command as in Vim.

4. Renamed function name

The conventional <syscmd_*> function names are renamed to simple ones.

5. Eliminated options and replacements

The following is the correspondence between the options that were removed and their replacements. The - is completely obsolete.

Details of the new options are as follows.

6. New word-motion

Add the following word-motion which behave almost exactly like Vim. (#57, #75)

These functions do not work in visual mode except for w and b, because they copy the text once and retrieve the text via the clipboard. iskeyword option is fixed to the default value of Vim in Windows and cannot change it currently.
There is an option charbreak to set the criteria for considering a Unicode character as a single character.

7. New option in terminal

Discussed in #101, #97
Please see this document.