summaryrefslogtreecommitdiffstats
path: root/README.txt
blob: c48e70819dd8750849dea7dd7b62a6fe1c474bdf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
Vim configuration files for Drupal developers

The files in this directory are designed to make it easier for Drupal developers
to edit files using vim.

The home page for this project is http://drupal.org/project/vimrc, and the main
documentation page is http://drupal.org/node/1389006. Once the project is
installed, you can read the local documentation from within vim with
        :help drupal

INSTALLATION WITH DRUSH

This is the recommended method. Drush will download this project to
~/.drush/vimrc (or to /usr/share/drush/commands/vimrc--see `drush help dl`).
Then the installation script will install Pathogen, if needed, and continue as
described below. You can install to another directory if you prefer. From a
command line,
        $ drush @none dl vimrc
        $ drush help vimrc-install
        $ drush -v vimrc-install <options>
If the drush version is at least 5.5, then the recommended plugins will be
installed in the bundle/ subdirectry of your vimfiles directory.

INSTALLATION WITH PATHOGEN

Pathogen (http://www.vim.org/scripts/script.php?script_id=2332) is a package
manager for vim. If you already have Pathogen installed, then put these files
wherever you like and add
        :call pathogen#infect('path/to/vimrc/bundle')
near the top of your vimrc file (~/.vim or $HOME\_vimrc on Windows). Another
option is to make a symbolic link to the bundle/ directory under your vimfiles
directory. Explicitly,
        $ mkdir ~/.vim/bundle
        $ ln -s path/to/vimrc/bundle/vim-plugin-for-drupal ~/.vim/bundle
In this case, add the line
        :call pathogen#infect()
to your vimrc file if it is not already there.

In either case, use the command
        :Helptags
to install the included help file.

For more details, see bundle/vim-plugin-for-drupal/doc/drupal.txt .

BASIC INSTALLATION (without pathogen)

Copy the files from the bundle/vim-plugin-for-drupal/ subdirectory into your
vimfiles directory.  For most users, your vimfiles directory is ~/.vim; on
Windows, it is ~\vimfiles by default.  From within vim, use

:help vimfiles

for details.  If you have downloaded these files as vimrc.tar.gz and your
vimfiles directory is ~/.vim, then this should work on UNIX-like systems:

$ cd ~/.vim
$ tar xzf path/to/vimrc.tar.gz --strip-components 3 \
  vimrc/bundle/vim-plugin-for-drupal

Note:  if there are filename conflicts, then tar will silently overwrite the
existing files.

When you are done, you should have the following directory structure inside your
vimfiles directory:

        autoload/drupal.vim
        compiler/coder.vim
        doc/drupal.txt
        ftdetect/drupal.vim
        ftplugin/drini.vim
        ftplugin/drupal.vim
        plugin/drupal.vim
        snipmate/drupal/php.snippets
        snipmate/drupal6/php.snippets
        snipmate/drupal7/php.snippets
        syntax/drini.vim
        syntax/drupal.vim
        tagfiles/drupal6.tags
        tagfiles/drupal7.tags
        tagfiles/drupal8.tags

In order to use the tags defined in the help file, start vim and do
        :helptags ~/.vim/doc
(assuming that the file is installed as ~/.vim/doc/drupal.txt).  See
        :help add-local-help
for details.  After this step, you should be able to read the documentation with
        :help drupal.txt

AUTOCOMPLETION IN .INFO FILES

The drini (DRupal INI) filetype is used for .info and similar files.  The
syntax/drini.vim included in this project defines keywords that can be
auto-completed using syntaxcomplete.vim, but this requires version 8.0 of that
script.  Version 7.0 is included in the vim 7.3 distribution (in the autoload/
directory) and is also available from
http://www.vim.org/scripts/script.php?script_id=3172 .  As of late 2011, the
only way to get version 8.0 is to patch version 7.0 with the patch at
http://drupal.org/node/1303122#comment-5213300 .

UPDATES AND SUPPORT

For the latest version of this project, see http://drupal.org/project/vimrc .
To file a bug report or feature request, see the corresponding issues queue:
http://drupal.org/project/issues/vimrc?status=All&categories=All

TROUBLESHOOTING

* If :help does not work:

If :help does not work in your installation of vim, you can find the official
vim documentation on-line at http://vimdoc.sourceforge.net/ .  It may be that
you have only a vim executable and not the "runtime" support files.

* If nothing works:

Some shared servers install a "tiny" version of Vim.  Many features of this
project will not work with such a version.  (See below for details.)  Check your
version of vim from a shell with

$ vim --version

The fourth line of output should tell you what sort of version you have.

It is possible to get a lot of the functionallity provided by the Drupal-Vim
plugins working with the tiny-vim by creating a vimrc file based on the contents
of the plugins.

* Creating the vimrc file

There are two methods to create the required vimrc file:

1) On Linux or Mac OS X, go to the directory where you have the files from this
project and from the subdirectory bundle/vim-plugin-for-drupal/ do

$ cat plugin/drupal.vim ftplugin/php_drupal.vim >> ~/.vimrc

This will add the contents of the two files to your vimrc file.
NOTE: Windows users should use ~\vimfiles instead of ~/.vimrc.  You will
probably need a method other than cat.

2) Create a vimrc file and add these two lines inside it:
        source path/to/vimrc/bundle/vim-plugin-for-drupal/plugin/drupal.vim
        source path/to/vimrc/bundle/vim-plugin-for-drupal/ftplugin/php_drupal.vim
NOTE: Where path/to/vimrc is where you extracted the contents of this project.

* Info on tiny-vim

You can find the original discussion here: http://drupal.org/node/1326562
This tiny-vim was found on a shared CentOS server and it identifies itself as:
========================================================================
VIM - Vi IMproved 7.0 (2006 May 7, compiled Mar 5 2011 21:36:07)
 Included patches: 1, 3-4, 7-9, 11, 13-17, 19-26, 29-31, 34-44, 47, 50-56,
58-64, 66-73, 75, 77-92, 94-107, 109, 202, 234-237
 Compiled by
 Tiny version without GUI.
...
========================================================================
Notice the fourth line!

Known to work on the tiny-vim are:
* Line numbers
* Multiple Undos
* Arrow keys are usable in Insert mode

Known NOT to work and their workarounds (if any):
* Vim Help, aka :help command. Luckily for us there is
http://vimdoc.sourceforge.net/
* Color/syntax highlighting
* Persistent Undo (introduced in Vim7.3, so a tiny 7.3 might have this feature)

Please help make this troubleshooting section better either by enriching it
yourself or by posting on the issue queue:
http://drupal.org/project/issues/vimrc.