document OGCAPI_HTML_TEMPLATE_DIRECTORY [build_translations]

Author: jmckenna

en/ogc/ogc_api.txt

@@ -9,7 +9,7 @@
 
 :Author:       Jeff McKenna
 :Contact:      jmckenna at gatewaygeomatics.com
-:Last Updated: 2025-11-19
+:Last Updated: 2025-12-12
 
 .. contents:: Table of Contents
     :depth: 3
@@ -104,10 +104,11 @@ Example 1. On Unix:
 ::
 
    $ ./mapserv -v
-   MapServer version 8.1-dev OUTPUT=PNG OUTPUT=JPEG OUTPUT=KML SUPPORTS=PROJ 
-   SUPPORTS=AGG SUPPORTS=FREETYPE SUPPORTS=CAIRO SUPPORTS=SVG_SYMBOLS SUPPORTS=RSVG 
-   SUPPORTS=ICONV SUPPORTS=FRIBIDI SUPPORTS=WMS_SERVER SUPPORTS=WMS_CLIENT 
-   SUPPORTS=WFS_SERVER SUPPORTS=WFS_CLIENT SUPPORTS=WCS_SERVER SUPPORTS=SOS_SERVER 
+   MapServer version 8.7-dev PROJ version 9.7 GDAL version 3.11 OUTPUT=PNG 
+   OUTPUT=JPEG OUTPUT=KML SUPPORTS=PROJ SUPPORTS=AGG SUPPORTS=FREETYPE 
+   SUPPORTS=CAIRO SUPPORTS=SVG_SYMBOLS SUPPORTS=RSVG SUPPORTS=ICONV 
+   SUPPORTS=FRIBIDI SUPPORTS=WMS_SERVER SUPPORTS=WMS_CLIENT SUPPORTS=WFS_SERVER 
+   SUPPORTS=WFS_CLIENT SUPPORTS=WCS_SERVER SUPPORTS=SOS_SERVER 
    SUPPORTS=OGCAPI_SERVER SUPPORTS=GEOS SUPPORTS=PBF INPUT=JPEG INPUT=POSTGIS 
    INPUT=OGR INPUT=GDAL INPUT=SHAPEFILE INPUT=FLATGEOBUF
 
@@ -116,13 +117,14 @@ Example 2. On Windows:
 ::
 
    C:\ms4w> mapserv -v
-   MapServer version 8.1.0-dev (MS4W 5.0.0-dev) OUTPUT=PNG OUTPUT=JPEG OUTPUT=KML 
-   SUPPORTS=PROJ SUPPORTS=AGG SUPPORTS=FREETYPE SUPPORTS=CAIRO 
-   SUPPORTS=SVG_SYMBOLS SUPPORTS=SVGCAIRO SUPPORTS=ICONV SUPPORTS=FRIBIDI 
-   SUPPORTS=WMS_SERVER SUPPORTS=WMS_CLIENT SUPPORTS=WFS_SERVER SUPPORTS=WFS_CLIENT 
-   SUPPORTS=WCS_SERVER SUPPORTS=SOS_SERVER SUPPORTS=OGCAPI_SERVER SUPPORTS=FASTCGI 
-   SUPPORTS=THREADS SUPPORTS=GEOS SUPPORTS=PBF INPUT=JPEG INPUT=POSTGIS INPUT=OGR 
-   INPUT=GDAL INPUT=SHAPEFILE INPUT=FLATGEOBUF 
+   MapServer version 8.7.0-dev (MS4W 5.2.0) PROJ version 9.8 
+   GDAL version 3.13 OUTPUT=PNG OUTPUT=JPEG OUTPUT=KML SUPPORTS=PROJ SUPPORTS=AGG 
+   SUPPORTS=FREETYPE SUPPORTS=CAIRO SUPPORTS=SVG_SYMBOLS SUPPORTS=SVGCAIRO 
+   SUPPORTS=ICONV SUPPORTS=FRIBIDI SUPPORTS=WMS_SERVER SUPPORTS=WMS_CLIENT 
+   SUPPORTS=WFS_SERVER SUPPORTS=WFS_CLIENT SUPPORTS=WCS_SERVER SUPPORTS=SOS_SERVER 
+   SUPPORTS=OGCAPI_SERVER SUPPORTS=FASTCGI SUPPORTS=THREADS SUPPORTS=GEOS 
+   SUPPORTS=PBF INPUT=JPEG INPUT=POSTGIS INPUT=OGR INPUT=GDAL INPUT=SHAPEFILE 
+   INPUT=FLATGEOBUF
 
 .. index:: 
    pair: WMS Server; Mapfile
