-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathvim.html
More file actions
301 lines (259 loc) · 15.6 KB
/
vim.html
File metadata and controls
301 lines (259 loc) · 15.6 KB
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>VIM Syntax — MapServer 8.6.2 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx.css?v=48f05237" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/sphinx_collapse.css?v=226d88b4" />
<link rel="stylesheet" type="text/css" href="../../_static/custom.css?v=dd298242" />
<link rel="stylesheet" type="text/css" href="../../_static/ribbon.css?v=ea091bf4" />
<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=9a6d5eae"></script>
<script src="../../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=f281be69"></script>
<link rel="icon" href="../../_static/mapserver.ico"/>
<link rel="author" title="About these documents" href="../../about.html" />
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
<link rel="copyright" title="Copyright" href="../../copyright.html" />
<link rel="next" title="Project Steering Committee" href="../../psc.html" />
<link rel="prev" title="Emacs Syntax" href="emacs.html" />
</head><body>
<!-- for main branch only, do not backport this -->
<table width="100%" style="width: 100%; background-color: white;">
<tr>
<td rowspan="2" style="padding: 10px 0px 10px 10px;">
<a href="../../index.html" title="Home"><img src="../../_static/banner.png" alt="MapServer banner" border="0" /></a>
</td>
<td style="padding: 10px 10px 0px 0px; text-align: right; vertical-align: top;">
<a href="../../index.html" title="Home">Home</a> |
<a href="../../products.html" title="Products (MapServer core, MapCache, TinyOWS">Products</a> |
<a href="https://github.com/MapServer/MapServer/issues/" title="Issue Tracker (MapServer core)">Issue Tracker</a> |
<a href="../../community/service_providers.html" title="Professional Service Providers">Service Providers</a> |
<a href="../../faq.html" title="Frequently Asked Questions">FAQ</a> |
<a href="https://fosstodon.org/@mapserver" title="Mastodon" target="_blank">Mastodon</a> |
<a href="../../download.html" title="Download Source or Binaries">Download </a> |
<a class="badge" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KRJ2X44N3HA6U&source=url" target="_blank">
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate to MapServer">
</a>
</td>
</tr>
<tr>
<td style="padding: 0px 10px 0px 0px; text-align: right; vertical-align: bottom;">
<img src="../../_static/flagicons/en.png" alt="en" title="en" border="0" width="18px" height="13px"/>
<a href="../../ar/development/editing/vim.html"><img src="../../_static/flagicons/ar.png" alt="ar" title="ar" border="0" /></a>
<a href="../../de/development/editing/vim.html"><img src="../../_static/flagicons/de.png" alt="de" title="de" border="0" /></a>
<a href="../../el/development/editing/vim.html"><img src="../../_static/flagicons/el.png" alt="el" title="el" border="0" /></a>
<a href="../../es/development/editing/vim.html"><img src="../../_static/flagicons/es.png" alt="es" title="es" border="0" /></a>
<a href="../../fr/development/editing/vim.html"><img src="../../_static/flagicons/fr.png" alt="fr" title="fr" border="0" /></a>
<a href="../../id/development/editing/vim.html"><img src="../../_static/flagicons/id.png" alt="id" title="id" border="0" /></a>
<a href="../../it/development/editing/vim.html"><img src="../../_static/flagicons/it.png" alt="it" title="it" border="0" /></a>
<a href="../../ja/development/editing/vim.html"><img src="../../_static/flagicons/ja.png" alt="ja" title="ja" border="0" /></a>
<a href="../../nl_NL/development/editing/vim.html"><img src="../../_static/flagicons/nl_NL.png" alt="nl_NL" title="nl_NL" border="0" /></a>
<a href="../../pl/development/editing/vim.html"><img src="../../_static/flagicons/pl.png" alt="pl" title="pl" border="0" /></a>
<a href="../../ru/development/editing/vim.html"><img src="../../_static/flagicons/ru.png" alt="ru" title="ru" border="0" /></a>
<a href="../../sq/development/editing/vim.html"><img src="../../_static/flagicons/sq.png" alt="sq" title="sq" border="0" /></a>
<a href="../../tr/development/editing/vim.html"><img src="../../_static/flagicons/tr.png" alt="tr" title="tr" border="0" /></a>
</td>
</tr>
</table>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../psc.html" title="Project Steering Committee"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="emacs.html" title="Emacs Syntax"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Development</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Mapfile Editing</a> »</li>
<li class="nav-item nav-item-this"><a href="">VIM Syntax</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="vim-syntax">
<span id="vim"></span><h1><a class="toc-backref" href="#table-of-contents" role="doc-backlink">VIM Syntax</a><a class="headerlink" href="#vim-syntax" title="Link to this heading">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Author<span class="colon">:</span></dt>
<dd class="field-odd"><p>Andreas Hirner</p>
</dd>
<dt class="field-even">Contact<span class="colon">:</span></dt>
<dd class="field-even"><p>andreas.hirner at dlr.de</p>
</dd>
<dt class="field-odd">Author<span class="colon">:</span></dt>
<dd class="field-odd"><p>Schuyler Erle</p>
</dd>
<dt class="field-even">Contact<span class="colon">:</span></dt>
<dd class="field-even"><p>schuyler at tridity.org</p>
</dd>
<dt class="field-odd">Last Updated<span class="colon">:</span></dt>
<dd class="field-odd"><p>2006-05-05</p>
</dd>
</dl>
<nav class="contents" id="table-of-contents">
<p class="topic-title">Table of Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#vim-syntax" id="id2">VIM Syntax</a></p>
<ul>
<li><p><a class="reference internal" href="#general-remarks" id="id3">General remarks</a></p></li>
<li><p><a class="reference internal" href="#installation" id="id4">Installation</a></p></li>
<li><p><a class="reference internal" href="#folding" id="id5">Folding</a></p></li>
<li><p><a class="reference internal" href="#closing-remarks" id="id6">Closing Remarks</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="general-remarks">
<h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">General remarks</a><a class="headerlink" href="#general-remarks" title="Link to this heading">¶</a></h2>
<p>vi (vim) resides in: /usr/share/vim/current (vim_root).</p>
<p>Syntax definitions are in vim_root/syntax/*.vim files. Linking file types to
extensions is done in vim_root/ftdetect/*.vim. (The the star denotes the
extension and would be replaced with map to define highlighting of MapServer
config files).</p>
</section>
<section id="installation">
<h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">Installation</a><a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
<p>The installation process requires two steps:</p>
<ol class="arabic">
<li><p>Copy the <a class="reference external" href="../../_static/map.vim">map.vim</a> syntax file to the syntax directory</p>
<p>Copy map.vim to the vim syntax directory (on Suse: /usr/share/vim/current/syntax)</p>
</li>
<li><p>Register the syntax file in the custom filetype directory</p>
<p>If absent, create a new directory called ftdetect in vim_root (on Suse
Linux: /usr/share/vim/current). Create a new file called map.vim in
ftdetect according to the example shown below:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">" MapServer config file</span>
<span class="n">au</span> <span class="n">BufNewFile</span><span class="p">,</span><span class="n">BufRead</span> <span class="o">*.</span><span class="n">map</span> <span class="n">setf</span> <span class="nb">map</span>
</pre></div>
</div>
</li>
</ol>
<p>Now restart vim and open a map file ….</p>
</section>
<section id="folding">
<h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">Folding</a><a class="headerlink" href="#folding" title="Link to this heading">¶</a></h2>
<section id="introduction">
<h3>Introduction<a class="headerlink" href="#introduction" title="Link to this heading">¶</a></h3>
<p><a class="reference external" href="https://vimhelp.org/usr_28.txt.html#usr_28.txt">Vim code folding</a> can be an
extremely handy way to simplify the task of editing complex MapServer mapfiles
inside the Vim editor. A Vim command file called <a class="reference external" href="../../_static/map_fold.vim">map_fold.vim</a> is attached
to this document, which defines a folding mode for mapfiles.</p>
</section>
<section id="id1">
<h3>Installation<a class="headerlink" href="#id1" title="Link to this heading">¶</a></h3>
<p>In Vim 6, you can copy <em>map_fold.vim</em> as-is to your <em>$VIMROOT/ftplugin/</em>
directory, and it should more or less work.</p>
<p>To use locally, create a <em>~/.vim/ftplugin</em> directory, copy <em>map_fold.vim</em> to
it, and then add the following to your <em>~/.vimrc</em>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">autocmd</span> <span class="n">BufRead</span> <span class="o">*.</span><span class="n">map</span> <span class="nb">set</span> <span class="n">filetype</span><span class="o">=</span><span class="nb">map</span>
</pre></div>
</div>
<p><a class="reference external" href="../../_static/map_fold.vim">map_fold.vim</a> is totally compatible with the <a class="reference external" href="../../_static/map.vim">map.vim</a> syntax highlighter,
and their combined use is even recommended.</p>
</section>
<section id="use">
<h3>Use<a class="headerlink" href="#use" title="Link to this heading">¶</a></h3>
<p>The Vim <a class="reference external" href="http://www.vim.org/htmldoc/usr_28.html">folding tutorial</a> (at
least the first two or three sections) is highly recommended. The Vim <a class="reference external" href="http://www.vim.org/htmldoc/fold.html">folding
reference</a> may also be helpful.</p>
</section>
<section id="conclusion">
<h3>Conclusion<a class="headerlink" href="#conclusion" title="Link to this heading">¶</a></h3>
<p>Hope this helps! Please let me know if you find it useful, or if you find ways
to improve it. Thanks!</p>
</section>
</section>
<section id="closing-remarks">
<h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">Closing Remarks</a><a class="headerlink" href="#closing-remarks" title="Link to this heading">¶</a></h2>
<p>The keywords are based on the TextPad Symbol Map_40.syn file contributed by Christopher
Thorne, which can also be found on the MapServer utility page. I hope the file is
somehow useful to anybody out there. If there are any questions or suggestions,
please feel free to contact me.</p>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p>
<a href="../../about.html" title="About">About</a><br>
<a href="../../products.html" title="Products">Products</a><br>
<a href="../../community/index.html" title="Community">Community</a><br>
<a href="../index.html" title="Development">Development</a><br>
<a href="../../download.html" title="Downloads">Downloads</a><br>
<a href="../../documentation.html" title="Documentation">Documentation</a><br>
<a href="../../faq.html" title="FAQ">FAQ</a><br>
<a href="../../psc.html" title="PSC">PSC</a><br>
<a href="https://fosstodon.org/@mapserver" title="Mastodon">Mastodon</a>
</p>
<h3>Current Table Of Contents</h3>
<ul>
<li><a class="reference internal" href="#">VIM Syntax</a><ul>
<li><a class="reference internal" href="#general-remarks">General remarks</a></li>
<li><a class="reference internal" href="#installation">Installation</a></li>
<li><a class="reference internal" href="#folding">Folding</a><ul>
<li><a class="reference internal" href="#introduction">Introduction</a></li>
<li><a class="reference internal" href="#id1">Installation</a></li>
<li><a class="reference internal" href="#use">Use</a></li>
<li><a class="reference internal" href="#conclusion">Conclusion</a></li>
</ul>
</li>
<li><a class="reference internal" href="#closing-remarks">Closing Remarks</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../psc.html" title="Project Steering Committee"
>next</a> |</li>
<li class="right" >
<a href="emacs.html" title="Emacs Syntax"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../index.html" >Development</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >Mapfile Editing</a> »</li>
<li class="nav-item nav-item-this"><a href="">VIM Syntax</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
Last updated on 2026-05-01.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
</html>