Skip to content

Commit 609edb8

Browse files
committed
minor formatting
1 parent e2152d8 commit 609edb8

File tree

15 files changed

+61
-55
lines changed

15 files changed

+61
-55
lines changed

en/cgi/openlayers.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@
77
MapServer OpenLayers Viewer
88
*****************************************************************************
99

10-
MapServer (since the 6.0 release) provides a simple, built-in method for testing a Mapfile
10+
MapServer (since the 6.0 release) provides a simple, built-in method for testing a mapfile
1111
using OpenLayers. This feature is for testing and development purposes
1212
only, and not for production or deploying full-featured sites. You
13-
can preview, test, and navigate a Mapfile by accessing a special URL
13+
can preview, test, and navigate a mapfile by accessing a special URL
1414
which will return a built-in OpenLayers template.
1515

1616
.. note:: This feature was discussed in
@@ -48,7 +48,7 @@ Here is a quick breakdown of that URL:
4848
layer=lakespy2
4949
layer=dlgstln2
5050

51-
When using the ``mode=browse`` MapServer will create an image on the server. By default this will be in the same folder as the Mapfile.
51+
When using the ``mode=browse`` MapServer will create an image on the server. By default this will be in the same folder as the mapfile.
5252
If this MapServer cannot write to this folder you will see an error similar to:
5353

5454
.. code-block:: bash
@@ -117,7 +117,7 @@ is restricted by setting the following two :ref:`environment_variables`:
117117
* ``MS_OPENLAYERS_JS_URL`` - the URL to the OpenLayers JavaScript library.
118118
* ``MS_OPENLAYERS_CSS_URL`` - the URL to the OpenLayers CSS file used for styling.
119119

120-
These variables can also be set in a Mapfile, for example to point to the full OpenLayers build on a CDN
120+
These variables can also be set in a mapfile, for example to point to the full OpenLayers build on a CDN
121121
(Content Delivery Network):
122122

123123
.. code-block:: mapfile

en/development/documentation.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
:Contact: hobu.inc at gmail.com
99
:Author: Jeff McKenna
1010
:Contact: jmckenna at gatewaygeomatics.com
11-
:Last Updated: 2024-07-09
11+
:Last Updated: 2025-06-27
1212

1313
.. contents:: Table of Contents
1414
:depth: 4
@@ -111,11 +111,12 @@ General Writing Guidelines
111111
--------------------------
112112

113113
* MapServer instead of mapserver, map server, Map Server, mapServer or
114-
map Server.
115-
* MapScript instead of mapscript, Mapscript, or map script.
116-
* PostGIS instead of postgis.
114+
map Server
115+
* MapScript instead of mapscript, Mapscript, or map script
116+
* mapfile instead of Mapfile, MapFile, or map file
117+
* PostGIS instead of postgis
117118
* GitHub instead of Github or github
118-
* HowTo instead of howto or HOWTO.
119+
* HowTo instead of howto or HOWTO
119120
* Email addresses should be manually spam protected:
120121

121122
::

en/glossary.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,9 @@
8989
Mapfile
9090
:ref:`Mapfile <mapfile>` is the declarative language that MapServer
9191
uses to define data connections, map styling, templating, and server
92-
directives. Its format is xml-like and hierarchical, with closing
93-
`END` tags, but the format is not xml.
92+
directives. It must be named with the `.map` extension, and its format
93+
is XML-like and hierarchical, with closing `END` tags, but the format is
94+
not XML.
9495

9596
MapScript
9697
:ref:`mapscript` is an alternative the the :ref:`cgi` application

en/input/raster.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ file is a tile of the larger raster mosaic available for display. The list of
250250
files forming a layer can be stored in a shapefile with polygons representing
251251
the footprint of each file, and the name of the files. This is called a
252252
'TILEINDEX' and works similarly to the same feature in vector layers. The result
253-
can be represented in the Mapfile as one layer, but MapServer will first scan
253+
can be represented in the mapfile as one layer, but MapServer will first scan
254254
the tile index, and ensure that only raster files overlapping the current
255255
display request will be opened.
256256

en/input/vector/mssql.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,8 +167,8 @@ For example:
167167
END
168168
...
169169

170-
The key ``mssql`` can then be used in any Mapfiles to refer to this DLL. Controlling which DLLs are loaded by MapServer
171-
in the ``CONFIG`` file prevents Mapfiles from loading potentially dangerous DLLs.
170+
The key ``mssql`` can then be used in any mapfile to refer to this DLL. Controlling which DLLs are loaded by MapServer
171+
in the ``CONFIG`` file prevents mapfiles from loading potentially dangerous DLLs.
172172

173173
Create MapServer Layer
174174
**********************

en/installation/iis.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Committee (PSC) member.
3737

3838
Which version should I download?
3939

