Skip to content

Commit 3850efe

Browse files
author
MapServer deploybot
committed
update with results of commit MapServer/MapServer-documentation@fdf1a24
1 parent d8a2fc1 commit 3850efe

File tree

532 files changed

+2344
-1088
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

532 files changed

+2344
-1088
lines changed

MIGRATION_GUIDE.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1435,7 +1435,7 @@ <h3>Navigation</h3>
14351435
</div>
14361436
<div class="footer" role="contentinfo">
14371437
&#169; <a href="copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
1438-
Last updated on 2025-11-13.
1438+
Last updated on 2025-11-18.
14391439
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
14401440
</div>
14411441
</body>

_images/index-map-page.png

113 KB
Loading

_images/index-page.png

83.2 KB
Loading

_images/layer_classes.png

4.24 KB
Loading

_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ <h3>Navigation</h3>
159159
</div>
160160
<div class="footer" role="contentinfo">
161161
&#169; <a href="../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
162-
Last updated on 2025-11-13.
162+
Last updated on 2025-11-18.
163163
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
164164
</div>
165165
</body>

_modules/mapscript/mapscript.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5576,7 +5576,7 @@ <h3>Navigation</h3>
55765576
</div>
55775577
<div class="footer" role="contentinfo">
55785578
&#169; <a href="../../copyright.html">Copyright</a> 2025, Open Source Geospatial Foundation.
5579-
Last updated on 2025-11-13.
5579+
Last updated on 2025-11-18.
55805580
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
55815581
</div>
55825582
</body>

_sources/cgi/openlayers.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ which will return a built-in OpenLayers template.
1919
and in ticket `#3549 <https://github.com/MapServer/MapServer/issues/3549>`_
2020

2121
Up to the MapServer 8.4 release the OpenLayers Viewer was based on `OpenLayers 2 <https://openlayers.org/two/>`_.
22-
As of MapServer 8.6-dev the OpenLayers viewer was updated to work with `OpenLayers 10.5+ <https://openlayers.org/>`_.
22+
As of MapServer 8.6 the OpenLayers viewer was updated to work with `OpenLayers 10.5+ <https://openlayers.org/>`_.
2323
The MapServer CGI Layer, used by the viewer, can be see in
2424
the `OpenLayers examples <https://openlayers.org/en/latest/examples/mapserver-cgi.html>`_.
2525

_sources/development/rfc/ms-rfc-140.txt

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,44 @@
11
.. _rfc140:
22

33
================================================
4-
MS RFC 140: MapServer Homepage
4+
MS RFC 140: MapServer Index Page
55
================================================
66

77
:Author: Seth Girvin
88
9-
:Last Updated: 2025-05-09
9+
:Last Updated: 2025-17-10
1010
:Version: MapServer 8.6
11-
:Status: Draft
11+
:Status: Adopted
1212

1313
1. Overview
1414
===========
1515

16-
This RFC proposes adding functionality to MapServer for dynamically generating a homepage that lists all map services available in a given deployment.
16+
This RFC proposes adding functionality to MapServer for dynamically generating a index page that lists all map services available in a given deployment.
1717
This feature would enable the creation of pages like https://maps.isric.org/ directly from a MapServer deployment, without requiring
1818
additional scripting. While scripting can achieve this, integrating the capability into MapServer itself
1919
would offer greater convenience and maintainability.
2020

2121
With the introduction of the :ref:`CONFIG file <config>` in MapServer 8.0, it is now possible to centrally manage information about all Mapfiles in a deployment.
22-
This would ensure that the homepage remains automatically synchronised with both the CONFIG file and the capabilities of the Mapfiles it references.
22+
This would ensure that the index page remains automatically synchronised with both the CONFIG file and the capabilities of the Mapfiles it references.
2323

