patch 7.4.1649
Problem: The matchit plugin needs to be copied to be used.
Solution: Put the matchit plugin in an optional package.
diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt
index f71cf42..b36f91f 100644
--- a/runtime/doc/usr_05.txt
+++ b/runtime/doc/usr_05.txt
@@ -1,4 +1,4 @@
-*usr_05.txt* For Vim version 7.4. Last change: 2012 Nov 20
+*usr_05.txt* For Vim version 7.4. Last change: 2016 Mar 25
VIM USER MANUAL - by Bram Moolenaar
@@ -12,10 +12,11 @@
|05.1| The vimrc file
|05.2| The example vimrc file explained
|05.3| Simple mappings
-|05.4| Adding a plugin
-|05.5| Adding a help file
-|05.6| The option window
-|05.7| Often used options
+|05.4| Adding a package
+|05.5| Adding a plugin
+|05.6| Adding a help file
+|05.7| The option window
+|05.8| Often used options
Next chapter: |usr_06.txt| Using syntax highlighting
Previous chapter: |usr_04.txt| Making small changes
@@ -263,7 +264,46 @@
least the ones for Normal mode. More about mappings in section |40.1|.
==============================================================================
-*05.4* Adding a plugin *add-plugin* *plugin*
+*05.4* Adding a package *add-package* *matchit-install*
+
+A package is a set of files that you can add to Vim. There are two kinds of
+packages: optional and automatically loaded on startup.
+
+The Vim distribution comes with a few packages that you can optionally use.
+For example, the matchit plugin. This plugin makes the "%" command jump to
+matching HTML tags, if/else/endif in Vim scripts, etc. Very useful, although
+it's not backwards compatible (that's why it is not enabled by default).
+
+To start using the matchit plugin, add one line to your vimrc file: >
+ packadd matchit
+
+That's all! You can also type the command to try it out. Now you can find
+help about this plugin: >
+ :help matchit
+
+This works, because when `:packadd` loaded the plugin it also added the
+package directory in 'runtimepath', so that the help file can be found.
+
+You can find packages on the Internet in various places. It usually comes as
+an archive or as a repository. For an archive you can follow these steps:
+ 1. create the package directory: >
+ mkdir -p ~/.vim/pack/fancy
+< "fancy" can be any name of your liking. Use one that describes the
+ package.
+ 2. unpack the archive in that directory. This assumes the top
+ directory in the archive is "start": >
+ cd ~/.vim/pack/fancy
+ unzip /tmp/fancy.zip
+< If the archive layout is different make sure that you end up with a
+ path like this:
+ ~/.vim/pack/fancy/start/fancytext/plugin/fancy.vim ~
+ Here "fancytext" is the name of the package, it can be anything
+ else.
+
+More information about packages can be found here: |packages|.
+
+==============================================================================
+*05.5* Adding a plugin *add-plugin* *plugin*
Vim's functionality can be extended by adding plugins. A plugin is nothing
more than a Vim script file that is loaded automatically when Vim starts. You
@@ -415,23 +455,19 @@
|new-filetype| How to detect a new file type.
==============================================================================
-*05.5* Adding a help file *add-local-help* *matchit-install*
+*05.6* Adding a help file *add-local-help*
If you are lucky, the plugin you installed also comes with a help file. We
will explain how to install the help file, so that you can easily find help
for your new plugin.
- Let us use the "matchit.vim" plugin as an example (it is included with
-Vim). This plugin makes the "%" command jump to matching HTML tags,
-if/else/endif in Vim scripts, etc. Very useful, although it's not backwards
-compatible (that's why it is not enabled by default).
- This plugin comes with documentation: "matchit.txt". Let's first copy the
-plugin to the right directory. This time we will do it from inside Vim, so
-that we can use $VIMRUNTIME. (You may skip some of the "mkdir" commands if
-you already have the directory.) >
+ Let us use the "doit.vim" plugin as an example. This plugin comes with
+documentation: "doit.txt". Let's first copy the plugin to the right
+directory. This time we will do it from inside Vim. (You may skip some of
+the "mkdir" commands if you already have the directory.) >
:!mkdir ~/.vim
:!mkdir ~/.vim/plugin
- :!cp $VIMRUNTIME/macros/matchit.vim ~/.vim/plugin
+ :!cp /tmp/doit.vim ~/.vim/plugin
The "cp" command is for Unix, on MS-DOS you can use "copy".
@@ -441,7 +477,7 @@
Copy the help file to the "doc" directory. >
- :!cp $VIMRUNTIME/macros/matchit.txt ~/.vim/doc
+ :!cp /tmp/doit.txt ~/.vim/doc
Now comes the trick, which allows you to jump to the subjects in the new help
file: Generate the local tags file with the |:helptags| command. >
@@ -450,10 +486,10 @@
Now you can use the >
- :help g%
+ :help doit
-command to find help for "g%" in the help file you just added. You can see an
-entry for the local help file when you do: >
+command to find help for "doit" in the help file you just added. You can see
+an entry for the local help file when you do: >
:help local-additions
@@ -464,7 +500,7 @@
For writing a local help file, see |write-local-help|.
==============================================================================
-*05.6* The option window
+*05.7* The option window
If you are looking for an option that does what you want, you can search in
the help files here: |options|. Another way is by using this command: >
@@ -503,7 +539,7 @@
from the window border where scrolling starts.
==============================================================================
-*05.7* Often used options
+*05.8* Often used options
There are an awful lot of options. Most of them you will hardly ever use.
Some of the more useful ones will be mentioned here. Don't forget you can
diff --git a/runtime/doc/usr_toc.txt b/runtime/doc/usr_toc.txt
index d98a999..b0dc939 100644
--- a/runtime/doc/usr_toc.txt
+++ b/runtime/doc/usr_toc.txt
@@ -1,4 +1,4 @@
-*usr_toc.txt* For Vim version 7.4. Last change: 2010 Jul 20
+*usr_toc.txt* For Vim version 7.4. Last change: 2016 Mar 25
VIM USER MANUAL - by Bram Moolenaar
@@ -104,10 +104,11 @@
|05.1| The vimrc file
|05.2| The example vimrc file explained
|05.3| Simple mappings
- |05.4| Adding a plugin
- |05.5| Adding a help file
- |05.6| The option window
- |05.7| Often used options
+ |05.4| Adding a package
+ |05.5| Adding a plugin
+ |05.6| Adding a help file
+ |05.7| The option window
+ |05.8| Often used options
|usr_06.txt| Using syntax highlighting
|06.1| Switching it on
diff --git a/runtime/macros/README.txt b/runtime/macros/README.txt
index ce61cd3..f599c0a 100644
--- a/runtime/macros/README.txt
+++ b/runtime/macros/README.txt
@@ -15,8 +15,6 @@
justify.vim user function for justifying text
-matchit.vim + matchit.txt make % match if-fi, HTML tags, and much more
-
less.sh + less.vim make Vim work like less (or more)
shellmenu.vim menus for editing shell scripts in the GUI version
@@ -26,5 +24,9 @@
editexisting.vim when editing a file that is already edited with
another Vim instance
-This one is only for Unix. It can be found in the extra archive:
+This one is only for Unix.
file_select.vim macros that make a handy file selector
+
+The matchit plugin has been moved to an optional package. To load it put this
+line in your vimrc file:
+ :packadd matchit
diff --git a/runtime/macros/matchit.txt b/runtime/pack/dist/opt/matchit/doc/matchit.txt
similarity index 100%
rename from runtime/macros/matchit.txt
rename to runtime/pack/dist/opt/matchit/doc/matchit.txt
diff --git a/runtime/pack/dist/opt/matchit/doc/tags b/runtime/pack/dist/opt/matchit/doc/tags
new file mode 100644
index 0000000..4ccdc87
--- /dev/null
+++ b/runtime/pack/dist/opt/matchit/doc/tags
@@ -0,0 +1,50 @@
+:MatchDebug matchit.txt /*:MatchDebug*
+MatchError matchit.txt /*MatchError*
+[% matchit.txt /*[%*
+]% matchit.txt /*]%*
+b:match_col matchit.txt /*b:match_col*
+b:match_debug matchit.txt /*b:match_debug*
+b:match_ignorecase matchit.txt /*b:match_ignorecase*
+b:match_ini matchit.txt /*b:match_ini*
+b:match_iniBR matchit.txt /*b:match_iniBR*
+b:match_match matchit.txt /*b:match_match*
+b:match_pat matchit.txt /*b:match_pat*
+b:match_skip matchit.txt /*b:match_skip*
+b:match_table matchit.txt /*b:match_table*
+b:match_tail matchit.txt /*b:match_tail*
+b:match_wholeBR matchit.txt /*b:match_wholeBR*
+b:match_word matchit.txt /*b:match_word*
+b:match_words matchit.txt /*b:match_words*
+g% matchit.txt /*g%*
+matchit matchit.txt /*matchit*
+matchit-% matchit.txt /*matchit-%*
+matchit-\1 matchit.txt /*matchit-\\1*
+matchit-activate matchit.txt /*matchit-activate*
+matchit-backref matchit.txt /*matchit-backref*
+matchit-bugs matchit.txt /*matchit-bugs*
+matchit-choose matchit.txt /*matchit-choose*
+matchit-configure matchit.txt /*matchit-configure*
+matchit-debug matchit.txt /*matchit-debug*
+matchit-details matchit.txt /*matchit-details*
+matchit-highlight matchit.txt /*matchit-highlight*
+matchit-hl matchit.txt /*matchit-hl*
+matchit-intro matchit.txt /*matchit-intro*
+matchit-languages matchit.txt /*matchit-languages*
+matchit-modes matchit.txt /*matchit-modes*
+matchit-newlang matchit.txt /*matchit-newlang*
+matchit-o_% matchit.txt /*matchit-o_%*
+matchit-parse matchit.txt /*matchit-parse*
+matchit-s:notend matchit.txt /*matchit-s:notend*
+matchit-s:sol matchit.txt /*matchit-s:sol*
+matchit-spaces matchit.txt /*matchit-spaces*
+matchit-troubleshoot matchit.txt /*matchit-troubleshoot*
+matchit-v_% matchit.txt /*matchit-v_%*
+matchit.txt matchit.txt /*matchit.txt*
+matchit.vim matchit.txt /*matchit.vim*
+o_[% matchit.txt /*o_[%*
+o_]% matchit.txt /*o_]%*
+o_g% matchit.txt /*o_g%*
+v_[% matchit.txt /*v_[%*
+v_]% matchit.txt /*v_]%*
+v_a% matchit.txt /*v_a%*
+v_g% matchit.txt /*v_g%*
diff --git a/runtime/macros/matchit.vim b/runtime/pack/dist/opt/matchit/plugin/matchit.vim
similarity index 100%
rename from runtime/macros/matchit.vim
rename to runtime/pack/dist/opt/matchit/plugin/matchit.vim
diff --git a/runtime/vimrc_example.vim b/runtime/vimrc_example.vim
index f75dee3..9cb66ee 100644
--- a/runtime/vimrc_example.vim
+++ b/runtime/vimrc_example.vim
@@ -1,7 +1,7 @@
" An example for a vimrc file.
"
" Maintainer: Bram Moolenaar <Bram@vim.org>
-" Last change: 2015 Mar 24
+" Last change: 2016 Mar 25
"
" To use it, copy it to
" for Unix and OS/2: ~/.vimrc
@@ -100,3 +100,10 @@
" compatible).
set langnoremap
endif
+
+
+" Add optional packages.
+"
+" The matchit plugin makes the % command work better, but it is not backwards
+" compatible.
+packadd matchit