From 3f6fde46a4d1dfc7f96ffb40f0463f93edf643df Mon Sep 17 00:00:00 2001 From: itchyny Date: Thu, 22 Aug 2013 14:36:29 +0900 Subject: [PATCH] improve doc --- autoload/lightline.vim | 18 ++++---- doc/lightline.txt | 102 +++++++++++++++++++++++++++++++++++++++-- 2 files changed, 107 insertions(+), 13 deletions(-) diff --git a/autoload/lightline.vim b/autoload/lightline.vim index bad6ac8..b70232b 100644 --- a/autoload/lightline.vim +++ b/autoload/lightline.vim @@ -3,7 +3,7 @@ " Version: 0.0 " Author: itchyny " License: MIT License -" Last Change: 2013/08/22 13:34:47. +" Last Change: 2013/08/22 14:21:34. " ============================================================================= let s:save_cpo = &cpo @@ -82,18 +82,18 @@ function! lightline#init() for m in ['normal', 'insert', 'replace', 'visual', 'inactive'] let g:lightline.palette[m] = get(g:lightline.palette, m, {}) endfor - " try + try let g:lightline.palette = g:lightline#colorscheme#{g:lightline.colorscheme}#palette - " catch - " call lightline#error('Colorscheme ' . g:lightline.colorscheme . ' could not loaded.') - " let g:lightline.colorscheme = 'default' - " let g:lightline.palette = g:lightline#colorscheme#{g:lightline.colorscheme}#palette - " finally + catch + call lightline#error('Colorscheme ' . g:lightline.colorscheme . ' could not loaded.') + let g:lightline.colorscheme = 'default' + let g:lightline.palette = g:lightline#colorscheme#{g:lightline.colorscheme}#palette + finally for m in ['normal', 'insert', 'replace', 'visual', 'inactive', 'command'] call lightline#highlight(m) endfor - " let s:_ = 0 - " endtry + let s:_ = 0 + endtry endfunction function! lightline#mode() diff --git a/doc/lightline.txt b/doc/lightline.txt index f629e35..02364b2 100644 --- a/doc/lightline.txt +++ b/doc/lightline.txt @@ -4,7 +4,7 @@ Version: 0.0 Author: itchyny (https://github.com/itchyny) License: MIT License Repository: https://github.com/itchyny/lightline.vim -Last Change: 2013/08/22 10:37:17. +Last Change: 2013/08/22 14:36:22. CONTENTS *lightline-contents* @@ -23,13 +23,107 @@ The *lightline* plugin is a light and configurable statusline for Vim. ------------------------------------------------------------------------------ OPTIONS *lightline-options* + g:lightline *g:lightline* + All the options are stored into this global variable. + + g:lightline.active *g:lightline.active* + g:lightline.inactive *g:lightline.inactive* + Dictionaries to specify the status components. + The default values are: +> + let g:lightline.active = { + \ 'left': [ [ 'mode', 'paste' ], + \ [ 'fugitive', 'readonly', 'filename', 'modified' ] ], + \ 'right': [ [ 'lineinfo' ], + \ [ 'percent' ], + \ [ 'fileformat', 'fileencoding', 'filetype' ] ] } + let g:lightline.inactive = { + \ 'left': [ [ 'filename' ] ], + \ 'right': [ [ 'lineinfo' ], + \ [ 'percent' ] ] } +< + g:lightline.component *g:lightline.component* + Dictionary for statusline components. + The default value is: +> + let g:lightline.component = { + \ 'mode': '%{lightline#mode()}', + \ 'filename': '%t', + \ 'modified': '%M', + \ 'paste': '%{&paste?"PASTE":""}', + \ 'readonly': '%R', + \ 'fileencoding': '%{strlen(&fenc)?&fenc:&enc}', + \ 'fileformat': '%{&fileformat}', + \ 'filetype': '%{strlen(&filetype)?&filetype:"no ft"}', + \ 'percent': '%3p%%', + \ 'lineinfo': '%3l:%-2v', + \ 'fugitive': '%{exists("*fugitive#head")?fugitive#head():""}' } +< + g:lightline.component_flag *g:lightline.component_flag* + Dictionary of boolean expressions for the components. + Each expression corresponds to if the component have non-zero + length. + For example, the flag for paste component is: +> + let g:lightline.component_flag = { + \ 'paste': '(&paste)' } +< + Users are recommended to set this option together with the + component itself. + + g:lightline.component_func *g:lightline.component_func* + Another dictionary for components. This is more convenient + because the user does not have to set both component and + component_flag. + For example, if you want a component for readonly mark, which + disappears in help windows: +> + let g:lightline = { + \ 'active': { + \ 'left': [ [ 'mode', 'paste' ], + \ [ 'myreadonly', 'filename', 'modified' ] ], + \ }, + \ 'component_func': { + \ 'myreadonly': 'MyReadonly' + \ }, + \ } + function! MyReadonly() + return &ft !~? 'help' && &ro ? 'RO' : '' + endfunction +< + g:lightline.colorscheme *g:lightline.colorscheme* + The colorscheme for lightline.vim. + Currently, wombat, solarized and landscape are available. +> + let g:lightline.colorscheme = 'default' +< + g:lightline.mode_map *g:lightline.mode_map* + A dictionary of names for mode. + The default value is: +> + let g:lightline.mode_map = { + \ 'n' : 'NORMAL', + \ 'i' : 'INSERT', + \ 'R' : 'REPLACE', + \ 'v' : 'VISUAL', + \ 'V' : 'V-LINE', + \ 'c' : 'COMMAND', + \ '': 'V-BLOCK', + \ 's' : 'SELECT', + \ 'S' : 'S-LINE', + \ '': 'S-BLOCK', + \ '?': ' ' } +< + ------------------------------------------------------------------------------ EXAMPLES *lightline-examples* +You can configure the appearance of statusline. +Write the following examples in you .vimrc(_vimrc). In order to change the colorscheme: > let g:lightline = { - \ 'colorscheme': 'landscape', + \ 'colorscheme': 'wombat', \ } In order to define own component: @@ -88,7 +182,7 @@ NICE EXAMPLES *lightline-nice-examples* A nice example for |vim-powerline| font users: > let g:lightline = { - \ 'colorscheme': 'landscape', + \ 'colorscheme': 'wombat', \ 'active': { \ 'left': [ [ 'mode', 'paste' ], [ 'myfugitive', 'myfilename' ] ] \ }, @@ -105,7 +199,7 @@ A nice example for |vim-powerline| font users: return &modifiable && &modified ? '+' : '' endfunction function! MyReadonly() - return &ft !~? 'help\|zcalendar' && &ro ? '⭤' : '' + return &ft !~? 'help' && &ro ? '⭤' : '' endfunction function! MyFilename() return ('' != MyReadonly() ? MyReadonly() . ' ' : '') .