40-
+ Unless you are using deprecated features in your Mapfiles you should download the latest stable release.
40+
+ Unless you are using deprecated features in your mapfiles you should download the latest stable release.
4141
+ Nearly all servers will now have a x64 (64-bit) architecture, so unless you are restricted to a win32 (32-bit) server
4242
download a x64 rather than a win32 release.
4343
+ Unless you have a good reason you should use the latest compiler version. MSVC 2022 means the binaries were compiled with
@@ -192,14 +192,14 @@ copied in:
192192
# point to the certs file for HTTPS access to OWS servers
193193
CURL_CA_BUNDLE "C:\MapServer\bin\curl\curl-ca-bundle.crt"
194194

195-
# to set a default Mapfile uncomment below
195+
# to set a default mapfile uncomment below
196196
# MS_MAPFILE "C:/MapServer/apps/test/test.map"
197197

198-
# to block MapServer from accesssing Mapfile by path uncomment below
198+
# to block MapServer from accesssing mapfile by path uncomment below
199199
# MS_MAP_NO_PATH TRUE
200200
END
201201

202-
# allow Mapfiles to be accessed by key
202+
# allow mapfiles to be accessed by key
203203
MAPS
204204
"test" "C:/MapServer/apps/tests/test.map"
205205
END
@@ -225,7 +225,7 @@ Alternatively it can beset from the command line with the following command:
225225
Setting up Applications
226226
-----------------------
227227

228-
MapServer applications consist of a Mapfile, and additional optional files for data, symbols, logs, and images. The same instance of MapServer
228+
MapServer applications consist of a mapfile, and additional optional files for data, symbols, logs, and images. The same instance of MapServer
229229
can be used to serve many applications. In this example we will create a new ``test`` subfolder for a test application in a ``C:\MapServer\apps`` folder.
230230

231231
.. code-block:: bat
@@ -283,7 +283,7 @@ You can set-up MapServer logging by adding the following lines to your ``MAP`` b
283283
DEBUG 5 # a value from 0 (OFF) to 5 (detailed)
284284
CONFIG "MS_ERRORFILE" "logs\ms.log"
285285

286-
The path to the log file is relative to the Mapfile, so in this example you need to create a new ``C:\MapServer\apps\test\logs`` folder:
286+
The path to the log file is relative to the mapfile, so in this example you need to create a new ``C:\MapServer\apps\test\logs`` folder:
287287

288288
.. code-block:: bat
289289

@@ -339,7 +339,7 @@ The ``MS_MAPFILE`` environment variable can be set to a default map as follows:
339339
You can make then make a request without the query string requiring ``map=C:/MapServer/apps/test/test.map``: http://localhost/mapserver/mapserv?SERVICE=WMS&VERSION=1.3.0&REQUEST=GetMap&LAYERS=country_bounds&STYLES=&CRS=EPSG:4326&BBOX=-180,-90,180,90&WIDTH=400&HEIGHT=300&FORMAT=image/png
340340

341341
In addition to this method the `URL Rewrite module <https://www.iis.net/downloads/microsoft/url-rewrite>`_
342-
can be used to set different Mapfiles dependent on query string parameters or domain names.
342+
can be used to set different mapfiles dependent on query string parameters or domain names.
343343

344344
Setting a Certificates File
345345
+++++++++++++++++++++++++++
@@ -356,7 +356,7 @@ See :ref:`wxs_secure` for further details.
356356
Securing MapServer in IIS
357357
--------------------------
358358

359-
MapServer has two environment variables that can be used to restrict which Mapfiles can be accessed.
359+
MapServer has two environment variables that can be used to restrict which mapfiles can be accessed.
360360

361361
.. note::
362362

@@ -369,7 +369,7 @@ be set to any value ("True" in this example) so that only the ``MS_MAPFILE`` env
369369

370370
%windir%\system32\inetsrv\appcmd.exe set config -section:system.webServer/fastCgi /+"[fullPath='C:\Mapserver\bin\mapserv.exe'].environmentVariables.[name='MS_MAP_NO_PATH',value='True']" /commit:apphost
371371

372-
``MS_MAP_PATTERN`` can be set to limit the folders from which Mapfiles can be accessed using a regular expression. For example to limit
372+
``MS_MAP_PATTERN`` can be set to limit the folders from which mapfiles can be accessed using a regular expression. For example to limit
373373
to the ``C:\MapServer\apps`` (note this path is case-sensitive) folder use the following regular expression: ``"^(C:)?\/MapServer\/apps\/((?!\.{2})[_A-Za-z0-9\-\.]+\/{1})*([_A-Za-z0-9\-\.]+\.(map))$"``
374374

375375
.. code-block:: bat
@@ -378,7 +378,7 @@ to the ``C:\MapServer\apps`` (note this path is case-sensitive) folder use the f
378378

379379
In addition to these methods IIS itself can be used to block or filter query string parameters. The
380380
`denyQueryStringSequences <https://docs.microsoft.com/en-us/iis/configuration/system.webserver/security/requestfiltering/denyquerystringsequences/>`_
381-
element can be set to block a Mapfile being set by a URL. Both `map=` and the encoded `map%3d` are blocked.
381+
element can be set to block a mapfile being set by a URL. Both `map=` and the encoded `map%3d` are blocked.
382382