@@ -141,6 +143,23 @@ mapfile such as::
     localdemo "/ms4w/apps/ogcapi-demo/ogcapi-demo.map"
   END
 
+You can also point to the location of the HTML templates to use for 
+`ogcapi?f=html` requests, by setting the `OGCAPI_HTML_TEMPLATE_DIRECTORY` 
+environment variable in your CONFIG file, such as::
+
+  ENV
+    #
+    # OGC API
+    #
+    OGCAPI_HTML_TEMPLATE_DIRECTORY "/ms4w/share/ogcapi/templates/html-bootstrap/"  
+  END
+
+.. NOTE::    
+   If the `OGCAPI_HTML_TEMPLATE_DIRECTORY` environment variable is not set, or 
+   the mapfile's WEB.METADATA parameter `oga_html_template_directory` is not set, 
+   then no HTML output will be generated (you may see a `"Template directory not 
+   set."` error message for `ogcapi?f=html` requests).    
+  
 .. TIP::
    For Ubuntu users, by default MapServer will install 
    a sample config file at */usr/local/etc/mapserver-sample.conf*, and you must 

en/optimization/environment_variables.txt

@@ -362,9 +362,9 @@ MS_OPENLAYERS_JS_URL
    pair: Environment variables; MS_TEMPPATH
 
 MS_TEMPPATH
-   Set the :ref:`WEB` `TEMPPATH`.
-
    .. versionadded:: 6.0
+   
+   Set the :ref:`WEB` `TEMPPATH`.
 
 .. index::
    pair: Environment variables; MS_XMLMAPFILE_XSLT
@@ -377,6 +377,32 @@ MS_XMLMAPFILE_XSLT
 
 .. index::
    pair: Environment variables; PROJ_DATA
+   
+.. index::
+   pair: Environment variables; OGCAPI_HTML_TEMPLATE_DIRECTORY
+
+OGCAPI_HTML_TEMPLATE_DIRECTORY
+   .. versionadded:: 8.0
+
+   The `OGCAPI_HTML_TEMPLATE_DIRECTORY` environment variable can be set 
+   to point to the template files to use for HTML output for the 
+   OGCAPI: Features service.
+
+   If this variable is not set, or the mapfile's WEB.METADATA parameter
+   `oga_html_template_directory` is not set, then no HTML output will be generated
+   (you may see a `"Template directory not set."` error message for `ogcapi?f=html`
+   requests).
+
+   Example CONFIG file contents::
+    
+    ENV
+      #
+      # OGC API
+      #
+      OGCAPI_HTML_TEMPLATE_DIRECTORY "/ms4w/share/ogcapi/templates/html-bootstrap/"  
+    END
+
+   .. seealso:: :ref:`ogcapi` & :ref:`rfc134`   
 
 PROJ_DATA
    The `PROJ_DATA` environment variable or `CONFIG` directive can be

requirements.txt

@@ -1,6 +1,6 @@
 alabaster==1.0.0
 docutils==0.22.3
-sphinx==9.0.1
+sphinx==9.0.4
 sphinx-copybutton==0.5.2
 sphinxcontrib-jquery==4.1
 --extra-index-url https://test.pypi.org/simple/