patch 8.2.4891: Vim help presentation could be betterv8.2.4891

Problem:    Vim help presentation could be better.
Solution:   Add an imported file for extra Vim help support.  Show highlight
            names in the color they have.

1 files changed, 21 insertions, 0 deletions

diff --git a/runtime/import/dist/vimhelp.vim b/runtime/import/dist/vimhelp.vim
new file mode 100644
index 0000000000..1f587251b9
--- /dev/null
+++ b/runtime/import/dist/vimhelp.vim
@@ -0,0 +1,21 @@
+vim9script
+
+# Extra functionality for displaying Vim help .
+
+# Called when editing the doc/syntax.txt file
+export def HighlightGroups()
+  var buf: number = bufnr('%')
+  var lnum: number = search('\*highlight-groups\*', 'cn')
+  while getline(lnum) !~ '===' && lnum < line('$')
+    var word: string = getline(lnum)->matchstr('^\w\+\ze\t')
+    if word->hlexists()
+      prop_type_add('help-hl-' .. word, {
+	bufnr: buf,
+	highlight: word,
+	combine: false,
+	})
+      prop_add(lnum, 1, {length: word->strlen(), type: 'help-hl-' .. word})
+    endif
+    ++lnum
+  endwhile
+enddef