383383

384384
.. code-block:: xml
@@ -430,7 +430,7 @@ Common error messages and how to resolve them are listed below.
430430

431431
msLoadMap(): Regular expression error. MS_DEFAULT_MAPFILE_PATTERN validation failed.
432432

433-
+ If the ``CONFIG`` file security regular expressions used to limit access to Mapfiles do not match the supplied Mapfile you will receive the following:
433+
+ If the ``CONFIG`` file security regular expressions used to limit access to mapfiles do not match the supplied mapfile you will receive the following:
434434

435435
.. code-block:: bat
436436

en/mapcache/dimensions.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ WMS layers in MapServer can support dimensions, see :ref:`WMS Dimension <wms_dim
2222
MapCache also supports dimensions for tilesets.
2323

2424
Storing separate tile caches for different dimensions has several practical use cases such as creating caches for different
25-
spatial boundaries, elevations, or time periods. It also provides a mechanism for dynamically switching Mapfiles based on a dimension value.
25+
spatial boundaries, elevations, or time periods. It also provides a mechanism for dynamically switching mapfiles based on a dimension value.
2626

2727
MapCache uses Dimensions to:
2828

@@ -122,7 +122,7 @@ Regex Dimensions
122122
An alternative to the hard-coded list of values is to use regular expressions.
123123

124124
The following example creates a MAPFILE dimension, for using the same MapCache tileset with different MapServer
125-
Mapfiles. The name of the Mapfiles need not be known to MapCache, and can therefore be created even after MapCache has been started.
125+
mapfiles. The name of the mapfiles need not be known to MapCache, and can therefore be created even after MapCache has been started.
126126

127127
When a user passes a `MAPFILE=/path/to/mapfile`, the string `/path/to/mapfile` is validated against
128128
the supplied (PCRE) regular expression. The one in this example allows a name composed of alphanumeric characters

en/mapfile/index.txt

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,17 @@
1111
:Contact: steve.lime at dnr.state.mn.us
1212
:Author: Jeff McKenna
1313
:Contact: jmckenna at gatewaygeomatics.com
14-
:Last Updated: 2025-06-04
14+
:Last Updated: 2025-06-27
1515

16-
The Mapfile is the heart of MapServer. It defines the relationships
16+
The mapfile is the heart of MapServer. It defines the relationships
1717
between objects, points MapServer to where data are located and
1818
defines how things are to be drawn.
1919

20-
The Mapfile consists of a :ref:`MAP` object, which has to start with
20+
The mapfile must have a `.map` extension or MapServer will not recognize
21+
it. (if you try with another file extension, MapServer will throw an error of
22+
*"Filename validation failed"*)
23+
24+
The mapfile consists of a :ref:`MAP` object, which has to start with
2125
the word `MAP`.
2226

2327
There are some important concepts that you must understand before you
@@ -77,10 +81,10 @@ styling using :ref:`CLASS` and :ref:`STYLE` directives.
7781
Notes
7882
-----------------------------------------------------------------------------
7983

80-
* The Mapfile is NOT case-sensitive.
84+
* The mapfile is NOT case-sensitive.
8185

82-
* The **Mapfile is read from top to bottom by MapServer**; this means
83-
that LAYERs near the top of your Mapfile will be drawn before those
86+
* The **mapfile is read from top to bottom by MapServer**; this means
87+
that LAYERs near the top of your mapfile will be drawn before those
8488
near the bottom. Therefore users commonly place background imagery
8589
and other background layer types near the top of their mapfile, and
8690
lines and points near the bottom of their mapfile.
@@ -89,7 +93,7 @@ Notes
8993
keyword MUST be quoted. It is recommended to put ALL strings in
9094
double-quotes.
9195

92-
* As of MapServer 7.0, Mapfiles are expected to be **UTF-8 encoded**.
96+
* As of MapServer 7.0, mapfiles are expected to be **UTF-8 encoded**.
9397
Non UTF-8 encoded mapfiles will need to be iconv’ed to UTF-8.
9498

9599
* For MapServer versions < 5, there was a default maximum of 200

en/mapfile/layer.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1726,7 +1726,7 @@ STYLEITEM [<attribute>|auto|<javascript file>|<sld file>]
17261726
.. versionadded:: 8.2.0
17271727

17281728
A path to an SLD file. The path mush start with the prefix **sld://**, and
1729-
can be a path relative to the Mapfile, or an absolute path.
1729+
can be a path relative to the mapfile, or an absolute path.
17301730
:ref:`CLASS` and :ref:`STYLE` blocks will then be generated based on the SLD document.
17311731

17321732
.. code-block:: mapfile

en/mapfile/symbology/examples.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
:Author: Jeff McKenna
1111
:Contact: jmckenna at gatewaygeomatics.com
1212
:Author: Håvard Tveite
13-
:Last Updated: 201-05-11
13+
:Last Updated: 2022-08-15
1414

1515
.. contents:: Table of Contents
1616
:depth: 2

0 commit comments

Comments
 (0)