From 3f99d0c2976e64d3e625cbf07f10471adfc2d9d2 Mon Sep 17 00:00:00 2001 From: wsdjeg Date: Tue, 5 Apr 2022 20:17:35 +0800 Subject: [PATCH] docs(todomanager): add `:h SpaceVim-plugins-todomanager` --- autoload/SpaceVim.vim | 5 ++++ autoload/SpaceVim/plugins/todo.vim | 15 ++++++++++++ doc/SpaceVim.txt | 37 ++++++++++++++++++++++++------ 3 files changed, 50 insertions(+), 7 deletions(-) diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim index 5de09a13d..3547fc4a6 100644 --- a/autoload/SpaceVim.vim +++ b/autoload/SpaceVim.vim @@ -1193,6 +1193,11 @@ let g:spacevim_project_rooter_outermost = 1 " Config the command line prompt for flygrep and denite etc. let g:spacevim_commandline_prompt = '➭' +"" +" @section todo_labels, options-todo_labels +" @parentsection options +" Option for setting todo labels in current project. + "" " Option for setting todo labels in current project. let g:spacevim_todo_labels = map(['fixme', 'question', 'todo', 'idea'], '"@" . v:val') diff --git a/autoload/SpaceVim/plugins/todo.vim b/autoload/SpaceVim/plugins/todo.vim index e9510dc30..18513bce1 100644 --- a/autoload/SpaceVim/plugins/todo.vim +++ b/autoload/SpaceVim/plugins/todo.vim @@ -6,6 +6,21 @@ " License: GPLv3 "============================================================================= +"" +" @section todo manager, plugins-todomanager +" @parentsection plugins +" The `todomanager` plugin provides todo manager support for SpaceVim. +" +" @subsection Key bindings +" > +" Key binding Description +" SPC a o open todo manager windows +" < +" +" @subsection Configuration +" +" The todo manager labels can be set via @section(options-todo_labels) + let s:JOB = SpaceVim#api#import('job') let s:BUFFER = SpaceVim#api#import('vim#buffer') let s:SYS = SpaceVim#api#import('system') diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index 1d4a28b0e..4eb1d4bf3 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -77,13 +77,14 @@ CONTENTS *SpaceVim-contents* 56. statusline_separator.........|SpaceVim-options-statusline_separator| 57. statusline_unicode.............|SpaceVim-options-statusline_unicode| 58. terminal_cursor_shape.......|SpaceVim-options-terminal_cursor_shape| - 59. vim_help_language...............|SpaceVim-options-vim_help_language| - 60. vimcompatible.......................|SpaceVim-options-vimcompatible| - 61. warning_symbol.....................|SpaceVim-options-warning_symbol| - 62. windisk_encoding.................|SpaceVim-options-windisk_encoding| - 63. windows_index_type.............|SpaceVim-options-windows_index_type| - 64. windows_leader.....................|SpaceVim-options-windows_leader| - 65. windows_smartclose.............|SpaceVim-options-windows_smartclose| + 59. todo_labels...........................|SpaceVim-options-todo_labels| + 60. vim_help_language...............|SpaceVim-options-vim_help_language| + 61. vimcompatible.......................|SpaceVim-options-vimcompatible| + 62. warning_symbol.....................|SpaceVim-options-warning_symbol| + 63. windisk_encoding.................|SpaceVim-options-windisk_encoding| + 64. windows_index_type.............|SpaceVim-options-windows_index_type| + 65. windows_leader.....................|SpaceVim-options-windows_leader| + 66. windows_smartclose.............|SpaceVim-options-windows_smartclose| 3. Configuration...........................................|SpaceVim-config| 4. Commands..............................................|SpaceVim-commands| 5. Public functions.....................................|SpaceVim-functions| @@ -232,6 +233,7 @@ CONTENTS *SpaceVim-contents* 8. Plugins................................................|SpaceVim-plugins| 1. iedit........................................|SpaceVim-plugins-iedit| 2. runner......................................|SpaceVim-plugins-runner| + 3. todo manager...........................|SpaceVim-plugins-todomanager| 9. API........................................................|SpaceVim-api| 1. clock............................................|SpaceVim-api-clock| 2. cmdlinemenu................................|SpaceVim-api-cmdlinemenu| @@ -819,6 +821,11 @@ the following to ~/.tmux.conf: set -ga terminal-overrides ',*:Ss=\E[%p1%d q:Se=\E[2 q' < +============================================================================== +TODO_LABELS *SpaceVim-options-todo_labels* + +Option for setting todo labels in current project. + ============================================================================== VIM_HELP_LANGUAGE *SpaceVim-options-vim_help_language* @@ -5530,6 +5537,22 @@ KEY BINDINGS i insert text to background process < +============================================================================== +TODO MANAGER *SpaceVim-plugins-todomanager* + +The `todomanager` plugin provides todo manager support for SpaceVim. + +KEY BINDINGS + +> + Key binding Description + SPC a o open todo manager windows +< + +CONFIGURATION + +The todo manager labels can be set via |SpaceVim-options-todo_labels| + ============================================================================== API *SpaceVim-api*