1
- *helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 25
1
+ *helphelp.txt* For Vim version 9.1. Last change: 2024 Dec 26
2
2
3
3
4
4
VIM REFERENCE MANUAL by Bram Moolenaar
@@ -437,31 +437,24 @@ also implicitly stops the block of ex-commands before it. E.g. >
437
437
echo "Example"
438
438
endfunction
439
439
<
440
-
441
- To add annotation in the block, place the annotation (ex: "lua") after a
442
- greater than (>) character. E.g: >lua
443
- print("hello")
444
- <
445
- Note: uses lua syntax highlighting, if "lua" key is in
446
- | g:help_example_languages | .
447
-
448
- It's possible to add Vim syntax highlighting support to code examples.
449
- E.g: >vim
440
+ To enable syntax highlighting for a block of code, place a language name
441
+ annotation (e.g. "vim") after a greater than (>) character. E.g. >vim
450
442
function Example_Func()
451
443
echo "Example"
452
444
endfunction
453
445
<
454
446
*g:help_example_languages*
455
- If you want to change the syntax highlighting in the block, you can
456
- change it like this : >
457
- :let g:help_example_languages = #{ vim: ' vim', sh: ' bash' }
447
+ By default, help files only support Vim script highlighting. If you need
448
+ syntax highlighting for other languages, add to your | vimrc | : >
449
+ :let g:help_example_languages = { " vim": " vim", "sh": " bash" }
458
450
The key represents the annotation marker name, and the value is the 'syntax'
459
- name. By default, help files support only Vim script highlighting.
460
- Note: When setting "g:help_example_languages", if you do not include "vim"
461
- key, the Vim syntax highlighting will not be enabled. If you set it to an
451
+ name.
452
+
453
+ Note: If you do not include "vim" in "g:help_example_languages", its syntax
454
+ highlighting will not be enabled. If you set "g:help_example_languages" to an
462
455
empty value, syntax highlighting for embedded languages will be disabled.
463
456
464
- Further note: including arbitrary syntax languages into help files may not
457
+ Further note: Including arbitrary syntax languages into help files may not
465
458
always work perfectly, if the included 'syntax' script does not account for
466
459
such an import.
467
460
*help-notation*
@@ -481,15 +474,15 @@ You can find the details in $VIMRUNTIME/syntax/help.vim
481
474
GENDER NEUTRAL LANGUAGE
482
475
483
476
*gender-neutral* *inclusion*
484
- Vim is for everybody, no matter race, gender or anything. For new or updated
485
- help text, gender neutral language is recommended. Some of the help text is
486
- many years old and there is no need to change it. We do not make any
477
+ Vim is for everybody, no matter race, gender or anything. For new or updated
478
+ help text, gender neutral language is recommended. Some of the help text is
479
+ many years old and there is no need to change it. We do not make any
487
480
assumptions about the gender of the user, no matter how the text is phrased.
488
481
The goal is that the reader understands how Vim works, the exact wording is
489
482
secondary.
490
483
491
484
Many online technical style guides include sections about gender neutral
492
- language. Here are a few: >
485
+ language. Here are a few: >
493
486
494
487
https://developers.google.com/style/pronouns
495
488
https://techwhirl.com/gender-neutral-technical-writing/
0 commit comments