aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGravatar Ethan Schoonover <es@ethanschoonover.com>2011-04-12 16:17:59 -0700
committerGravatar Ethan Schoonover <es@ethanschoonover.com>2011-04-12 16:17:59 -0700
commit4a9b7ecc66e6a451e273befcf418d36cb7167637 (patch)
treec7f602500bea56e34fb64f7c8880c6a3bb427b03 /doc
parent4727d3afd6ac9278e4e5dcee6762ed8bb3501eef (diff)
downloadvim-colors-solarized-4a9b7ecc66e6a451e273befcf418d36cb7167637.tar.gz
updated vim solarized togglebg plugin to fix silent error on unique remapping
Diffstat (limited to 'doc')
-rw-r--r--doc/tags20
-rw-r--r--doc/togglebg.txt (renamed from doc/togglebackground.txt)39
2 files changed, 32 insertions, 27 deletions
diff --git a/doc/tags b/doc/tags
index cfca616..ccdbed9 100644
--- a/doc/tags
+++ b/doc/tags
@@ -1,9 +1,11 @@
-togbg togglebackground.txt /*togbg*
-togbg-default togglebackground.txt /*togbg-default*
-togbg-issues togglebackground.txt /*togbg-issues*
-togbg-newmap togglebackground.txt /*togbg-newmap*
-togbg-usage togglebackground.txt /*togbg-usage*
-toggle-background togglebackground.txt /*toggle-background*
-togglebackground togglebackground.txt /*togglebackground*
-togglebackground.txt togglebackground.txt /*togglebackground.txt*
-togglebg togglebackground.txt /*togglebg*
+tog-bg togglebg.txt /*tog-bg*
+togbg togglebg.txt /*togbg*
+toggle-background togglebg.txt /*toggle-background*
+toggle-bg togglebg.txt /*toggle-bg*
+togglebackground togglebg.txt /*togglebackground*
+togglebg togglebg.txt /*togglebg*
+togglebg-default togglebg.txt /*togglebg-default*
+togglebg-issues togglebg.txt /*togglebg-issues*
+togglebg-newmap togglebg.txt /*togglebg-newmap*
+togglebg-usage togglebg.txt /*togglebg-usage*
+togglebg.vim togglebg.txt /*togglebg.vim*
diff --git a/doc/togglebackground.txt b/doc/togglebg.txt
index afba791..5839ddc 100644
--- a/doc/togglebackground.txt
+++ b/doc/togglebg.txt
@@ -1,30 +1,31 @@
-*togglebackground.txt* For Vim version 7.3. or newer Last change: 2011 Apr 7
+*togglebg.vim* For Vim version 7.3. or newer Modified: 2011 Apr 12
TOGGLE BACKGROUND PLUGIN by Ethan Schoonover ~
-Toggle Background *toggle-background*
- *togglebackground*
- *togglebg* *togbg*
+Toggle Background *togglebackground*
+ *toggle-background*
+ *togglebg* *toggle-bg*
+ *togbg* *tog-bg*
Toggle Background is a simple plugin to switch between light and dark
background modes and reset the colorscheme. This is most useful for
colorschemes that support both light and dark modes and in terminals or gui
vim windows where the background will be properly set.
-0. Usage |togbg-usage|
-1. Default Mapping |togbg-default|
-2. Changing the Mapping |togbg-newmap|
-3. Issues |togbg-issues|
+0. Usage |togglebg-usage|
+1. Default Mapping |togglebg-default|
+2. Changing the Mapping |togglebg-newmap|
+3. Issues |togglebg-issues|
==============================================================================
-0. Usage *togbg-usage*
+0. Usage *togglebg-usage*
Press your map key(s) to activate Toggle Background, or select "Toggle
Background" from the 'Window' menu while in gui mode.
==============================================================================
-1. Default Mapping *togbg-default*
+1. Default Mapping *togglebg-default*
Toggle Background starts with a default mapping to function key <F5>. If you
are already using this in a mapping, Toggle Background will not map itself to
@@ -32,20 +33,22 @@ a default and you will have to map it manually in your .vimrc file, or
remove/change your existing <F5> mapping to another value.
==============================================================================
-2. Changing the Mapping *togbg-newmap*
+2. Changing the Mapping *togglebg-newmap*
To set your own mapping in your .vimrc file, simply add the following three
-lines to support normal, insert and visual mode usage:
+lines to support normal, insert and visual mode usage, changing the "<F5>"
+value to the key or key combination you wish to use:
- nmap <unique> <F5> <Plug>ToggleBackground
- imap <unique> <F5> <Plug>ToggleBackground
- vmap <unique> <F5> <Plug>ToggleBackground
+ call togglebg#map("<F5>")
-Note that it is important to NOT use the noremap map variants. The plugin uses
-noremap internally.
+Note that you'll want to use a single function key or equivalent if you want
+the plugin to work in all modes (normal, insert, visual).
+
+Note also that it is important to NOT use the noremap map variants. The plugin
+uses noremap internally.
==============================================================================
-3. Issues *togbg-issues*
+3. Issues *togglebg-issues*
When using the plugin during insert mode, there should be no interruption in
workflow. However, if you activate the plugin during REPLACE mode, you will