From bc4a2e1576c66ae5eea5463990d73528b3fc75bf Mon Sep 17 00:00:00 2001 From: Tommy Allen Date: Fri, 5 Aug 2016 00:47:28 -0400 Subject: help, man.vim: "outline" (TOC) feature #5169 --- runtime/ftplugin/help.vim | 72 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) (limited to 'runtime/ftplugin/help.vim') diff --git a/runtime/ftplugin/help.vim b/runtime/ftplugin/help.vim index a0a0f292eb..c94b2ef3eb 100644 --- a/runtime/ftplugin/help.vim +++ b/runtime/ftplugin/help.vim @@ -18,5 +18,77 @@ if has("conceal") setlocal cole=2 cocu=nc endif +if !exists('g:no_plugin_maps') + function! s:show_toc() abort + let bufname = bufname('%') + let info = getloclist(0, {'winid': 1}) + if !empty(info) && getwinvar(info.winid, 'qf_toc') ==# bufname + lopen + return + endif + + let toc = [] + let lnum = 2 + let last_line = line('$') - 1 + let last_added = 0 + let has_section = 0 + let has_sub_section = 0 + + while lnum && lnum <= last_line + let level = 0 + let add_text = '' + let text = getline(lnum) + + if text =~# '^=\+$' && lnum + 1 < last_line + " A de-facto section heading. Other headings are inferred. + let has_section = 1 + let has_sub_section = 0 + let lnum = nextnonblank(lnum + 1) + let text = getline(lnum) + let add_text = text + while add_text =~# '\*[^*]\+\*\s*$' + let add_text = matchstr(add_text, '.*\ze\*[^*]\+\*\s*$') + endwhile + elseif text =~# '^[A-Z0-9][-A-ZA-Z0-9 .][-A-Z0-9 .():]*\%([ \t]\+\*.\+\*\)\?$' + " Any line that's yelling is important. + let has_sub_section = 1 + let level = has_section + let add_text = matchstr(text, '.\{-}\ze\s*\%([ \t]\+\*.\+\*\)\?$') + elseif text =~# '\~$' + \ && matchstr(text, '^\s*\zs.\{-}\ze\s*\~$') !~# '\t\|\s\{2,}' + \ && getline(lnum - 1) =~# '^\s*<\?$\|^\s*\*.*\*$' + \ && getline(lnum + 1) =~# '^\s*>\?$\|^\s*\*.*\*$' + " These lines could be headers or code examples. We only want the + " ones that have subsequent lines at the same indent or more. + let l = nextnonblank(lnum + 1) + if getline(l) =~# '\*[^*]\+\*$' + " Ignore tag lines + let l = nextnonblank(l + 1) + endif + + if indent(lnum) <= indent(l) + let level = has_section + has_sub_section + let add_text = matchstr(text, '\S.*') + endif + endif + + let add_text = substitute(add_text, '\s\+$', '', 'g') + if !empty(add_text) && last_added != lnum + let last_added = lnum + call add(toc, {'bufnr': bufnr('%'), 'lnum': lnum, + \ 'text': repeat(' ', level) . add_text}) + endif + let lnum = nextnonblank(lnum + 1) + endwhile + + call setloclist(0, toc, ' ') + call setloclist(0, [], 'a', {'title': 'Help TOC'}) + lopen + let w:qf_toc = bufname + endfunction + + nnoremap :call show_toc() +endif + let &cpo = s:cpo_save unlet s:cpo_save -- cgit From 6720fe253e92b21c7f989389a64e363b5933884f Mon Sep 17 00:00:00 2001 From: Peter Renstròˆm Date: Sun, 26 Jul 2015 17:02:36 +0200 Subject: runtime: K: prefer Vim help instead of man #3104 --- runtime/ftplugin/help.vim | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) (limited to 'runtime/ftplugin/help.vim') diff --git a/runtime/ftplugin/help.vim b/runtime/ftplugin/help.vim index c94b2ef3eb..9d2361b413 100644 --- a/runtime/ftplugin/help.vim +++ b/runtime/ftplugin/help.vim @@ -11,13 +11,16 @@ let b:did_ftplugin = 1 let s:cpo_save = &cpo set cpo&vim -let b:undo_ftplugin = "setl fo< tw< cole< cocu<" +let b:undo_ftplugin = "setl fo< tw< cole< cocu< keywordprg<" setlocal formatoptions+=tcroql textwidth=78 if has("conceal") setlocal cole=2 cocu=nc endif +" Prefer Vim help instead of manpages. +setlocal keywordprg=:help + if !exists('g:no_plugin_maps') function! s:show_toc() abort let bufname = bufname('%') -- cgit From 70683705603e8e0e225574f01bc8b6824d5320eb Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sat, 21 Oct 2017 02:33:58 +0200 Subject: help, man.vim: change "outline" map to gO (#7405) --- runtime/ftplugin/help.vim | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'runtime/ftplugin/help.vim') diff --git a/runtime/ftplugin/help.vim b/runtime/ftplugin/help.vim index 9d2361b413..e6d48454d9 100644 --- a/runtime/ftplugin/help.vim +++ b/runtime/ftplugin/help.vim @@ -90,7 +90,7 @@ if !exists('g:no_plugin_maps') let w:qf_toc = bufname endfunction - nnoremap :call show_toc() + nnoremap gO :call show_toc() endif let &cpo = s:cpo_save -- cgit From 93fb7383a330f03bf64ed5558a8e16ea4c742478 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Mon, 6 Nov 2017 05:05:54 +0100 Subject: vim-patch:214641f77df6 Runtime file updates. https://github.com/vim/vim/commit/214641f77df6f318a4b3a0b09723c19859a103f4 N/A: vim-patch:26a280c47a1c --- runtime/ftplugin/help.vim | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'runtime/ftplugin/help.vim') diff --git a/runtime/ftplugin/help.vim b/runtime/ftplugin/help.vim index e6d48454d9..0f448bd306 100644 --- a/runtime/ftplugin/help.vim +++ b/runtime/ftplugin/help.vim @@ -1,7 +1,7 @@ " Vim filetype plugin file -" Language: Vim help file -" Maintainer: Nikolai Weibull -" Latest Revision: 2008-07-09 +" Language: Vim help file +" Previous Maintainer: Nikolai Weibull +" Latest Revision: 2008-07-09 if exists("b:did_ftplugin") finish -- cgit