diff options
| -rw-r--r-- | README.mkd (renamed from README.md) | 29 | ||||
| -rw-r--r-- | autoload/togglebg.vim (renamed from plugin/togglebackground.vim) | 28 | ||||
| -rw-r--r-- | doc/tags | 20 | ||||
| -rw-r--r-- | doc/togglebg.txt (renamed from doc/togglebackground.txt) | 39 |
4 files changed, 68 insertions, 48 deletions
@@ -1,3 +1,13 @@ +--- +Title: Solarized Colorscheme for Vim +Description: Precision colors for machines and people +Author: Ethan Schoonover +Colors: light yellow +Created: 2011 Mar 15 +Modified: 2011 Apr 12 + +--- + Solarized Colorscheme for Vim ============================= @@ -185,15 +195,19 @@ Toggle Background Function Solarized comes with a Toggle Background plugin that by default will map to <F5> if that mapping is available. If it is not available you will need to either map the function manually or change your current <F5> mapping to -something else. If you wish to map the function manually, enter the following -lines in your .vimrc: +something else. + +To set your own mapping in your .vimrc file, simply add the following three +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. You may run `:help togglebg` for more information. +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. Code Notes ---------- @@ -254,4 +268,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - diff --git a/plugin/togglebackground.vim b/autoload/togglebg.vim index 7663af7..f060cee 100644 --- a/plugin/togglebackground.vim +++ b/autoload/togglebg.vim @@ -3,21 +3,10 @@ " Maintainer: Ethan Schoonover " License: OSI approved MIT license -if exists("g:loaded_ToggleBackground") +if exists("g:loaded_togglebg") finish endif -let g:loaded_ToggleBackground = 1 - -if !exists("no_plugin_maps") && !hasmapto('<Plug>ToggleBackground') - " map alone won't work here as it doesn't - try - silent! nmap <unique> <F5> <Plug>ToggleBackground - silent! imap <unique> <F5> <Plug>ToggleBackground - silent! vmap <unique> <F5> <Plug>ToggleBackground - finally - let g:test_val = "checked" - endtry -endif +let g:loaded_togglebg = 1 " noremap is a bit misleading here if you are unused to vim mapping. " in fact, there is remapping, but only of script locally defined remaps, in @@ -43,3 +32,16 @@ function! ToggleBackground() echo "Please update your ToggleBackground mapping. ':help togglebg' for information." endfunction +function! togglebg#map(mapActivation) + try + exe "silent! nmap <unique> ".a:mapActivation." <Plug>ToggleBackground" + exe "silent! imap <unique> ".a:mapActivation." <Plug>ToggleBackground" + exe "silent! vmap <unique> ".a:mapActivation." <Plug>ToggleBackground" + finally + return 0 + endtry +endfunction + +if !exists("no_plugin_maps") && !hasmapto('<Plug>ToggleBackground') + call togglebg#map("<F5>") +endif @@ -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 |