Skip to content

Latest commit

 

History

History
181 lines (116 loc) · 9.13 KB

README.md

File metadata and controls

181 lines (116 loc) · 9.13 KB

BPJ's Vim keymaps

My Vim keymaps, most of them quite ugly hacks...

BTW you might want to :set delcombine and :set maxcombine=6.

bxs.vim

My variation of CXS, mainly additions to accommodate more Unicode phonetic characters, IPA and otherwise, but note that

l\      ȴ  U+0234 LATIN SMALL LETTER L WITH CURL
4\      ɺ  U+027A LATIN SMALL LETTER TURNED R WITH LONG LEG

though I might revert that change soonish since I went ahead and added t; d; n; l; S; Z; for alveopalatals ȶ ȡ ȵ ȴ ɕ ʑ, though my former t\ d\ n\ l\ are still in place for now and s\ z\ of course won't go away.

Moreover " + any ASCII non-a-z character gives you that ASCII character. (Yes this means you need to type "" to get an ASCII double-quote, but when did you need it in a phone*ic transcription last?)

bpjgreek.vim

My take on entering Unicode (Ancient polytonic) Greek. Unlike Beta Code 1:1 character correspondence is neither a requirement nor a goal. If you want to type χώρη you type kh/.or.e -- or ch/.or.i or anything in between if that suits your pronunciation or orthographic habits --, and if you want to write ξηρά you type x.er/a or ks.er/a or...

There are more detailed explanations in the file.

bpjlatin.vim

A hacky concoction on similar principles to enter Unicode Latin-script characters and combining diacritics. I'm planning to replace it with something better-thought-out in a not too far away future (but you know how those things go! :-)

The ASCII double quote " + any ASCII character can be used to get that ASCII character literally (including "" for a literal "). This is useful since the keymap defines digraphs like dh for ð and d- for đ To get a literal dh while the keymap is active you can type "d"h or d"h and to get a literal d- you can type "d"- or d"-. Sometimes you must use these ASCII digraphs in a specific order: the keymap remaps / to the combining acute accent and o/ to ø. To get ó you must type "o/ and to get o/ you must type "o"/.

The repository contains a file template.vim which you can use to create your own keymaps where these " + ASCII mappings are already defined.

The keymap doesn't define mappings for precomposed characters where there is an alternative with combining character(s). If that is a concern you can use a filter script like this (originally from Tom Christiansens Unicode scripts) to get precomposed characters where available:

#!/usr/bin/env perl
 
use strict;
use 5.10.1;
use autodie;
use warnings qw[ FATAL all ];
use open     qw[ :std IO :utf8 ];
 
END { close STDOUT }
use Unicode::Normalize;
 
print NFC($_) while <>;

smartspace.vim

On the vim_use mailing list someone asked:

When we use Vim, what's the best way to add two spaces between sentences automatically rather than manually press the space bar twice? That's prevalent in the source code comment like the following:

/*

  • comment comment.more comment. */

Additionally by default, when we join two sentences with one on top of the other, there would be two spaces between them after joining. What do we need to do to achieve the similar effect with Vim automatically when we are typing?

I came up with a way to do this which actually works: a keymap and a couple of autocommands. (See :h mbyte-keymap and :h 'kmp').

Don't use these when writing code! :-)

loadkeymap
" leave this line blank!

" Punctuation plus space

.<Space>            .<char-0xa0><Space>
!<Space>            !<char-0xa0><Space>
?<Space>            ?<char-0xa0><Space>
..<Space>           .<char-0xa0>    " dot plus non-breaking space
..<Space><Space>    .<Space>        " dot plus ordinary space
!!<Space>           !<Space>
??<Space>           ?<Space>
" More with quotes and parentheses involved...

" Abbreviations

Mr.<Space>          Mr.<char-0xa0>
" more...

