From 69a188881d0206911cb9c54a8b668ef38fbc8a60 Mon Sep 17 00:00:00 2001 From: itchyny Date: Tue, 27 Aug 2013 11:14:34 +0900 Subject: [PATCH] improve troubleshooting section in doc --- README.md | 4 +- doc/lightline.txt | 224 +++++++++++++++++++++++++++++++++++++++++++++- 2 files changed, 225 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fb80a48..a0ae7cd 100644 --- a/README.md +++ b/README.md @@ -227,8 +227,8 @@ Almost all of things go well with the patched font but if the triangle looks wei ![lightline.vim - tutorial](https://raw.github.com/wiki/itchyny/lightline.vim/image/tutorial/22.png) If you are using iTerm2, change the following settings of iTerm2: -+ set `Profiles>Colors>Minimum contrast` to Lowest. -+ set `Profiles>Window>Transparency` to Opaquest. ++ set `Profiles>Colors>Minimum contrast` to the Lowest. ++ set `Profiles>Window>Transparency` to the Opaquest. For other terminals, this weird-triangle problem will be resolved by disabling transparency or contrast adjustment. diff --git a/doc/lightline.txt b/doc/lightline.txt index f9a1488..65405b5 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/27 09:13:05. +Last Change: 2013/08/27 11:14:04. CONTENTS *lightline-contents* @@ -287,6 +287,36 @@ For |vim-powerline| font users: ------------------------------------------------------------------------------ NICE EXAMPLES *lightline-nice-examples* +A nice example for non-patched font users. +> + let g:lightline = { + \ 'colorscheme': 'wombat', + \ 'active': { + \ 'left': [ [ 'mode', 'paste' ], [ 'fugitive', 'filename' ] ] + \ }, + \ 'component_function': { + \ 'fugitive': 'MyFugitive', + \ 'filename': 'MyFilename' + \ } + \ } + function! MyModified() + return &ft =~ 'help\|vimfiler' ? '' : &modified ? '+' : &modifiable ? '' : '-' + endfunction + function! MyReadonly() + return &ft !~? 'help\|vimfiler' && &ro ? 'RO' : '' + endfunction + function! MyFilename() + return ('' != MyReadonly() ? MyReadonly() . ' ' : '') . + \ (&ft == 'vimfiler' ? vimfiler#get_status_string() : + \ &ft == 'unite' ? unite#get_status_string() : + \ &ft == 'vimshell' ? vimshell#get_status_string() : + \ '' != expand('%t') ? expand('%t') : '[No Name]') . + \ ('' != MyModified() ? ' ' . MyModified() : '') + endfunction + function! MyFugitive() + return &ft !~? 'vimfiler' && exists("*fugitive#head") && strlen(fugitive#head()) ? fugitive#head() : '' + endfunction +< A nice example for |vim-powerline| font users: > let g:lightline = { @@ -322,6 +352,198 @@ A nice example for |vim-powerline| font users: ------------------------------------------------------------------------------ TROUBLESHOOTING *lightline-troubleshooting* +Problem 1: |lightline-problem-1| + How to install this plugin. + +Problem 2: |lightline-problem-2| + How to update this plugin. + +Problem 3: |lightline-problem-3| + How to uninstall this plugin. + +Problem 4: |lightline-problem-4| + Cool statuslines appears only on `:vsp`. + +Problem 5: |lightline-problem-5| + The statusline does not seem to be correctly colored. + +Problem 6: |lightline-problem-6| + How to install a patched font. + +Problem 7: |lightline-problem-7| + Right triangles does not stick to the right components with the + patched font. + +Problem 8: |lightline-problem-8| + Triangles look weird. + +Problem 9: |lightline-problem-9| + Where can I find all the list of cool characters for patched fonts? + +Problem 10: |lightline-problem-10| + Cool statusline disappears on |unite|, |vimfiler| and |vimshell| + buffers. + +Problem 11: |lightline-problem-11| + Found a bug of this plugin. + Got many errors while using this plugin. + Vim hungs up while using this plugin. + Want this plugin to be more configurable. + This troubleshooting is not helpful. + +- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +Problem 1: *lightline-problem-1* + How to install this plugin. + + If you are to install this plugin manually: + + 1. Put all the files under $VIM. + + If you are to install this plugin using Vundle: + + 1. Add the following configuration to your + .vimrc(_vimrc). +> + Bundle 'itchyny/lightline.vim' +< + 2. Install with `:BundleInstall`. + + If you are to install this plugin using NeoBundle: + + 1. Add the following configuration to your + .vimrc(_vimrc). +> + NeoBundle 'itchyny/lightline.vim' +< + 2. Install with `:NeoBundleInstall`. + +Problem 2: *lightline-problem-2* + How to update this plugin. + + If you have installed this plugin manually: + + 1. Access https://github.com/itchyny/lightline.vim . + 2. Download the latest scripts. + 3. Place the scripts as written in Problem 1. + + If you have installed this plugin using Vundle: + + 1. Execute `:BundleInstall!`. Or try git pull in the + directory of this plugin. + + If you have installed this plugin using NeoBundle: + + 1. Execute `:NeoBundleInstall!`. Or try git pull in + the directory of this plugin. + +Problem 3: *lightline-problem-3* + How to uninstall this plugin. + + If you have installed this plugin manually: + + 1. Remove all the `lightline.*`s under $VIM. + + If you have installed this plugin using Vundle: + + 1. Remove the :Bundle 'itchyny/lightline.vim' + configuration from your .vimrc(_vimrc). + 2. Update with `:BundleClean`. + + If you have installed this plugin using NeoBundle: + + 1. Remove the :NeoBundle 'itchyny/lightline.vim' + configuration from your .vimrc(_vimrc). + 2. Update with `:NeoBundleClean`. + +Problem 4: *lightline-problem-4* + Cool statuslines appears only on `:vsp`. + + Add the following setting to your .vimrc(_vimrc). +> + set laststatus=2 +< +Problem 5: *lightline-problem-5* + The statusline does not seem to be correctly colored. + + Add +> + export TERM=xterm-256color +< + to your `.*shrc` and add +> + if !has('gui_running') + set t_Co=256 + endif +< + to your `.vimrc`. + +Problem 6: *lightline-problem-6* + How to install a patched font. + + There are two kinds of patched fonts: + + + The patched fonts for |vim-powerline| + (https://github.com/Lokaltog/vim-powerline): + follow the guide https://github.com/Lokaltog/vim-powerline/tree/develop/fontpatcher + + The patched fonts for |powerline| + (https://github.com/Lokaltog/powerline): + download from https://github.com/Lokaltog/powerline-fonts + +Problem 7: *lightline-problem-7* + Right triangles does not stick to the right components with patched + font. + + Remove the following setting from your .vimrc(_vimrc). +> + set ambiwidth=double +< + If you want to keep this setting, try the patched font for + |vim-powerline|. + +Problem 8: *lightline-problem-8* + Triangles look weird. + + If you are using iTerm2, change the following settings. + + + set Profiles>Colors>Minimum contrast to the Lowest. + + set Profiles>Window>Transparency to the Opaquest. + + For other terminals, this weird-triangle problem will be + resolved by disabling transparency or contrast adjustment. + +Problem 9: *lightline-problem-9* + Where can I find all the list of cool characters of patched fonts? + + Default powerline vim-powerline + separator.left '' '' '⮀' + separator.right '' '' '⮂' + subseparator.left '|' '' '⮁' + subseparator.right '|' '' '⮃' + branch symbol -- '' '⭠' + readonly symbol -- '' '⭤' + linecolumn symbol -- '' '⭡' + +Problem 10: *lightline-problem-10* + Cool statusline disappears on |unite|, |vimfiler| and |vimshell| + buffers. + + Add the following settings to your .vimrc(_vimrc). +> + let g:unite_force_overwrite_statusline = 0 + let g:vimfiler_force_overwrite_statusline = 0 + let g:vimshell_force_overwrite_statusline = 0 +< +Problem 11: *lightline-problem-11* + Found a bug of this plugin. + Got many errors while using this plugin. + Vim hungs up while using this plugin. + Want this plugin to be more configurable. + This troubleshooting is not helpful. + + Report/Request the issue/feature at + https://github.com/itchyny/lightline.vim/issues . + ============================================================================== CHANGELOG *lightline-changelog*