-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathweb.html
More file actions
429 lines (388 loc) · 21.6 KB
/
web.html
File metadata and controls
429 lines (388 loc) · 21.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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
<!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>WEB — 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="XML Mapfile support" href="xml_mapfile.html" />
<link rel="prev" title="Union Layer" href="union.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/mapfile/web.html"><img src="../_static/flagicons/ar.png" alt="ar" title="ar" border="0" /></a>
<a href="../de/mapfile/web.html"><img src="../_static/flagicons/de.png" alt="de" title="de" border="0" /></a>
<a href="../el/mapfile/web.html"><img src="../_static/flagicons/el.png" alt="el" title="el" border="0" /></a>
<a href="../es/mapfile/web.html"><img src="../_static/flagicons/es.png" alt="es" title="es" border="0" /></a>
<a href="../fr/mapfile/web.html"><img src="../_static/flagicons/fr.png" alt="fr" title="fr" border="0" /></a>
<a href="../id/mapfile/web.html"><img src="../_static/flagicons/id.png" alt="id" title="id" border="0" /></a>
<a href="../it/mapfile/web.html"><img src="../_static/flagicons/it.png" alt="it" title="it" border="0" /></a>
<a href="../ja/mapfile/web.html"><img src="../_static/flagicons/ja.png" alt="ja" title="ja" border="0" /></a>
<a href="../nl_NL/mapfile/web.html"><img src="../_static/flagicons/nl_NL.png" alt="nl_NL" title="nl_NL" border="0" /></a>
<a href="../pl/mapfile/web.html"><img src="../_static/flagicons/pl.png" alt="pl" title="pl" border="0" /></a>
<a href="../ru/mapfile/web.html"><img src="../_static/flagicons/ru.png" alt="ru" title="ru" border="0" /></a>
<a href="../sq/mapfile/web.html"><img src="../_static/flagicons/sq.png" alt="sq" title="sq" border="0" /></a>
<a href="../tr/mapfile/web.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="xml_mapfile.html" title="XML Mapfile support"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="union.html" title="Union Layer"
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="../documentation.html" >MapServer 8.6.2 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">Mapfile</a> »</li>
<li class="nav-item nav-item-this"><a href="">WEB</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="web">
<span id="index-0"></span><span id="id1"></span><h1>WEB<a class="headerlink" href="#web" title="Link to this heading">¶</a></h1>
<dl id="mapfile-web-browseformat">
<dt>BROWSEFORMAT [mime-type]</dt><dd><p>Format of the interface output, using MapServer CGI. <em>(added to MapServer 4.8.0)</em>
The default value is “text/html”. Example:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">BROWSEFORMAT</span> <span class="s">"image/svg+xml"</span>
</pre></div>
</div>
</dd>
</dl>
<dl class="simple" id="mapfile-web-empty">
<dt>EMPTY [url]</dt><dd><p>URL to forward users to if a query fails. If not defined the value for
ERROR is used.</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-error">
<dt>ERROR [url]</dt><dd><p>URL to forward users to if an error occurs. Ugly old MapServer error
messages will appear if this is not defined</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-footer">
<dt>FOOTER [filename]</dt><dd><p>Template to use AFTER anything else is sent. Multiresult query modes only.</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-header">
<dt>HEADER [filename]</dt><dd><p>Template to use BEFORE everything else has been sent. Multiresult query
modes only.</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-imagepath">
<dt>IMAGEPATH [path]</dt><dd><p>Path to the temporary directory for writing temporary files and images.
Must be writable by the user the web server is running as. Must end
with a / or depending on your platform.</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-imageurl">
<dt>IMAGEURL [path]</dt><dd><p>Base URL for IMAGEPATH. This is the URL that will take the web browser
to IMAGEPATH to get the images.</p>
</dd>
</dl>
<dl id="mapfile-web-legendformat">
<dt>LEGENDFORMAT [mime-type]</dt><dd><p>Format of the legend output, using MapServer CGI. <em>(added to MapServer 4.8.0)</em>
The default value is “text/html”. Example:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">LEGENDFORMAT</span> <span class="s">"image/svg+xml"</span>
</pre></div>
</div>
</dd>
</dl>
<dl id="mapfile-web-log">
<dt>LOG [filename]</dt><dd><div class="versionremoved">
<p><span class="versionmodified removed">Removed in version 8.0.</span></p>
</div>
<p>Since MapServer 5.0 the recommended parameters to use for debugging are the <a class="reference internal" href="map.html#map"><span class="std std-ref">MAP</span></a>
object’s CONFIG and DEBUG parameters instead (see the <a class="reference internal" href="../optimization/debugging.html#debugging"><span class="std std-ref">Debugging MapServer</span></a> document).</p>
<p>File to log MapServer activity in. Must be writable by the user the web
server is running as.</p>
</dd>
</dl>
<dl id="mapfile-web-maxscaledenom">
<dt>MAXSCALEDENOM [double]</dt><dd><p>Minimum scale at which this interface is valid. When a user requests a map
at a smaller scale, MapServer automatically returns the map at this scale.
This effectively prevents user from zooming too far out. Scale is given as
the denominator of the actual scale fraction, for example for a map at a
scale of 1:24,000 use 24000. Implemented in MapServer 5.0, to replace the
deprecated MAXSCALE parameter. Must be greater or equal to 0.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="../glossary.html#term-Map-Scale"><span class="xref std std-term">Map Scale</span></a></p>
</div>
</dd>
<dt>MAXSCALE [double]</dt><dd><div class="versionremoved">
<p><span class="versionmodified removed">Removed in version 8.0.</span></p>
</div>
<p>Since MapServer 5.0 the proper parameter to use is MAXSCALEDENOM instead.
The deprecated MAXSCALE is the minimum scale at which this interface is
valid. When a user requests a map at a smaller scale, MapServer automatically
returns the map at this scale. This effectively prevents user from zooming
too far out. Scale is given as the denominator of the actual scale
fraction, for example for a map at a scale of 1:24,000 use 24000.</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-maxtemplate">
<dt>MAXTEMPLATE [file|url]</dt><dd><p>Template to be used if below the minimum scale for the app (the
denominator of the requested scale is larger than MAXSCALEDENOM),
useful for nesting apps.</p>
</dd>
</dl>
<dl id="mapfile-web-metadata">
<dt>METADATA</dt><dd><p>This keyword allows for arbitrary data to be stored as name value pairs.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Runtime substitution can be used to replace metadata values, but not keys. See <a class="reference internal" href="../cgi/runsub.html#runsub"><span class="std std-ref">Run-time Substitution</span></a></p>
</div>
<ul>
<li><p>Used with OGC services (<a class="reference internal" href="../ogc/wms_server.html#wms-server"><span class="std std-ref">WMS Server</span></a>, <a class="reference internal" href="../ogc/wfs_server.html#wfs-server"><span class="std std-ref">WFS Server</span></a>,
<a class="reference internal" href="../ogc/wcs_server.html#wcs-server"><span class="std std-ref">WCS Server</span></a>, <a class="reference internal" href="../ogc/sos_server.html#sos-server"><span class="std std-ref">SOS Server</span></a>, …) to define things such
as layer title.</p></li>
<li><p>It can also allow more flexibility in creating templates, as
anything you put in here will be accessible via template tags.</p></li>
<li><p>If you have XMP support enabled, you can also embed
<a class="reference internal" href="xmp_metadata.html#xmp-metadata"><span class="std std-ref">XMP Metadata Support</span></a> in your output images by specifying XMP tag
information here. Example:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">METADATA</span>
<span class="k">title</span> <span class="s">"My layer title"</span>
<span class="k">author</span> <span class="s">"Me!"</span>
<span class="err">xmp_dc_</span><span class="k">Title</span> <span class="s">"My Map Title"</span>
<span class="k">END</span>
</pre></div>
</div>
</li>
</ul>
<ul id="index-1">
<li><p><strong>labelcache_map_edge_buffer</strong></p>
<p>For tiling, the amount of gutter
around an image where no labels are to be placed is controlled
by the parameter <cite>labelcache_map_edge_buffer</cite>. The unit is
pixels. The value had to be a negative value for 6.0 and
earlier versions. From 6.2 the absolute value is taken, so the
sign does not matter.</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">METADATA</span>
<span class="s">"labelcache_map_edge_buffer"</span> <span class="s">"10"</span>
<span class="k">END</span>
</pre></div>
</div>
</li>
</ul>
<ul id="index-2">
<li><p><strong>ms_enable_modes</strong></p>
<p>Enable / disable modes (see <a class="reference internal" href="../development/rfc/ms-rfc-90.html#rfc90"><span class="std std-ref">MS RFC 90: Enable/Disable Layers in OGC Web Services by IP Lists</span></a>).</p>
<p>Use the asterisk “*” to specify all modes and a preceding
exclamation sign “!” to negate the given condition</p>
<p>To disable all CGI modes:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">METADATA</span>
<span class="s">"ms_enable_modes"</span> <span class="s">"!*"</span>
<span class="k">END</span>
</pre></div>
</div>
<p>To disable everything but MAP and LEGEND:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">METADATA</span>
<span class="s">"ms_enable_modes"</span> <span class="s">"!* MAP LEGEND"</span>
<span class="k">END</span>
</pre></div>
</div>
</li>
<li><p><strong>tile_map_edge_buffer</strong></p>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 6.0.</span></p>
</div>
<p>For <em>mode=tile</em>, renders the tile into a buffered rendering frame, then
clips out the final tile. This will reduce edge effects when large symbols or
wide lines are drawn. Recommended value: the size of the largest symbol or line
width in your mapfile.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="../output/tile_mode.html#tile-mode"><span class="std std-ref">Tile Mode</span></a></p>
</div>
</li>
<li><p><strong>tile_metatile_level</strong></p>
<div class="versionadded">
<p><span class="versionmodified added">Added in version 6.0.</span></p>
</div>
<p>For <em>mode=tile</em>, renders the tiles into a fixed metatile, then clips out
the final tile. This will reduce label repetition, at the expense of much higher
rendering cost. Recommended value: 1 if you are doing labelling of large features
in your layer. 0 otherwise.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="../output/tile_mode.html#tile-mode"><span class="std std-ref">Tile Mode</span></a></p>
</div>
</li>
</ul>
</dd>
</dl>
<dl id="mapfile-web-minscaledenom">
<dt>MINSCALEDENOM [double]</dt><dd><p>Maximum scale at which this interface is valid. When a user requests a
map at a larger scale, MapServer automatically returns the map at this
scale. This effectively prevents the user from zooming in too far.
Scale is given as the denominator of the actual scale fraction, for example
for a map at a scale of 1:24,000 use 24000. Implemented in MapServer 5.0, to
replace the deprecated MINSCALE parameter. Must be greater or equal to 0.</p>
<div class="admonition seealso">
<p class="admonition-title">See also</p>
<p><a class="reference internal" href="../glossary.html#term-Map-Scale"><span class="xref std std-term">Map Scale</span></a></p>
</div>
</dd>
<dt>MINSCALE [double]</dt><dd><div class="versionremoved">
<p><span class="versionmodified removed">Removed in version 8.0.</span></p>
</div>
<p>Since MapServer 5.0 the proper parameter to use is MINSCALEDENOM
instead. The deprecated MINSCALE is the maximum scale at which this
interface is valid. When a user requests a map at a larger scale, MapServer
automatically returns the map at this scale. This effectively prevents the
user from zooming in too far. Scale is given as the denominator of the
actual scale fraction, for example for a map at a scale of 1:24,000 use
24000.</p>
</dd>
</dl>
<dl class="simple" id="mapfile-web-mintemplate">
<dt>MINTEMPLATE [file|url]</dt><dd><p>Template to be used if above the maximum scale for the app (the
denominator of the requested scale is smaller than MINSCALEDENOM),
useful for nesting apps.</p>
</dd>
</dl>
<dl id="mapfile-web-queryformat">
<dt>QUERYFORMAT [mime-type]</dt><dd><p>Format of the query output. <em>(added to MapServer 4.8.0)</em> This works for
mode=query (using query templates in CGI mode), but not for mode=browse.
The default value is “text/html”. Example:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">QUERYFORMAT</span> <span class="s">"image/svg+xml"</span>
</pre></div>
</div>
</dd>
</dl>
<p id="mapfile-web-template">TEMPLATE [filename|url]</p>
<blockquote>
<div><p>Template file or URL to use in presenting the results to the user
in an interactive mode (i.e. map generates map and so on … ).</p>
<p>URL is not a remote file, rather a template. For example:</p>
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="k">TEMPLATE</span> <span class="s">'http://someurl/somescript.cgi?mapext=[mapext]'</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This attribute can be replaced using runtime substitution. See <a class="reference internal" href="../cgi/runsub.html#runsub"><span class="std std-ref">Run-time Substitution</span></a>.</p>
</div>
</div></blockquote>
<span id="mapfile-web-temppath"></span><span id="index-4"></span><span id="index-3"></span><dl id="index-5">
<dt>TEMPPATH [path]</dt><dd><div class="versionadded">
<p><span class="versionmodified added">Added in version 6.0.</span></p>
</div>
<p>Path for storing temporary files. If not set, the standard system
temporary file path will be used (e.g. tmp for unix). <cite>TEMPPATH</cite>
can also be set using the environment variable <cite>MS_TEMPPATH</cite>.</p>
<p><cite>TEMPPATH</cite> is used in many contexts (see rfc66).</p>
<p>Make sure that that MapServer has sufficient rights to read and
write files at the specified location.</p>
</dd>
</dl>
<dl id="mapfile-web-validation">
<dt><a class="reference internal" href="validation.html#validation"><span class="std std-ref">VALIDATION</span></a></dt><dd><p>Signals the start of a <a class="reference internal" href="validation.html#validation"><span class="std std-ref">VALIDATION</span></a> block.</p>
<p>As of MapServer 5.4.0, <cite>VALIDATION</cite> blocks are the preferred
mechanism for specifying validation patterns for CGI param runtime
substitutions. See <a class="reference internal" href="../cgi/runsub.html#runsub"><span class="std std-ref">Run-time Substitution</span></a>.</p>
</dd>
</dl>
</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="../development/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>
</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="xml_mapfile.html" title="XML Mapfile support"
>next</a> |</li>
<li class="right" >
<a href="union.html" title="Union Layer"
>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="../documentation.html" >MapServer 8.6.2 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >Mapfile</a> »</li>
<li class="nav-item nav-item-this"><a href="">WEB</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
Last updated on 2026-04-20.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
</html>