view runtime/tutor/README.txt @ 33399:95db67c7b754 v9.0.1958

patch 9.0.1958: cannot complete option values Commit: https://github.com/vim/vim/commit/900894b09a95398dfc75599e9f0aa2ea25723384 Author: Yee Cheng Chin <ychin.git@gmail.com> Date: Fri Sep 29 20:42:32 2023 +0200 patch 9.0.1958: cannot complete option values Problem: cannot complete option values Solution: Add completion functions for several options Add cmdline tab-completion for setting string options Add tab-completion for setting string options on the cmdline using `:set=` (along with `:set+=` and `:set-=`). The existing tab completion for setting options currently only works when nothing is typed yet, and it only fills in with the existing value, e.g. when the user does `:set diffopt=<Tab>` it will be completed to `set diffopt=internal,filler,closeoff` and nothing else. This isn't too useful as a user usually wants auto-complete to suggest all the possible values, such as 'iblank', or 'algorithm:patience'. For set= and set+=, this adds a new optional callback function for each option that can be invoked when doing completion. This allows for each option to have control over how completion works. For example, in 'diffopt', it will suggest the default enumeration, but if `algorithm:` is selected, it will further suggest different algorithm types like 'meyers' and 'patience'. When using set=, the existing option value will be filled in as the first choice to preserve the existing behavior. When using set+= this won't happen as it doesn't make sense. For flag list options (e.g. 'mouse' and 'guioptions'), completion will take into account existing typed values (and in the case of set+=, the existing option value) to make sure it doesn't suggest duplicates. For set-=, there is a new `ExpandSettingSubtract` function which will handle flag list and comma-separated options smartly, by only suggesting values that currently exist in the option. Note that Vim has some existing code that adds special handling for 'filetype', 'syntax', and misc dir options like 'backupdir'. This change preserves them as they already work, instead of converting to the new callback API for each option. closes: #13182 Signed-off-by: Christian Brabandt <cb@256bit.org> Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
author Christian Brabandt <cb@256bit.org>
date Fri, 29 Sep 2023 20:45:04 +0200
parents ca8e754bdd53
children
line wrap: on
line source

Tutor is a "hands on" tutorial for new users of the Vim editor.

Most new users can get through it in less than one hour. The result
is that you can do a simple editing task using the Vim editor.

Tutor is a file that contains the tutorial lessons. You can simply
execute "vim tutor" and then follow the instructions in the lessons.
The lessons tell you to modify the file, so DON'T DO THIS ON YOUR
ORIGINAL COPY.

On Unix you can also use the "vimtutor" program.  It will make a
scratch copy of the tutor first.

I have considered adding more advanced lessons but have not found the
time. Please let me know how you like it and send any improvements you
make.

Bob Ware, Colorado School of Mines, Golden, Co 80401, USA
(303) 273-3987
bware@mines.colorado.edu bware@slate.mines.colorado.edu bware@mines.bitnet


Translation
-----------

The tutor.xx and tutor.xx.utf-8 files are translated files (where xx is the
language code).  The encoding of tutor.xx might be latin1 or other traditional
encoding.  If you don't need a translation with such traditional encoding,
you just need to prepare the tutor.xx.utf-8 file.
If you need another encoding, you can also prepare a file named tutor.xx.enc
(replace enc with the actual encoding name).  You might also need to adjust the
tutor.vim file.
The "make" command can be used for creating tutor.xx from tutor.xx.utf-8.
See the Makefile for detail.  (For some languages, tutor.xx.utf-8 is created
from tutor.xx for historical reasons.)

[This file was modified for Vim by Bram Moolenaar et al.]