24-
The homepage would be a "superset" of all available Mapfiles in a MapServer deployment, as listed in the CONFIG file.
25-
Each individual Mapfile would still have its own OGC API landing page, so the homepage is best described as a directory of all landing pages.
24+
The index page would be a "superset" of all available Mapfiles in a MapServer deployment, as listed in the CONFIG file.
25+
Each individual Mapfile would still have its own OGC API landing page, so the index page is best described as a directory of all landing pages.
2626

2727
As most MapServer deployments will likely be serving out a combination of WxS and new OGC API services for some time to come,
2828
it will allow both types to be listed together.
2929

3030
2.1 Proposed Solution
3131
=====================
3232

33-
A new MapServer :ref:`CGI mode <cgi>` - ``mode=config`` will be added to allow details of the MapServer services to be returned. The ``MAPS`` block
34-
in the :ref:`CONFIG file <config>` will be read to return a list of available services. By default the homepage service will be disabled unless a new
35-
``ENV`` option ``MS_HOMEPAGE_TEMPLATE`` has been set. This should be set to a folder containing a ``homepage.html`` value. However if only JSON
36-
responses are required it can be set to any value to enable the homepage service.
33+
New MapServer functionality will be added to allow details of the MapServer services to be returned. The ``MAPS`` block
34+
in the :ref:`CONFIG file <config>` will be read to return a list of available services. By default the index page service will be disabled unless a new
35+
``ENV`` option ``MS_INDEX_TEMPLATE_DIRECTORY`` has been set. This should be set to a folder containing a ``landing.html`` value. However if only JSON
36+
responses are required it can be set to any value to enable the index page service.
3737

3838
.. code-block:: mapfile
3939

4040
ENV
41-
MS_HOMEPAGE_TEMPLATE_DIRECTORY "share/ogcapi/templates/homepage/" # REQUIRED
41+
MS_INDEX_TEMPLATE_DIRECTORY "/mapserver/share/ogcapi/templates/html-index-bootstrap/" # REQUIRED
4242
...
4343
END
4444
# Example MAPS block in the CONFIG file
@@ -55,19 +55,19 @@ Requests will look as follows:
5555
.. code-block:: bat
5656

5757
# example web requests
58-
# http://localhost/cgi-bin/mapserv.exe?mode=config&f=json
59-
# http://localhost/cgi-bin/mapserv.exe?mode=config&f=html
58+
# http://localhost/cgi-bin/mapserv.exe?f=json
59+
# http://localhost/cgi-bin/mapserv.exe?f=html
6060

6161
# from the command line
62-
mapserv -nh "QUERY_STRING=mode=config&f=json" -conf "/usr/local/etc/mapserver.conf"
63-
mapserv -nh "QUERY_STRING=mode=config&f=html" -conf "C:\MapServer\apps\mapserver.conf"
62+
mapserv -nh "QUERY_STRING=f=json" -conf "/usr/local/etc/mapserver.conf"
63+
mapserv -nh "QUERY_STRING=f=html" -conf "C:\MapServer\apps\mapserver.conf"
6464

6565
As the service returns JSON any client-side library can be used to render the output. However a default HTML template will be provided
6666
following the same approach as in OGC Features API.
6767

6868
.. note::
6969

70-
Even though the JSON format is based on the OGC API, the homepage JSON service will still be generated for a Mapfile even if it only supports
70+
Even though the JSON format is based on the OGC API, the index page JSON service will still be generated for a Mapfile even if it only supports
7171
older WxS services.
7272

7373
JSON Structure
@@ -104,7 +104,7 @@ https://demo.pygeoapi.io/api-catalog.json. An extract is shown below:
104104

105105
The api-catalog specification allows for an additional ``service-meta`` property *"used to link to additional metadata about the API,
106106
and is primarily intended for machine consumption."* This can be used to add any additional properties from Mapfiles
107-
required to generate a MapServer homepage. ``service-doc`` isn't mandatory property, so WxS service links can ignore this.
107+
required to generate a MapServer index page. ``service-doc`` isn't mandatory property, so WxS service links can ignore this.
108108