In prose this means that

  • When you type one of . ! ? followed by a space character you will get a punctuation mark + non-breaking space + an ordinary space, appropriate for the end of a sentence

    The point of inserting a non-breaking space plus an ordinary space at the end of a sentence is so that the double space will be preserved when reformatting, but lines can break at the ordinary space anyway.

  • When typing two periods (or !! ??) + one space you get one period + a nonbreaking space. This is for abbreviations you use less often.

    The point of using a non-breaking space after abbreviations is so that you won't get linebreaks after abbreviations, which is considered bad style.

  • When typing two periods (or !! ??) + two spaces you get one period + an ordinary space. This is for those cases where you actually want that.

  • In the actual keymap the . ! ? can be preceded or followed by any sensible combination of " ' ) too, with the same space and .. !! ?? semantics.

  • Finally some of the most common English abbreviations, when typed with a following space, will have the space replaced with a non-breaking space.

    You will want to add more and/or those for your language. Don't hesitate to send a pull request for more English abbreviations!

You almost certainly want to define these autocommands (where <nbsp> and <space> mean that you should type <C-K>NS (digraph for non-breaking space) and an ordinary space respectively at those points):

" Replace dot + nbsp + space with dot + space + space before writing Markdown files.
:au BufWritePre *.md %s/\.<npsp><space>/.<space><space>/g

" Replace dot + nbsp + newline with dot + newline before writing Markdown files.
:au BufWritePre *.md %s/\.<npsp>$/./g

" The reverse actions after writing a Markdown file.
:au BufWritePost *.md %s/\.<space><space>/.<nbsp><space>/g
:au BufWritePost *.md %s/\.$/.<nbsp>/g

I use *.md in the examples because that fits my use case. You may want to substitute or add *.txt or something else.

Note that the non-breaking spaces after abbreviations are preserved when writing the file. That is intentional!

If you think autocommands are too much magic behind your back you can define them as ordinary commands instead and apply them manually:

:com! NoSmartspace %s/\.<nbsp><space>/.<space><space>/g | %s/\.<nbsp>$/./g

:com! Smartspace %s/\.<space><space>/.<nbsp><space>/g | %s/\.$/.<nbsp>/g

sohlob.vim

Accented characters and punctuation needed for the Sohlob project.

texquotes.vim

Originally meant to enable the use of TeX-like sequences for dashes and quotes. Has diverged a bit from that!

autoload/switchkeymap.vim

My second, much simplified and improved, attempt at helper functions for switching keymaps in Vim. It defines two functions which you can use in imap and nmap [mappings][] to switch back and forth between different keymaps, and some functions which help you define such maps with less typing and copy/paste.

Simple usage

(The gory details are in the file!)

Suppose that you want to define key mappings to switch between keymaps (either those in this repository or any other keymap) called bpjlatin.vim, myrussian.vim and accents.vim (which must live in ~/.vim/keymap or a keymap/ directory in your 'runtimepath'), as well as to switch to the previously used keymap or no keymap at all. Put this in your .vimrc:

let keymapdict = {
            \ '<F9>': "\1",
            \ '0': "\0",
            \ 'a': 'accents',
            \ 'l': 'bpjlatin',
            \ 'r': 'myrussian',
            \ }

call switchkeymap#map_dict(keymapdict, '<F9>')

This will define the following mappings for both normal and insert mode:

Mapping Effect
<F9><F9> Toggles between the current keymap and the previously used one (both of which may be none).
<F9>0 Deactivates the keymap. (Actually sets the 'keymap' option to an empty string.)
<F9>a Saves the previous keymap to b:prev_keymap and activates the accents.vim keymap.
<F9>l Saves the previous keymap to b:prev_keymap and activates the bpjlatin.vim keymap.
<F9>r Saves the previous keymap to b:prev_keymap and activates the myrussian.vim keymap.

The previous and current keymap are per buffer. The variables b:prev_keymap and b:cur_keymap are used to keep track of them.