From 92aa47e3dc3642eeefcb78797a49d1e3139966bc Mon Sep 17 00:00:00 2001 From: Wang Shidong Date: Sun, 3 Jun 2018 19:25:41 +0800 Subject: [PATCH] Add doc for statusline and tabline (#1783) --- autoload/SpaceVim/layers/core/statusline.vim | 12 +++- autoload/SpaceVim/layers/core/tabline.vim | 8 ++- doc/SpaceVim.txt | 76 ++++++++++++-------- 3 files changed, 65 insertions(+), 31 deletions(-) diff --git a/autoload/SpaceVim/layers/core/statusline.vim b/autoload/SpaceVim/layers/core/statusline.vim index e58e91c37..ce2bc32a5 100644 --- a/autoload/SpaceVim/layers/core/statusline.vim +++ b/autoload/SpaceVim/layers/core/statusline.vim @@ -6,7 +6,17 @@ " License: GPLv3 "============================================================================= -" statusline +"" +" @section core#statusline, layer-core-statusline +" @parentsection layers +" This layer provides default statusline for SpaceVim +" If you want to use airline's statusline, just disable this layer +" > +" [[layers]] +" name = "core#statusline" +" enable = false +" < + scriptencoding utf-8 let g:_spacevim_statusline_loaded = 1 " APIs diff --git a/autoload/SpaceVim/layers/core/tabline.vim b/autoload/SpaceVim/layers/core/tabline.vim index 701115278..03b722969 100644 --- a/autoload/SpaceVim/layers/core/tabline.vim +++ b/autoload/SpaceVim/layers/core/tabline.vim @@ -10,6 +10,12 @@ " @section core#tabline, layer-core-tabline " @parentsection layers " This layer provides default tabline for SpaceVim +" If you want to use airline's tabline, just disable this layer +" > +" [[layers]] +" name = "core#tabline" +" enable = false +" < scriptencoding utf-8 let s:messletters = SpaceVim#api#import('messletters') @@ -32,7 +38,7 @@ let s:separators = { let s:i_separators = { \ 'arrow' : ["\ue0b1", "\ue0b3"], - \ 'bar' : ["|", "|"], + \ 'bar' : ['|', '|'], \ 'nil' : ['', ''], \ } diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index 1c2c7cb96..61177d94e 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -25,34 +25,35 @@ CONTENTS *SpaceVim-contents* 1. autocomplete..................................|SpaceVim-autocomplete| 2. checkers....................................|SpaceVim-layer-checkers| 3. colorscheme....................................|SpaceVim-colorscheme| - 4. core#tabline............................|SpaceVim-layer-core-tabline| - 5. exprfold....................................|SpaceVim-layer-exprfold| - 6. format..............................................|SpaceVim-format| - 7. github........................................|SpaceVim-layer-github| - 8. incsearch..................................|SpaceVim-layer-incsearch| - 9. indentmove................................|SpaceVim-layer-indentmove| - 10. lang#c.......................................|SpaceVim-layer-lang-c| - 11. lang#crystal...........................|SpaceVim-layer-lang-crystal| - 12. lang#csharp.............................|SpaceVim-layer-lang-csharp| - 13. lang#elixir.............................|SpaceVim-layer-lang-elixir| - 14. lang#go.....................................|SpaceVim-layer-lang-go| - 15. lang#java.................................|SpaceVim-layer-lang-java| - 16. lang#julia...............................|SpaceVim-layer-lang-julia| - 17. lang#kotlin.............................|SpaceVim-layer-lang-kotlin| - 18. lang#lua...................................|SpaceVim-layer-lang-lua| - 19. lang#ocaml...............................|SpaceVim-layer-lang-ocaml| - 20. lang#php...................................|SpaceVim-layer-lang-php| - 21. lang#pony.................................|SpaceVim-layer-lang-pony| - 22. lang#puppet.............................|SpaceVim-layer-lang-puppet| - 23. lang#python.............................|SpaceVim-layer-lang-python| - 24. lang#rust.................................|SpaceVim-layer-lang-rust| - 25. lang#scala...............................|SpaceVim-layer-lang-scala| - 26. lang#tmux.................................|SpaceVim-layer-lang-tmux| - 27. lang#xml...................................|SpaceVim-layer-lang-xml| - 28. operator...................................|SpaceVim-layer-operator| - 29. shell.........................................|SpaceVim-layer-shell| - 30. tmux...........................................|SpaceVim-layer-tmux| - 31. tools#dash...............................|SpaceVim-layer-tools-dash| + 4. core#statusline......................|SpaceVim-layer-core-statusline| + 5. core#tabline............................|SpaceVim-layer-core-tabline| + 6. exprfold....................................|SpaceVim-layer-exprfold| + 7. format..............................................|SpaceVim-format| + 8. github........................................|SpaceVim-layer-github| + 9. incsearch..................................|SpaceVim-layer-incsearch| + 10. indentmove...............................|SpaceVim-layer-indentmove| + 11. lang#c.......................................|SpaceVim-layer-lang-c| + 12. lang#crystal...........................|SpaceVim-layer-lang-crystal| + 13. lang#csharp.............................|SpaceVim-layer-lang-csharp| + 14. lang#elixir.............................|SpaceVim-layer-lang-elixir| + 15. lang#go.....................................|SpaceVim-layer-lang-go| + 16. lang#java.................................|SpaceVim-layer-lang-java| + 17. lang#julia...............................|SpaceVim-layer-lang-julia| + 18. lang#kotlin.............................|SpaceVim-layer-lang-kotlin| + 19. lang#lua...................................|SpaceVim-layer-lang-lua| + 20. lang#ocaml...............................|SpaceVim-layer-lang-ocaml| + 21. lang#php...................................|SpaceVim-layer-lang-php| + 22. lang#pony.................................|SpaceVim-layer-lang-pony| + 23. lang#puppet.............................|SpaceVim-layer-lang-puppet| + 24. lang#python.............................|SpaceVim-layer-lang-python| + 25. lang#rust.................................|SpaceVim-layer-lang-rust| + 26. lang#scala...............................|SpaceVim-layer-lang-scala| + 27. lang#tmux.................................|SpaceVim-layer-lang-tmux| + 28. lang#xml...................................|SpaceVim-layer-lang-xml| + 29. operator...................................|SpaceVim-layer-operator| + 30. shell.........................................|SpaceVim-layer-shell| + 31. tmux...........................................|SpaceVim-layer-tmux| + 32. tools#dash...............................|SpaceVim-layer-tools-dash| 7. API........................................................|SpaceVim-api| 1. cmdlinemenu................................|SpaceVim-api-cmdlinemenu| 2. data#list....................................|SpaceVim-api-data-list| @@ -645,10 +646,27 @@ colorscheme called atom doesn't support spell check very well. SpaceVim is not gonna fix them since these should be in charge of each author. +============================================================================== +CORE#STATUSLINE *SpaceVim-layer-core-statusline* + +This layer provides default statusline for SpaceVim If you want to use +airline's statusline, just disable this layer +> + [[layers]] + name = "core#statusline" + enable = false +< + ============================================================================== CORE#TABLINE *SpaceVim-layer-core-tabline* -This layer provides default tabline for SpaceVim +This layer provides default tabline for SpaceVim If you want to use airline's +tabline, just disable this layer +> + [[layers]] + name = "core#tabline" + enable = false +< ============================================================================== EXPRFOLD *SpaceVim-layer-exprfold*