109109
An example of the proposed JSON and metadata is shown below:
110110

@@ -181,7 +181,7 @@ that the URLs will return valid XML if the Mapfile is not configured correctly.
181181

182182
This new feature will make services more discoverable, but with this comes the risk of leaking information.
183183
The service will be opt-in, and up to the administrators of the deployment if they want this information to be
184-
visible by setting the ``MS_HOMEPAGE_TEMPLATE_DIRECTORY`` value in the ``CONFIG`` file.
184+
visible by setting the ``MS_INDEX_TEMPLATE_DIRECTORY`` value in the ``CONFIG`` file.
185185

186186
2.5 MapScript
187187
=============
@@ -194,12 +194,7 @@ None of the current MapServer ``mode`` functionality is supported in MapScript,
194194

195195
This section contains notes from prototyping a possible solution. The final approach may differ.
196196

197-
A requests will be checked for ``mode=config`` in mapserv.c to return JSON and exit.
198-
A new mode will be added to ``mapservutil.c``
199-
200-
.. code-block:: c
201-
202-
static char *const modeStrings[23]
197+
Requests will be checked in mapserv.c to return JSON and exit.
203198

204199
To list services supported in a Mapfile ``msOWSRequestIsEnabled`` will be used:
205200

@@ -219,16 +214,17 @@ if ``ows_onlineresource`` (or ``wms_``, ``wfs_`` etc.) is not set.
219214
+ mapserv.c
220215
+ mapservutil.c
221216
+ mapserver.h
217+
+ mapserv-config.cpp
222218

223219
3.2 Ticket Reference
224220
--------------------
225221

226-
+ TODO
222+
+ https://github.com/MapServer/MapServer/pull/7350
227223

228224
3.3 Documentation
229225
-----------------
230226

231-
TODO
227+
See https://github.com/MapServer/MapServer-documentation/pull/1039
232228

233229
4. Voting History
234230
=================

_sources/mapfile/class.txt

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,10 +90,22 @@ EXPRESSION [string]
9090
.. note::
9191
|RUNSUB|
9292

93+
.. index::
94+
pair: CLASS; FALLBACK
95+
:name: mapfile-class-fallback
96+
97+
FALLBACK [true|false]
98+
.. versionadded:: 8.6
99+
100+
Specifies whether the class should act as a fallback class. Default is false.
101+
A fallback class is applied if and only if none of the previously
102+
defined classes has been applied. This is similar in concept to
103+
the :ref:`sld` ElseFilter.
104+
93105
.. index::
94106
pair: CLASS; GROUP
95107
:name: mapfile-class-group
96-
108+
97109
GROUP [string]
98110
Allows for grouping of classes. It is only used when a
99111
`CLASSGROUP` at the :ref:`LAYER` level is set. If the `CLASSGROUP`

_sources/mapfile/config.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@ A full sample config file is shown below:
151151
# MS_MAPFILE_PATTERN "\.map$"
152152
# MS_XMLMAPFILE_XSLT "/path/to/mapfile.xsl"
153153
# MS_MODE "BROWSE" # default mode for CGI calls
154-
# MS_OPENLAYERS_JS_URL "http://openlayers.org/api/OpenLayers.js"
154+
# MS_OPENLAYERS_CSS_URL "//mapserver.org/lib/10.4.0/ol-mapserver.css" # default value
155+
# MS_OPENLAYERS_JS_URL "//mapserver.org/lib/10.4.0/ol-mapserver.js" # default value
155156
# MS_TEMPPATH "/tmp"
156157
# MS_MAX_OPEN_FILES 200 # maximum number of open files allowed on Windows
157158
# MS_WMS_ERROR_STATUS_CODE "ON" # enable HTTP status code 4xx and 5xx in case of errors on WMS requests

0 commit comments

Comments
 (0)