Skip to content

Commit 4109a09

Browse files
committed
Clean up syntax / formatting / typos in MacVim docs
Add "MACVIM REFERENCE" to syntax rule to reflect the new header to make it look less weird. Also remove the "last changed date" header since I rarely update it and it's not particularly useful given how in MacVim the runtime is always bundled anyway. Also, when investigating using Neovim's treesitter vim docs generating tool for MacVim (to generate a web version of the documentation), found a few typos / formatting issues. Fix them here.
1 parent cbb385a commit 4109a09

File tree

2 files changed

+36
-33
lines changed

2 files changed

+36
-33
lines changed

runtime/doc/gui_mac.txt

+35-33
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*gui_mac.txt* Last change: 2023 Feb 7
1+
*gui_mac.txt*
22

33
MACVIM REFERENCE MANUAL
44

@@ -186,34 +186,36 @@ The advantage of using the latter method is that the settings relating to file
186186
opening in the settings panel are respected, and files open instantly if
187187
|Quickstart| is enabled.
188188

189-
Starting MacVim from a terminal~
189+
Starting MacVim from a terminal ~
190190

191-
*mvim* *macvim-PATH* *macvim-cmdline*
191+
*mvim* *macvim-cmdline*
192192
MacVim comes bundled with a shell script called "mvim" that can be used to
193193
launch MacVim from the terminal. It's located at: >
194194
/Applications/MacVim.app/Contents/bin/mvim
195-
195+
<
196+
*macvim-PATH*
196197
To be able to easily use it, put this folder in your path: >
197198
/Applications/MacVim.app/Contents/bin
198199
For example, if you use zsh, you can put the following in `~/.zprofile`: >
199200
export PATH="/Applications/MacVim.app/Contents/bin:$PATH"
200-
201+
<
201202
After that, type "mvim" to start MacVim from Terminal. >
202203
$ mvim
203204
You can also specify files to open with. >
204205
$ mvim file ...
205-
Also the bin folder has convenient scripts for diffing and opening file as the file is read-only. >
206+
Also the bin folder has convenient scripts for diffing and opening file as the
207+
file is read-only. >
206208
* Diff: mvimdiff
207209
* Read-only: mview
208-
210+
<
209211
You can still use the normal "vim", "vimdiff", and "view" commands if you want
210212
to use non-GUI Vim, and "gvim" to launch MacVim ("gvim" works the same way as
211213
"mvim").
212214

213-
Going from terminal to GUI mode~
215+
Going from terminal to GUI mode ~
214216

215217
Once in terminal Vim it is possible to start the MacVim GUI by using the
216-
following command (see |:gui|):
218+
following command (see |:gui|): >
217219
:gui [++opt] [+cmd] [-f|-b] [files...]
218220
Note: Forking ("-b") currently does not work.
219221

@@ -236,8 +238,8 @@ history as the window you just closed (however the next window you open will).
236238
For these reasons Quickstart is disabled by default.
237239

238240
*odbeditor* *external-editor*
239-
MacVim can act as an 'external editor' for macOS applications that support the
240-
ODB Editor Protocol (or the 'external editor' protocol). Each application has
241+
MacVim can act as an "external editor" for macOS applications that support the
242+
ODB Editor Protocol (or the "external editor" protocol). Each application has
241243
different ways of configuring this option, check the application's
242244
documentation. Once configured properly MacVim can be used to open files in
243245
such an application.
@@ -310,7 +312,7 @@ As an example, if you have more than one mouse button and would wish to free
310312
up Ctrl-click so you can bind it to something else, then the appropriate
311313
command is: >
312314
defaults write org.vim.MacVim MMTranslateCtrlClick 0
313-
315+
<
314316
If you wish to restore all user defaults to their starting values, open
315317
Terminal and type: >
316318
defaults delete org.vim.MacVim
@@ -387,7 +389,7 @@ a Cocoa application when it is not in focus.
387389

