Skip to content

Commit 57a1e16

Browse files
authored
Merge pull request #1415 from ychin/docs-cleanup-more-details
Misc documentation updates and cleanups
2 parents 853a24e + 88ec365 commit 57a1e16

File tree

3 files changed

+26
-7
lines changed

3 files changed

+26
-7
lines changed

runtime/doc/gui_mac.txt

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Other relevant documentation:
2727

2828
{Vi does not have a GUI}
2929

30+
This manual is also available at https://macvim.org/docs/gui_mac.txt.html.
31+
3032
==============================================================================
3133
1. MacVim differences *macvim-differences*
3234

@@ -249,6 +251,9 @@ the open event the FTok and Burl parameters are parsed (the latter is ignored
249251
at the moment though). In the modified and closed events the Tokn parameter
250252
is sent back to the server application.
251253

254+
The ODB editor protocol is documented at:
255+
https://www.barebones.com/support/develop/odbsuite.html
256+
252257
==============================================================================
253258
3. Settings *macvim-prefs* *macvim-preferences* *macvim-settings*
254259

@@ -635,13 +640,14 @@ that items after it will be right-aligned, and is specified by names that
635640
begin with "-flexspace" and ends with "-".
636641

637642
*macvim-touchbar-icon*
638-
You can specify icons for Touch Bar buttons the same way for toolbar icons
639-
(see |macvim-toolbar-icon|). When a button has an icon, it won't show the menu
640-
name. Touch Bar icons should ideally be 36x36 pixels, and no larger than
641-
44x44 pixels. >
643+
You can specify icons for Touch Bar buttons the same way as toolbar icons,
644+
including using SF Symbols (see |macvim-toolbar-icon|). When a button has an
645+
icon, it won't show the menu name. Touch Bar icons should ideally be 36x36
646+
pixels, and no larger than 44x44 pixels. >
642647
:an icon=/home/foo/bar.png TouchBar.DoThing :echo 'Do'<CR>
643-
You can use any image for the icon, but macOS comes with a few default
644-
template images designed for use with Touch Bar. Some examples: >
648+
:an icon=gearshape.2 TouchBar.Setting <Nop>
649+
macOS also comes with a few default template images designed for use with
650+
Touch Bar. Some examples: >
645651
:an icon=NSTouchBarListViewTemplate TouchBar.ShowList :ls<CR>
646652
:an icon=NSTouchBarRefreshTemplate TouchBar.Refresh :e!<CR>
647653
<
@@ -721,7 +727,7 @@ outline.
721727
==============================================================================
722728
11. System services *macvim-services*
723729

724-
MacVim supports two system services. These can be accessed from the MacVim
730+
MacVim provides two system services. These can be accessed from the MacVim
725731
submenu in the Services menu or by right-clicking a selection. For services
726732
to work, MacVim.app should be located in the /Applications folder. (You might
727733
have to logout and then login again before macOS detects the MacVim services.)
@@ -735,6 +741,12 @@ These are the currently supported services:
735741
The services respect the "Open files from applications" setting in the general
736742
settings.
737743

744+
For the other direction, within MacVim, you can access system services
745+
associated with selected texts (e.g. opening a URL, converting between
746+
Traditional/Simplified Chinese, do a web search) by selecting them in visual
747+
mode and opening the "Services" submenu either by right-clicking on the text,
748+
or the top-level "MacVim" menu.
749+
738750
==============================================================================
739751
12. mvim:// URL handler *mvim://* *macvim-url-handler*
740752

runtime/doc/sponsor.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,12 @@ For the most recent information about sponsoring look on the Vim web site:
2020

2121
More explanations can be found in the |sponsor-faq|.
2222

23+
SPONSOR MACVIM DEVELOPMENT *macvim-sponsor*
24+
25+
If you would like to support MacVim development itself, visit:
26+
27+
https://github.com/sponsors/macvim-dev
28+
2329

2430
REGISTERED VIM USER *register*
2531

runtime/doc/tags

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8530,6 +8530,7 @@ macvim-services gui_mac.txt /*macvim-services*
85308530
macvim-settings gui_mac.txt /*macvim-settings*
85318531
macvim-shift-movement gui_mac.txt /*macvim-shift-movement*
85328532
macvim-shortcuts gui_mac.txt /*macvim-shortcuts*
8533+
macvim-sponsor sponsor.txt /*macvim-sponsor*
85338534
macvim-start gui_mac.txt /*macvim-start*
85348535
macvim-tablabel gui_mac.txt /*macvim-tablabel*
85358536
macvim-todo gui_mac.txt /*macvim-todo*

0 commit comments

Comments
 (0)