Skip to content

Commit 3006a42

Browse files
author
MapServer deploybot
committed
update with results of commit MapServer/MapServer-documentation@fcb9a31
1 parent a997ba9 commit 3006a42

7,332 files changed

Lines changed: 8498 additions & 8106 deletions

File tree

Some content is hidden

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

MIGRATION_GUIDE.html

Lines changed: 49 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ <h3>Navigation</h3>
127127
<span id="migration"></span><h1><a class="toc-backref" href="#table-of-contents" role="doc-backlink">MapServer Migration Guide</a><a class="headerlink" href="#mapserver-migration-guide" title="Link to this heading"></a></h1>
128128
<dl class="field-list simple">
129129
<dt class="field-odd">Last Updated<span class="colon">:</span></dt>
130-
<dd class="field-odd"><p>2026-05-07</p>
130+
<dd class="field-odd"><p>2026-07-15</p>
131131
</dd>
132132
</dl>
133133
<nav class="contents" id="table-of-contents">
@@ -618,19 +618,19 @@ <h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">MapServ
618618
for each function that you require.</p></li>
619619
<li><p>all of your PHP scripts (that leverage MapServer objects and functions) must now always
620620
first include the generated <cite>mapscript.php</cite> file containing MapServer constants:</p>
621-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">//</span> <span class="n">required</span> <span class="n">SWIG</span> <span class="n">include</span> <span class="p">(</span><span class="n">contains</span> <span class="n">MapServer</span> <span class="n">constants</span> <span class="k">for</span> <span class="n">PHP7</span><span class="p">)</span>
622-
<span class="n">include</span><span class="p">(</span><span class="s2">&quot;C:/ms4w/apps/phpmapscriptng-swig/include/mapscript.php&quot;</span><span class="p">);</span>
621+
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">// required SWIG include (contains MapServer constants for PHP7)</span>
622+
<span class="x">include(&quot;C:/ms4w/apps/phpmapscriptng-swig/include/mapscript.php&quot;);</span>
623623
</pre></div>
624624
</div>
625625
</li>
626626
<li><p>take note of the change in how to declare your new objects:</p>
627-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>// open map
628-
$oMap = new mapObj(&quot;C:/ms4w/apps/phpmapscriptng-swig/sample.map&quot;);
627+
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">// open map</span>
628+
<span class="x">$oMap = new mapObj(&quot;C:/ms4w/apps/phpmapscriptng-swig/sample.map&quot;);</span>
629629
</pre></div>
630630
</div>
631631
<p>instead of the former way:</p>
632-
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>// open map
633-
$oMap = ms_newMapObj(&quot;C:/ms4w/apps/phpmapscript/sample.map&quot;);
632+
<div class="highlight-php notranslate"><div class="highlight"><pre><span></span><span class="x">// open map</span>
633+
<span class="x">$oMap = ms_newMapObj(&quot;C:/ms4w/apps/phpmapscript/sample.map&quot;);</span>
634634
</pre></div>
635635
</div>
636636
</li>
@@ -676,7 +676,7 @@ <h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">MapServ
676676
the expression instead.</p></li>
677677
<li><p>Layer opacity is now deprecated a result of RFC 113 - Layer Compositing. The mapfile parser
678678
and MapScript getter/setter functions will continue to function but unpredictable results will
679-
occur if used in conjunction with COMPOSITE blocks. For more information see <a class="reference external" href="https://mapserver.org/development/rfc/ms-rfc-113.html">https://mapserver.org/development/rfc/ms-rfc-113.html</a>.</p>
679+
occur if used in conjunction with COMPOSITE blocks.</p>
680680
<div class="highlight-mapfile notranslate"><div class="highlight"><pre><span></span><span class="c1"># Before</span>
681681
<span class="k">LAYER</span>
682682
<span class="p">...</span>
@@ -692,6 +692,10 @@ <h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">MapServ
692692
<span class="k">END</span>
693693
</pre></div>
694694
</div>
695+
<div class="admonition seealso">
696+
<p class="admonition-title">See also</p>
697+
<p><a class="reference internal" href="development/rfc/ms-rfc-113.html#rfc113"><span class="std std-ref">MS RFC 113: Layer Compositing Pipeline</span></a></p>
698+
</div>
695699
</li>
696700
<li><p>Handling of non UTF-8 encoded datasources has changed with RFC103. Mapfiles
697701
now <em>must</em> be saved in UTF-8 encoding, and requests returned by MapServer
@@ -748,9 +752,10 @@ <h2><a class="toc-backref" href="#table-of-contents" role="doc-backlink">MapServ
748752
</li>
749753
<li><p>Validation patterns cannot be specified in metadata blocks (i.e. using
750754
xxx_validation_pattern and default_xxx metadata entries), use VALIDATION blocks.
751-
see #4596 #4604 #4608 or <a class="reference internal" href="cgi/runsub.html#runsub"><span class="std std-ref">Run-time Substitution</span></a></p></li>
755+
see <a class="reference external" href="https://github.com/MapServer/MapServer/issues/4596">#4596</a>, <a class="reference external" href="https://github.com/MapServer/MapServer/issues/4604">#4604</a>, <a class="reference external" href="https://github.com/MapServer/MapServer/issues/4608">#4608</a>, or <a class="reference internal" href="cgi/runsub.html#runsub"><span class="std std-ref">Run-time Substitution</span></a></p></li>
752756
<li><p>WFS paging parameter startIndex changed to base on 0 instead of 1 (0 is the first
753-
feature). See #4180 for external references.</p></li>
757+
feature). See <a class="reference external" href="https://github.com/MapServer/MapServer/issues/4180">#4180</a>
758+
for external references.</p></li>
754759
<li><p>Template substitution tags were case-sensitive, they are now
755760
case-insensitive.</p></li>
756761
</ul>
@@ -788,30 +793,33 @@ <h3>Rendering changes<a class="headerlink" href="#rendering-changes" title="Link
788793
using the centre to centre distance.
789794
In earlier versions of MapServer, GAP was used as the approximate
790795
distance between the symbol boundaries.
791-
See ticket #3867 for more information.</p>
796+
See ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3867">#3867</a>
797+
for more information.</p>
792798
<p>In order to get the same effect with 6.2 as with 6.0, STYLE-&gt;GAP
793799
must be increased with the size of the symbol.</p>
794800
</li>
795801
<li><p>Removal of one pixel gap between symbols
796802
In earlier versions of MapServer, an extra gap of one pixel was
797803
added between the symbols (in addition to the gap specified in
798804
STYLE-&gt;GAP). This has been discontinued in 6.2.
799-
See ticket #3868 for more information.</p>
805+
See ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3868">#3868</a>
806+
for more information.</p>
800807
<p>In order to get the same effect with 6.2 as with 6.0, STYLE-&gt;GAP
801808
must be increased with one pixel.</p>
802809
</li>
803810
<li><p>STYLE-&gt;INITIALGAP introduced
804811
Support for more powerful line styling has been provided with the
805-
introduction of STYLE-&gt;INITIALGAP. See ticket #3879 and the
806-
documentation for more information.</p></li>
812+
introduction of STYLE-&gt;INITIALGAP. See ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3879">#3879</a>
813+
and the documentation for more information.</p></li>
807814
<li><p>SYMBOL-&gt;ANCHORPOINT introduced
808815
A symbol anchorpoint has been introduced to facilitate precise
809-
positioning of symbols. See ticket #4066 and the documentation for
810-
more information.</p></li>
816+
positioning of symbols. See ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/4066">#4066</a>
817+
and the documentation for more information.</p></li>
811818
<li><p>Change in vector symbol size calculation.
812819
In 6.2, vector symbol coordinates are shifted to get rid of
813820
negative x and y coordinate values.
814-
See ticket #4116 for more information.</p>
821+
See ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/4116">#4116</a>
822+
for more information.</p>
815823
<p>In order to get the shifting effect that could be obtained using
816824
negative coordinate values, SYMBOL-&gt;ANCHORPOINT should be used
817825
instead.</p>
@@ -845,8 +853,10 @@ <h3>Mapfile Changes - Expression Parsing<a class="headerlink" href="#mapfile-cha
845853
</ul>
846854
<p>On the plus side you can now control the number of decimal places, round and even commify
847855
the area value for display.</p>
848-
<p>See <a class="reference external" href="https://mapserver.org/development/rfc/ms-rfc-64.html">https://mapserver.org/development/rfc/ms-rfc-64.html</a> and <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3736">https://github.com/MapServer/MapServer/issues/3736</a>
849-
for more information.</p>
856+
<div class="admonition seealso">
857+
<p class="admonition-title">See also</p>
858+
<p><a class="reference internal" href="development/rfc/ms-rfc-64.html#rfc64"><span class="std std-ref">MS RFC 64 - MapServer Expression Parser Overhaul</span></a> and ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3736">#3736</a></p>
859+
</div>
850860
</section>
851861
<section id="mapfile-changes-label-styles">
852862
<h3>Mapfile Changes - Label Styles<a class="headerlink" href="#mapfile-changes-label-styles" title="Link to this heading"></a></h3>
@@ -932,7 +942,8 @@ <h3>CGI Changes<a class="headerlink" href="#id1" title="Link to this heading">¶
932942
<p>Runtime substitution now <em>requires</em> a validation pattern be present before the
933943
substitution will take place (this had been optional). This can be done via
934944
a layer metadata tag as before or within layer or web VALIDATION blocks. See
935-
ticket #3522 for more information.</p>
945+
ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3522">#3522</a>
946+
for more information.</p>
936947
<p>All of the query map related modes (e.g. NQUERYMAP, ITEMQUERYMAP, etc…) have
937948
been removed in favor of using the “qformat” parameter. That parameter takes
938949
an output format name or mime/type as a value and uses that to process a set
@@ -949,7 +960,10 @@ <h3>OGC Web Services<a class="headerlink" href="#ogc-web-services" title="Link t
949960
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">&quot;ows_enable_request&quot;</span> <span class="s2">&quot;*&quot;</span>
950961
</pre></div>
951962
</div>
952-
<p>See also: <a class="reference external" href="https://mapserver.org/development/rfc/ms-rfc-67.html">https://mapserver.org/development/rfc/ms-rfc-67.html</a></p>
963+
<div class="admonition seealso">
964+
<p class="admonition-title">See also</p>
965+
<p><a class="reference internal" href="development/rfc/ms-rfc-67.html#rfc67"><span class="std std-ref">MS RFC 67: Enable/Disable Layers in OGC Web Services</span></a></p>
966+
</div>
953967
</section>
954968
<section id="mapfile-changes-wcs-metadata">
955969
<h3>Mapfile Changes - WCS Metadata<a class="headerlink" href="#mapfile-changes-wcs-metadata" title="Link to this heading"></a></h3>
@@ -1102,7 +1116,10 @@ <h3>MapScript (All Flavors)<a class="headerlink" href="#mapscript-all-flavors" t
11021116
<span class="nv">$layer</span><span class="o">-&gt;</span><span class="nb">close</span><span class="p">();</span>
11031117
</pre></div>
11041118
</div>
1105-
<p>See <a class="reference external" href="https://mapserver.org/development/rfc/ms-rfc-65.html">https://mapserver.org/development/rfc/ms-rfc-65.html</a> for more information.</p>
1119+
<div class="admonition seealso">
1120+
<p class="admonition-title">See also</p>
1121+
<p><a class="reference internal" href="development/rfc/ms-rfc-65.html#rfc65"><span class="std std-ref">MS RFC 65 - Single-pass Query Changes for 6.0</span></a></p>
1122+
</div>
11061123
</section>
11071124
<section id="outputformat">
11081125
<h3>OUTPUTFORMAT<a class="headerlink" href="#outputformat" title="Link to this heading"></a></h3>
@@ -1160,7 +1177,10 @@ <h3>MapScript changes related to single pass queries<a class="headerlink" href="
11601177
on the data instead of two passes. This is transparent for CGI applications,
11611178
but MapScript scripts must be modified to use the layer.resultsGetShape()
11621179
method instead of layer.getShape().</p>
1163-
<p>See also: <a class="reference external" href="https://mapserver.org/development/rfc/ms-rfc-52.html">https://mapserver.org/development/rfc/ms-rfc-52.html</a></p>
1180+
<div class="admonition seealso">
1181+
<p class="admonition-title">See also</p>
1182+
<p><span class="xref std std-ref">rfc52</span></p>
1183+
</div>
11641184
<p>(Note: the new resultsGetShape() method is not yet available for PHP MapScript
11651185
in 5.6.0-beta1)</p>
11661186
</section>
@@ -1178,7 +1198,7 @@ <h3>WFS 1.1 axis orientation<a class="headerlink" href="#wfs-1-1-axis-orientatio
11781198
<section id="change-of-mime-type-for-the-imagemap-outputformat">
11791199
<h3>Change of mime-type for the imagemap outputformat<a class="headerlink" href="#change-of-mime-type-for-the-imagemap-outputformat" title="Link to this heading"></a></h3>
11801200
<p>RFC 36 added support for templated outputformats, but this new feature
1181-
was not available for WMS GetFeatureInfo output (see ticket #3024).
1201+
was not available for WMS GetFeatureInfo output (see ticket <a class="reference external" href="https://github.com/MapServer/MapServer/issues/3024">#3024</a>).
11821202
In MapServer 5.6 this has been resolved by implementing lookup of output
11831203
formats for query templates by mime-type. However this caused a conflict
11841204
for the text/html mime-type between the actual text/html query
@@ -1217,7 +1237,10 @@ <h3>New requirements for mapfiles, symbolsets and templates<a class="headerlink"
12171237
</ul>
12181238
</li>
12191239
</ul>
1220-
<p>See also: <a class="reference external" href="https://mapserver.org/development/rfc/ms-rfc-56.html">https://mapserver.org/development/rfc/ms-rfc-56.html</a></p>
1240+
<div class="admonition seealso">
1241+
<p class="admonition-title">See also</p>
1242+
<p><a class="reference internal" href="development/rfc/ms-rfc-56.html#rfc56"><span class="std std-ref">MS RFC 56: Tighten control of access to mapfiles and templates</span></a></p>
1243+
</div>
12211244
</section>
12221245
</section>
12231246
<section id="mapserver-4-10-to-5-0-migration">
@@ -1600,7 +1623,7 @@ <h3>Navigation</h3>
16001623
</div>
16011624
<div class="footer" role="contentinfo">
16021625
&#169; <a href="copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
1603-
Last updated on 2026-07-10.
1626+
Last updated on 2026-07-15.
16041627
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
16051628
</div>
16061629
</body>

_modules/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ <h3>Navigation</h3>
160160
</div>
161161
<div class="footer" role="contentinfo">
162162
&#169; <a href="../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
163-
Last updated on 2026-07-10.
163+
Last updated on 2026-07-15.
164164
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
165165
</div>
166166
</body>

_modules/mapscript/mapscript.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5589,7 +5589,7 @@ <h3>Navigation</h3>
55895589
</div>
55905590
<div class="footer" role="contentinfo">
55915591
&#169; <a href="../../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
5592-
Last updated on 2026-07-10.
5592+
Last updated on 2026-07-15.
55935593
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
55945594
</div>
55955595
</body>

0 commit comments

Comments
 (0)