Skip to content

Misc documentation updates and cleanups #1415

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2023
Merged

Misc documentation updates and cleanups #1415

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 19 additions & 7 deletions runtime/doc/gui_mac.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ Other relevant documentation:

{Vi does not have a GUI}

This manual is also available at https://macvim.org/docs/gui_mac.txt.html.

==============================================================================
1. MacVim differences *macvim-differences*

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

The ODB editor protocol is documented at:
https://www.barebones.com/support/develop/odbsuite.html

==============================================================================
3. Settings *macvim-prefs* *macvim-preferences* *macvim-settings*

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

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

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

For the other direction, within MacVim, you can access system services
associated with selected texts (e.g. opening a URL, converting between
Traditional/Simplified Chinese, do a web search) by selecting them in visual
mode and opening the "Services" submenu either by right-clicking on the text,
or the top-level "MacVim" menu.

==============================================================================
12. mvim:// URL handler *mvim://* *macvim-url-handler*

Expand Down
6 changes: 6 additions & 0 deletions runtime/doc/sponsor.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ For the most recent information about sponsoring look on the Vim web site:

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

SPONSOR MACVIM DEVELOPMENT *macvim-sponsor*

If you would like to support MacVim development itself, visit:

https://github.com/sponsors/macvim-dev


REGISTERED VIM USER *register*

Expand Down
1 change: 1 addition & 0 deletions runtime/doc/tags
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8530,6 +8530,7 @@ macvim-services gui_mac.txt /*macvim-services*
macvim-settings gui_mac.txt /*macvim-settings*
macvim-shift-movement gui_mac.txt /*macvim-shift-movement*
macvim-shortcuts gui_mac.txt /*macvim-shortcuts*
macvim-sponsor sponsor.txt /*macvim-sponsor*
macvim-start gui_mac.txt /*macvim-start*
macvim-tablabel gui_mac.txt /*macvim-tablabel*
macvim-todo gui_mac.txt /*macvim-todo*
Expand Down