aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/helphelp.txt
Commit message (Collapse)AuthorAge
* docs(help): specify h4 "function signature" format #42434masterJustin M. Keyes2 days
| | | | | | | | | | | | | | | | | | | | | Work towards enabling ["flow" layout](https://github.com/neovim/neovim/blob/9244da12e400ec0291450a5e9400d995e7a29b83/src/gen/gen_help_html.lua#L86-L88) in all `:help` files. Problem: The final boss of vimdoc pseudo-structure: Vim's quasi-headings on function signatures and excmd docs is visually distinctive but too inconsistent for a nice parse rule. Solution: - Define the quasi-heading format as an "h4" variant, specified at `:help help-tag-heading`. - For simplicity and predictability, it is defined as any line that ends with a help tag(s) preceded by 2 or more spaces (or 1 tab). - Update existing docs. - This one-time update has a lot of changes, but is very unlikely to conflict with ported Vim-patches because (1) Vim rarely adds new *excmds* that we want, and (2) *function* docs are auto-generated. ref https://github.com/neovim/tree-sitter-vimdoc/issues/110
* docs: vimdoc specification #42412Justin M. Keyes3 days
| | | | | | | | | Problem: No "spec" for various :help format (vimdoc) conventions, including the new "table" support. Solution: Introduce `:help help-spec`. Also, bump the vimdoc parser.
* docs: flow layoutJustin M. Keyes3 days
| | | | | | | | | | Work towards enabling "flow" layout in most `:help` files. Since [tables are supported in help](https://github.com/neovim/tree-sitter-vimdoc#tables), it's now possible to render most help files as ["flow" layout](https://github.com/neovim/neovim/blob/9244da12e400ec0291450a5e9400d995e7a29b83/src/gen/gen_help_html.lua#L86-L88) instead of the legacy fixed-width layout. Besides [improved HTML rendering](https://github.com/neovim/neovim/pull/42381#discussion_r4285705739), flow layout will allow `:help` presentation-mode to un-hardwrap text blocks.
* docs: cleanup invalid help sourceJustin M. Keyes3 days
| | | | | | | | | | Work towards enabling "flow" layout in most `:help` files. Since [tables are supported in help](https://github.com/neovim/tree-sitter-vimdoc#tables), it's now possible to render most help files as ["flow" layout](https://github.com/neovim/neovim/blob/9244da12e400ec0291450a5e9400d995e7a29b83/src/gen/gen_help_html.lua#L86-L88) instead of the legacy fixed-width layout. Besides [improved HTML rendering](https://github.com/neovim/neovim/pull/42381#discussion_r4285705739), flow layout will allow `:help` presentation-mode to un-hardwrap text blocks.
* vim-patch:57d6d00: runtime(doc): Add documentation styleJan Edmund Lazo2026-09-06
| | | | | | | | | closes: vim/vim#17627 https://github.com/vim/vim/commit/57d6d004331f1770b5f04ba28ac242c0e0c8a005 Co-authored-by: Damien Lejay <damien@lejay.be> Co-authored-by: Phạm Bình An <111893501+brianhuster@users.noreply.github.com>
* feat(multicursor): MC HAMMER #41587Justin M. Keyes2026-09-01
| | | | | | | | | | | | | | | | | | | | | Other (squashed) commits: fix(tui): emit ui_send output atomically with the frame Problem: tui_ui_send() writes directly to the TTY, bypassing the output buffer. Sequences sent via nvim_ui_send() (e.g. kitty multiple-cursors, or visual-dot-repeat) always arrive in a separate TTY write from the frame they were computed for. This manifests as "tearing", or e.g. in the case of multicursor the terminal renders text with stale cursor overlays. Solution: - tui_ui_send(): while a frame is being assembled (pending invalid regions or buffered output), buffer instead of writing directly. - Out-of-frame sends (tty queries, clear-on-disable) still write immediately. - mcursor.lua: emit the terminal-cursor update at the end of the redraw cycle (`on_end`, when screen positions are final) instead of vim.schedule().
* build: don't require the "vimdoc" parser to build NvimJustin M. Keyes2026-08-25
| | | | | | | | | | | | Problem: The runs ":helptags", which needs the tree-sitter-vimdoc parser. This may cause problems for package maintainers / distros? Solution: Use running to generate the tags, like the zig build already does. It also errors on duplicate tags, which is good. The `:helptags` command still uses treesitter.
* feat(help): super K (":help!") guesses tag at cursor #36205Justin M. Keyes2026-03-15
| | | | | | | | | | | | | Problem: `K` in help files may fail in some noisy text. Example: (`fun(config: vim.lsp.ClientConfig): boolean`) ^cursor Solution: - `:help!` (bang, no args) activates DWIM behavior: tries `<cWORD>`, then trims punctuation until a valid tag is found. - Set `keywordprg=:help!` by default. - Does not affect `CTRL-]`, that is still fully "tags" based.
* docs: miscJustin M. Keyes2025-12-06
| | | | | | fix https://github.com/neovim/neovim.github.io/issues/419 Co-authored-by: Rob Pilling <robpilling@gmail.com>
* docs: rework main help pageJustin M. Keyes2025-11-16
|
* vim-patch:5427465: runtime(doc): Clean up file header whitespacezeertzjq2025-11-10
| | | | | | | | | | | | | - :retab! line 1 and line 4 (main page heading). - Use four columns whitespace before "by [Author]" in the user manual heading to match the reference manual formatting. - double space headings. closes: vim/vim#18648 https://github.com/vim/vim/commit/542746521ff8d111f33c3c8ff298ba58966c9acc Co-authored-by: Doug Kearns <dougkearns@gmail.com>
* vim-patch:partial:c58f91c: runtime(doc): Whitespace updates (#36160)zeertzjq2025-10-13
| | | | | | | | | | | | | | Use double sentence spacing and wrap lines at 'textwidth'. Code examples and tables were not wrapped unless this had already been done locally. closes: vim/vim#18453 https://github.com/vim/vim/commit/c58f91c035db09358c282f2a908e2aea4287785e Fix incorrect docs in :h ModeChanged. Cherry-pick :h bufnr() changes from patch 8.1.2080. Co-authored-by: Doug Kearns <dougkearns@gmail.com>
* vim-patch:2090405: runtime(doc): make examples verbatim to prevent ↵Yochem van Rosmalen2025-06-04
| | | | | | | conceal/tag parsing (#34299) closes: vim/vim#17437 https://github.com/vim/vim/commit/2090405de5bb66facc29c745596750bdebbd64c2
* vim-patch:b9ea0a8: runtime(doc): tweak documentation style in helphelp.txtbrianhuster2025-05-31
| | | | | | | | | | closes: vim/vim#16302 https://github.com/vim/vim/commit/b9ea0a89fadb53812860b8c2c1ca27e1d51a33da Co-authored-by: h-east <h.east.727@gmail.com> I removed some parts that are not applicable to Nvim, like HelpTOC
* vim-patch:5ddcecf: runtime(help): Add better support for language annotation ↵brianhuster2025-05-31
| | | | | | | | | | | | highlighting closes: vim/vim#16238 https://github.com/vim/vim/commit/5ddcecf05febcdd374f47bea856830c3b6d1bff8 Co-authored-by: Shougo Matsushita <Shougo.Matsu@gmail.com> Co-authored-by: Christian Brabandt <cb@256bit.org> Co-authored-by: h_east <h.east.727@gmail.com>
* vim-patch:6fea0a5: runtime(help): Add Vim lang annotation support for codeblocksbrianhuster2025-05-31
| | | | | | | | | closes: vim/vim#16215 https://github.com/vim/vim/commit/6fea0a54804fc36ab7138a66210b0eb380d96198 Co-authored-by: Shougo Matsushita <Shougo.Matsu@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com>
* vim-patch:0b540c6: runtime(help): add omni completion and 'iskeyword' to ↵Phạm Bình An2025-04-10
| | | | | | | | | | | | | | | | | | | | | | | | filetype plugin (#33398) Problem: - Help tags provide a good way to navigate the Vim documentation, but many help documents don't use them effectively. I think one of the reasons is that help writers have to look up help tags manually with `:help` command, which is not very convenient. - 'iskeyword' is only set for help buffers opened by `:help` command. That means if I'm editing a help file, I cannot jump to tag in same file using `Ctrl-]` unless I manually set it, which is annoying. Solution: - Add omni completion for Vim help tags. - Set 'iskeyword' for `ft-help` closes: vim/vim#17073 https://github.com/vim/vim/commit/0b540c6f381c63c2d80cc0aaef76b0df008b9f86 Co-authored-by: Christian Brabandt <cb@256bit.org>
* fix(docs): replace `yxx` mappings with `g==` #31947Evgeni Chasnovski2025-01-15
| | | | | | | | Problem: `yx` uses "y" prefix, which shadows a builtin operator. Solution: Use `g=` (in the form of `g==` currently), drawing from precedent of CTRL-= and 'tpope/vim-scriptease'.
* feat(docs): "yxx" runs Lua/Vimscript code examples #31904Riley Bruins2025-01-09
| | | | | `yxx` in Normal mode over a Lua or Vimscript code block section will execute the code. Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
* vim-patch:c9ec20d94ea5 (#28267)zeertzjq2024-04-11
| | | | | | | | | | | | | runtime(doc): Update documentation - Add security e-mail for private bugreports - Remove mentioning of the voting feature closes: vim/vim#14483 https://github.com/vim/vim/commit/c9ec20d94ea5c1ea263e70503e82abcdd27d3463 Co-authored-by: RestorerZ <restorer@mail2k.ru> Co-authored-by: Christian Brabandt <cb@256bit.org>
* docs: fix misparsed headings (#24162)Christian Clason2023-06-26
| | | | | | Problem: vimdoc parser requires space between column heading and `~`. Solution: Add space to docs (and mention it). Also edit `luaref.txt` headings for consistency.
* fix(docs): vimdoc syntax errorsJustin M. Keyes2023-06-25
| | | | gen_help_html: truncate parse-error sample text
* docs: small fixesdundargoc2023-05-13
| | | | | | | | | Co-authored-by: Christian Clason <c.clason@uni-graz.at> Co-authored-by: Gregory Anders <greg@gpanders.com> Co-authored-by: HiPhish <hiphish@posteo.de> Co-authored-by: Julio B <julio.bacel@gmail.com> Co-authored-by: T727 <74924917+T-727@users.noreply.github.com> Co-authored-by: camoz <camoz@users.noreply.github.com> Co-authored-by: champignoom <66909116+champignoom@users.noreply.github.com>
* docs: fix treesitter parsing errorsChristian Clason2023-01-01
|
* docs: fix/remove invalid URLs #20647Justin M. Keyes2022-10-14
|
* feat(gen_help_html.lua): adapt to new parserJustin M. Keyes2022-09-28
| | | | | - adapt to parser changes from https://github.com/vigoux/tree-sitter-vimdoc/pull/16 - numerous other generator improvements
* docs(helphelp): remove extra backtick interference (#17201)dundargoc2022-01-27
| | | | | An extra backtick was explicitly written to show what a backtick looked like, but it interferes with the syntax highlighting which thinks that it's a part of a concealed group and couples it with the wrong backtick.
* vim-patch:2f0936cb9a2e (#17007)Christian Clason2022-01-11
| | | | | | * vim-patch:2f0936cb9a2e Update runtime files https://github.com/vim/vim/commit/2f0936cb9a2eb026acac03e6a8fd0b2a5d97508b
* vim-patch:0e6adf8a29d5 (#16682)Christian Clason2021-12-16
| | | | Update runtime files https://github.com/vim/vim/commit/0e6adf8a29d5c2c96c42cc7157f71bf22c2ad471
* vim-patch:88a4205f1cfb (#16399)Christian Clason2021-11-22
| | | | Update runtime files https://github.com/vim/vim/commit/88a4205f1cfbdc328e987ab00521fc8a22447fc3
* vim-patch:519cc559b08b (#16340)Christian Clason2021-11-17
| | | | Update runtime files https://github.com/vim/vim/commit/519cc559b08b800edc429688aece7ad6a00d41eb
* docs: remove obsolete text on language #15875dundargoc2021-10-02
|
* doc: remove mentions of compile-time flags #14935cbarrete2021-07-07
| | | | Nvim always compiles everything in so those are useless at best and confusing at worst.
* vim-patch:7e6a515ed14eJan Edmund Lazo2021-05-01
| | | | | | | Update runtime files. https://github.com/vim/vim/commit/7e6a515ed14e204fafb3dd6e98f2fb543e64aedd Omit vim9.
* vim-patch:4072ba571babJan Edmund Lazo2021-05-01
| | | | | | | | Update runtime files. https://github.com/vim/vim/commit/4072ba571babd733d1800c082416fe8fe3c28ed7 Omit vim9 references. Omit assert_fails(). Patch v8.2.1183 is not ported yet.
* vim-patch:1b884a005398Jan Edmund Lazo2021-05-01
| | | | | | | | Update runtime files. https://github.com/vim/vim/commit/1b884a0053982335f644eec6c71027706bf3c522 Omit doc/autocmd.txt. Omit tools/emoji_list.vim. Patch v8.2.1540 is not ported.
* vim-patch:e7b1ea0276ccJan Edmund Lazo2021-04-29
| | | | | Update runtime files. https://github.com/vim/vim/commit/e7b1ea0276cc83cd5c612f3189a174a60d57b5ed
* vim-patch:eab6dff19f38Jan Edmund Lazo2021-04-27
| | | | | | | Update runtime files https://github.com/vim/vim/commit/eab6dff19f387469a200011bc6cf3508f5e43a4a Omit de.po translations.
* vim-patch:96f45c0b6fc9Jan Edmund Lazo2021-04-27
| | | | | | | | Update runtime files https://github.com/vim/vim/commit/96f45c0b6fc9e9d404e6805593ed1e0e6795e470 Omit de.po changes. Same reason as before: too much and I don't understand the language.
* vim-patch:91f84f6e11cdJustin M. Keyes2018-10-29
| | | | | Update runtime files. https://github.com/vim/vim/commit/91f84f6e11cd879d43d651c0903d85bff95f0716
* vim-patch:3c2881dc1195Justin M. Keyes2017-11-07
| | | | | | Update runtime files. Add Rust support. https://github.com/vim/vim/commit/3c2881dc1195f53ebafc387378399ddd6cb677a7
* vim-patch:214641f77df6Justin M. Keyes2017-11-06
| | | | | | | | | Runtime file updates. https://github.com/vim/vim/commit/214641f77df6f318a4b3a0b09723c19859a103f4 N/A: vim-patch:26a280c47a1c
* help, man.vim: change "outline" map to gO (#7405)Justin M. Keyes2017-10-21
|
* doc: Replace hardcoded TOCs with <M-]> advice.Justin M. Keyes2017-05-01
|
* help, man.vim: "outline" (TOC) feature #5169Tommy Allen2017-05-01
|
* vim-patch:3df0173fa6d0Justin M. Keyes2017-05-01
| | | | | | Updated runtime files. https://github.com/vim/vim/commit/3df0173fa6d0418e89ef4e9c1d04a97c92eec27c
* doc: Replace "For Vim ... Last change ..." headers (#6328)Justin M. Keyes2017-03-21
|
* errors: Introduce "E856: Filename too long"Justin M. Keyes2017-01-23
|
* vim-patch:03413f4James McCoy2016-07-08
| | | | | | | | | | | | | Updated runtime files. https://github.com/vim/vim/commit/03413f44167c4b5cd0012def9bb331e2518c83cf Ignore changes to * doc/Makefile, doc/help.txt: Related to Vim's version8 documentation * doc/gui_x11.txt, doc/todo.txt, doc/vim.1, gvim.desktop, vim.desktop: Irrelevant to Neovim * doc/quickref.txt, doc/options.txt: As of yet unported 'emoji' * doc/tags, syntax/vim.vim: Generated at build time
* vim-patch:7db8f6fJames McCoy2016-07-08
| | | | | | | | | | | | Updated runtime files. https://github.com/vim/vim/commit/7db8f6f4f85e5d0526d23107b2a5e2334dc23354 Ignore changes to * doc/tags: Generated at build time * doc/channel.txt, doc/todo.txt: Irrelevant to Neovim * pack/dist/opt/matchit/doc/matchit.txt: matchit is enabled by default, so description of how to enable isn't needed.
generated by cgit (git 2.34.1) at 2026-10-19 19:58:55 +0000