From 2e70f3522b5a4ab35341d2e6ce3f04a5bddef436 Mon Sep 17 00:00:00 2001 From: altermo <107814000+altermo@users.noreply.github.com> Date: Thu, 11 Sep 2025 06:16:13 +0200 Subject: [PATCH] docs: plugins.txt #35680 Co-authored-by: Justin M. Keyes --- runtime/doc/help.txt | 10 ++---- runtime/doc/lua.txt | 33 ------------------- runtime/doc/plugins.txt | 73 +++++++++++++++++++++++++++++++++++++++++ src/gen/gen_vimdoc.lua | 22 +++++++++---- 4 files changed, 90 insertions(+), 48 deletions(-) create mode 100644 runtime/doc/plugins.txt diff --git a/runtime/doc/help.txt b/runtime/doc/help.txt index 3ece28b672..3c8a61ab3a 100644 --- a/runtime/doc/help.txt +++ b/runtime/doc/help.txt @@ -176,14 +176,8 @@ DEVELOPING NVIM |dev-vimpatch| Merging patches from Vim Standard plugins ~ - *standard-plugin-list* -|pi_gzip.txt| Reading and writing compressed files -|pi_msgpack.txt| msgpack utilities -|pi_paren.txt| Highlight matching parens -|pi_spec.txt| Filetype plugin to work with rpm spec files -|pi_tar.txt| Tar file explorer -|pi_zip.txt| Zip archive explorer -|netrw| Reading and writing files over a network + +See |standard-plugin-list|. Local additions ~ *local-additions* diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 33451910b2..606df34ffb 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -5139,39 +5139,6 @@ vim.version.range({spec}) *vim.version.range()* (`vim.VersionRange?`) See |vim.VersionRange|. -============================================================================== -Lua module: tohtml *vim.tohtml* - - -:[range]TOhtml {file} *:TOhtml* -Converts the buffer shown in the current window to HTML, opens the generated -HTML in a new split window, and saves its contents to {file}. If {file} is not -given, a temporary file (created by |tempname()|) is used. - - -tohtml.tohtml({winid}, {opt}) *tohtml.tohtml.tohtml()* - Converts the buffer shown in the window {winid} to HTML and returns the - output as a list of string. - - Parameters: ~ - • {winid} (`integer?`) Window to convert (defaults to current window) - • {opt} (`table?`) Optional parameters. - • {title}? (`string|false`, default: buffer name) Title tag - to set in the generated HTML code. - • {number_lines}? (`boolean`, default: `false`) Show line - numbers. - • {font}? (`string[]|string`, default: `guifont`) Fonts to - use. - • {width}? (`integer`, default: 'textwidth' if non-zero or - window width otherwise) Width used for items which are - either right aligned or repeat a character infinitely. - • {range}? (`integer[]`, default: entire buffer) Range of - rows to use. - - Return: ~ - (`string[]`) - - ============================================================================== Lua module: vim._extui *vim._extui* diff --git a/runtime/doc/plugins.txt b/runtime/doc/plugins.txt new file mode 100644 index 0000000000..e6ac2a37b9 --- /dev/null +++ b/runtime/doc/plugins.txt @@ -0,0 +1,73 @@ +*plugins.txt* Nvim + + + NVIM REFERENCE MANUAL + + Type |gO| to see the table of contents. + +============================================================================== +Plugins and modules included with Nvim + +Nvim includes various Lua and Vim plugins or modules which may provide +commands (such as :TOhtml) or modules that you can optionally require() or +:packadd. The Lua ones are not part of the |lua-stdlib|, that is, they are not +available from the global `vim` module namespace. Some of the plugins are by +default loaded while others require a |:packadd| to be loaded. + +============================================================================== +Standard plugins ~ + *standard-plugin-list* +Help-link Loaded Short description +|package-cfilter| No Filtering quickfix/location list +|package-justify| No Justify text +|package-nohlsearch| No Automatically run :nohlsearch +|package-termdebug| No Debug inside Nvim with gdb +|matchit| Yes Extended |%| matching +|editorconfig.txt| Yes Detect and internet editorconfig +|spellfile.vim| Yes Install spellfile if missing +|pi_tutor.txt| Yes Interactive tutorial +|pi_gzip.txt| Yes Reading and writing compressed files +|pi_msgpack.txt| No msgpack utilities +|pi_paren.txt| Yes Highlight matching parens +|pi_tar.txt| Yes Tar file explorer +|pi_zip.txt| Yes Zip archive explorer +|netrw| Yes Reading and writing files over a network +|ftplugin-docs| * Filetype specific plugins + |man.lua| Yes Opening and viewing manpages + |pi_spec.txt| Yes Filetype plugin to work with rpm spec files +|tohtml| Yes Convert buffer to html, syntax included + +============================================================================== +Builtin plugin: tohtml *tohtml* + + +:[range]TOhtml {file} *:TOhtml* +Converts the buffer shown in the current window to HTML, opens the generated +HTML in a new split window, and saves its contents to {file}. If {file} is not +given, a temporary file (created by |tempname()|) is used. + + +tohtml({winid}, {opt}) *tohtml.tohtml()* + Converts the buffer shown in the window {winid} to HTML and returns the + output as a list of string. + + Parameters: ~ + • {winid} (`integer?`) Window to convert (defaults to current window) + • {opt} (`table?`) Optional parameters. + • {title}? (`string|false`, default: buffer name) Title tag + to set in the generated HTML code. + • {number_lines}? (`boolean`, default: `false`) Show line + numbers. + • {font}? (`string[]|string`, default: `guifont`) Fonts to + use. + • {width}? (`integer`, default: 'textwidth' if non-zero or + window width otherwise) Width used for items which are + either right aligned or repeat a character infinitely. + • {range}? (`integer[]`, default: entire buffer) Range of + rows to use. + + Return: ~ + (`string[]`) + + + vim:tw=78:ts=8:sw=4:sts=4:et:ft=help:norl: diff --git a/src/gen/gen_vimdoc.lua b/src/gen/gen_vimdoc.lua index 0450c46f62..1797cd9a7e 100755 --- a/src/gen/gen_vimdoc.lua +++ b/src/gen/gen_vimdoc.lua @@ -184,11 +184,9 @@ local config = { 'version.lua', -- Sections at the end, in a specific order: - 'tohtml.lua', '_extui.lua', }, files = { - 'runtime/lua/tohtml.lua', 'runtime/lua/vim/_editor.lua', 'runtime/lua/vim/_extui.lua', 'runtime/lua/vim/_inspector.lua', @@ -249,9 +247,6 @@ local config = { elseif name == 'builtin' then return 'VIM' end - if name == 'tohtml' then - return 'Lua module: tohtml' - end return 'Lua module: vim.' .. name end, helptag_fmt = function(name) @@ -261,8 +256,6 @@ local config = { return 'lua-vim-system' elseif name == '_options' then return 'lua-vimscript' - elseif name == 'tohtml' then - return 'tohtml' end return 'vim.' .. name:lower() end, @@ -436,6 +429,21 @@ local config = { return { 'vim.pack' } end, }, + plugins = { + filename = 'plugins.txt', + section_order = { + 'tohtml.lua', + }, + files = { + 'runtime/lua/tohtml.lua', + }, + section_fmt = function(name) + return 'Builtin plugin: ' .. name:lower() + end, + helptag_fmt = function(name) + return name:lower() + end, + }, } --- @param ty string