388390
*Colors.plist*
389391
Apart from the system colors, it is also possible to use the standard X11
390-
color names (see http://en.wikipedia.org/wiki/X11_color_names) which usually
392+
color names (see https://en.wikipedia.org/wiki/X11_color_names) which usually
391393
come in a file called "rgb.txt". MacVim does not have such a file, instead it
392394
keeps these colors in a dictionary called "Colors.plist". The key in this
393395
dictionary is the name of the color and the value is an RGB value on the form
@@ -416,16 +418,16 @@ highlight color when a window becomes inactive.
416418
==============================================================================
417419
6. Menus *macvim-menus*
418420

419-
Default Menus~
421+
Default Menus ~
420422

421423
See |macvim-default-menus|.
422424

423-
Icons~
425+
Icons ~
424426

425427
Unlike regular Vim, MacVim menus can be customized with an icon. Simply use
426428
the "icon=" parameter similar to toolbar. See |macvim-toolbar-icon| for usage.
427429

428-
Customization~
430+
Customization ~
429431

430432
Menus in macOS behave slightly different from other platforms. For that
431433
reason two new commands have been added to Vim. To understand what these
@@ -620,7 +622,7 @@ The separators work similar to how toolbars work: >
620622
:an TouchBar.-Sep- <Nop>
621623
:an TouchBar.-space1- <Nop>
622624
:an TouchBar.-flexspace2- <Nop>
623-
625+
<
624626
The first example is a Vim separator (see |menu-separator|) and injects a
625627
space between two buttons. The second creates a smaller space than a normal
626628
separator and are specified by names that begin with "-space" and ends with
@@ -668,7 +670,7 @@ ExitFullScreen |'fullscreen'| mode. To disable, add the following to
668670
and emojis in insert and terminal modes. To disable,
669671
add the following to your vimrc file: >
670672
let g:macvim_default_touchbar_characterpicker=0
671-
673+
<
672674
==============================================================================
673675
9. Looking up data *macvim-lookup*
674676

@@ -721,10 +723,10 @@ to work, MacVim.app should be located in the /Applications folder. (You might
721723
have to logout and then login again before macOS detects the MacVim services.)
722724

723725
These are the currently supported services:
724-
* New MacVim Buffer With Selection: Create a new buffer and paste the
725-
currently selected text.
726-
* New MacVim Buffer Here: Create a new buffer and set the current
727-
directory to the file or folder that is selected in the Finder.
726+
* `New MacVim Buffer With Selection`: Create a new buffer and paste the
727+
currently selected text.
728+
* `New MacVim Buffer Here`: Create a new buffer and set the current
729+
directory to the file or folder that is selected in the Finder.
728730

729731
The services respect the "Open files from applications" setting in the general
730732
settings.
@@ -733,8 +735,8 @@ settings.
733735
12. mvim:// URL handler *mvim://* *macvim-url-handler*
734736

735737
MacVim supports a custom URL handler for "mvim://" URLs. The handler is
736-
supposed to be compatible to TextMate's URL scheme as documented at >
737-
http://blog.macromates.com/2007/the-textmate-url-scheme/.
738+
supposed to be compatible to TextMate's URL scheme as documented at:
739+
https://macromates.com/blog/2007/the-textmate-url-scheme/
738740

739741
Currently, this means that the format is >
740742
mvim://open?<arguments>
@@ -753,7 +755,7 @@ characters to be encoded twice. For example, a space should be encoded into
753755
"%2520" instead of "%20". A file "/tmp/file name?.txt" would need the
754756
following link: >
755757
mvim://open?url=file:///tmp/file%2520name%253F.txt
756-
758+
<
757759
MacVim will try to be smart and detect cases where a user has erroneously only
758760
encoded once, but for best results use double-encoding as described above.
759761

@@ -777,7 +779,7 @@ Cmd-. Interrupt Vim. Unlike Ctrl-C which is sent as normal
777779

778780
*Cmd-`* *<D-`>*
779781
Cmd-` Cycle to the next window. On an American keyboard the
780-
`-key is located under the Esc-key. On European
782+
key "`" is located under the Esc-key. On European
781783
keyboards this key is often adjacent to the left
782784
Shift-key and it may be not even be marked with "`".
783785
This Cmd-key combination can only be unmapped via the
@@ -872,12 +874,12 @@ to the previous/next tab in normal mode: >
872874
873875
nmap <SwipeLeft> gT
874876
nmap <SwipeRight> gt
875-
877+
<
876878
As another example, here is how to switch buffers by swiping left/right: >
877879
878880
nmap <SwipeLeft> :bN<CR>
879881
nmap <SwipeRight> :bn<CR>
880-
882+
<
881883
See the section on |key-mapping| for more help on how to map keys.
882884

883885
==============================================================================
@@ -929,16 +931,16 @@ prominent bugs/missing features.
929931
then opened in Preview where it may be printed. See |hardcopy|.
930932

931933
General bugs and issues are tracked on Github. If you find new bugs or have
932-
feature requests then please file an issue there: >
934+
feature requests then please file an issue there:
933935
https://github.com/macvim-dev/macvim/issues
934936

935937
For general discussions, asking questions, you could use the Github
936-
discussions page: >
938+
discussions page:
937939
https://github.com/macvim-dev/macvim/discussions
938940

939941
There is also a vim_mac mailing list. You can also post your findings of bugs
940-
and issues there as well: *vim_mac_group* >
941-
http://groups.google.com/group/vim_mac
942+
and issues there as well: *vim_mac_group*
943+
https://groups.google.com/group/vim_mac
942944

943945
==============================================================================
944946
17. Hints *macvim-hints*
@@ -1017,7 +1019,7 @@ If you have not installed the "mvim" script in your path you can provide the
10171019
path to the Vim binary instead. Thus, if "MacVim.app" resides in the
10181020
Applications folder then you would use the following line: >
10191021
export EDITOR='/Applications/MacVim.app/Contents/MacOS/Vim -g -f'
1020-
1022+
<
10211023
Scenario: ~
10221024
You have set MacVim to open from an external program and when you finish
10231025
editing (by closing the MacVim window) you want the external program to regain

runtime/syntax/help.vim

+1
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ syn match helpNormal "|||"
4242
syn match helpNormal ":|vim:|" " for :help modeline
4343
syn match helpVim "\<Vim version [0-9][0-9.a-z]*"
4444
syn match helpVim "VIM REFERENCE.*"
45+
syn match helpVim "MACVIM REFERENCE.*"
4546
syn match helpOption "'[a-z]\{2,\}'"
4647
syn match helpOption "'t_..'"
4748
syn match helpNormal "'ab'"

0 commit comments

Comments
 (0)