Skip to content

Commit d50c1a5

Browse files
committed
update migration guide [build_translations]
1 parent 5aa9002 commit d50c1a5

1 file changed

Lines changed: 34 additions & 29 deletions

File tree

‎en/MIGRATION_GUIDE.txt‎

Lines changed: 34 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
MapServer Migration Guide
77
*****************************************************************************
88

9-
:Last Updated: 2026-05-07
9+
:Last Updated: 2026-07-15
1010

1111
.. contents:: Table of Contents
1212
:depth: 2
@@ -501,24 +501,24 @@ MapServer 7.2 to 7.4 Migration
501501
- all of your PHP scripts (that leverage MapServer objects and functions) must now always
502502
first include the generated `mapscript.php` file containing MapServer constants:
503503

504-
::
504+
.. code-block:: php
505505

506-
// required SWIG include (contains MapServer constants for PHP7)
507-
include("C:/ms4w/apps/phpmapscriptng-swig/include/mapscript.php");
506+
// required SWIG include (contains MapServer constants for PHP7)
507+
include("C:/ms4w/apps/phpmapscriptng-swig/include/mapscript.php");
508508

509509
- take note of the change in how to declare your new objects:
510510

511-
::
511+
.. code-block:: php
512512

513-
// open map
514-
$oMap = new mapObj("C:/ms4w/apps/phpmapscriptng-swig/sample.map");
513+
// open map
514+
$oMap = new mapObj("C:/ms4w/apps/phpmapscriptng-swig/sample.map");
515515

516516
instead of the former way:
517517

518-
::
518+
.. code-block:: php
519519

520-
// open map
521-
$oMap = ms_newMapObj("C:/ms4w/apps/phpmapscript/sample.map");
520+
// open map
521+
$oMap = ms_newMapObj("C:/ms4w/apps/phpmapscript/sample.map");
522522

523523
MapServer 7.0 to 7.2 Migration
524524
==============================
@@ -561,7 +561,7 @@ MapServer 6.4 to 7.0 Migration
561561

562562
- Layer opacity is now deprecated a result of RFC 113 - Layer Compositing. The mapfile parser
563563
and MapScript getter/setter functions will continue to function but unpredictable results will
564-
occur if used in conjunction with COMPOSITE blocks. For more information see https://mapserver.org/development/rfc/ms-rfc-113.html.
564+
occur if used in conjunction with COMPOSITE blocks.
565565

566566
.. code-block:: mapfile
567567

@@ -578,6 +578,8 @@ MapServer 6.4 to 7.0 Migration
578578
OPACITY 70
579579
END
580580
END
581+
582+
.. seealso:: :ref:`rfc113`
581583

582584
- Handling of non UTF-8 encoded datasources has changed with RFC103. Mapfiles
583585
now *must* be saved in UTF-8 encoding, and requests returned by MapServer
@@ -636,10 +638,11 @@ MapServer 6.2 to 6.4 Migration
636638

637639
- Validation patterns cannot be specified in metadata blocks (i.e. using
638640
xxx_validation_pattern and default_xxx metadata entries), use VALIDATION blocks.
639-
see #4596 #4604 #4608 or :ref:`runsub`
641+
see `#4596 <https://github.com/MapServer/MapServer/issues/4596>`__, `#4604 <https://github.com/MapServer/MapServer/issues/4604>`__, `#4608 <https://github.com/MapServer/MapServer/issues/4608>`__, or :ref:`runsub`
640642

641643
- WFS paging parameter startIndex changed to base on 0 instead of 1 (0 is the first
642-
feature). See #4180 for external references.
644+
feature). See `#4180 <https://github.com/MapServer/MapServer/issues/4180>`__
645+
for external references.
643646

644647
- Template substitution tags were case-sensitive, they are now
645648
case-insensitive.
@@ -682,7 +685,8 @@ Rendering changes
682685
using the centre to centre distance.
683686
In earlier versions of MapServer, GAP was used as the approximate
684687
distance between the symbol boundaries.
685-
See ticket #3867 for more information.
688+
See ticket `#3867 <https://github.com/MapServer/MapServer/issues/3867>`__
689+
for more information.
686690

687691
In order to get the same effect with 6.2 as with 6.0, STYLE->GAP
688692
must be increased with the size of the symbol.
@@ -691,25 +695,27 @@ Rendering changes
691695
In earlier versions of MapServer, an extra gap of one pixel was
692696
added between the symbols (in addition to the gap specified in
693697
STYLE->GAP). This has been discontinued in 6.2.
694-
See ticket #3868 for more information.
698+
See ticket `#3868 <https://github.com/MapServer/MapServer/issues/3868>`__
699+
for more information.
695700

696701
In order to get the same effect with 6.2 as with 6.0, STYLE->GAP
697702
must be increased with one pixel.
698703

699704
* STYLE->INITIALGAP introduced
700705
Support for more powerful line styling has been provided with the
701-
introduction of STYLE->INITIALGAP. See ticket #3879 and the
702-
documentation for more information.
706+
introduction of STYLE->INITIALGAP. See ticket `#3879 <https://github.com/MapServer/MapServer/issues/3879>`__
707+
and the documentation for more information.
703708

704709
* SYMBOL->ANCHORPOINT introduced
705710
A symbol anchorpoint has been introduced to facilitate precise
706-
positioning of symbols. See ticket #4066 and the documentation for
707-
more information.
711+
positioning of symbols. See ticket `#4066 <https://github.com/MapServer/MapServer/issues/4066>`__
712+
and the documentation for more information.
708713

709714
* Change in vector symbol size calculation.
710715
In 6.2, vector symbol coordinates are shifted to get rid of
711716
negative x and y coordinate values.
712-
See ticket #4116 for more information.
717+
See ticket `#4116 <https://github.com/MapServer/MapServer/issues/4116>`__
718+
for more information.
713719

714720
In order to get the shifting effect that could be obtained using
715721
negative coordinate values, SYMBOL->ANCHORPOINT should be used
@@ -747,8 +753,7 @@ values and string literals.
747753
On the plus side you can now control the number of decimal places, round and even commify
748754
the area value for display.
749755

750-
See https://mapserver.org/development/rfc/ms-rfc-64.html and https://github.com/MapServer/MapServer/issues/3736
751-
for more information.
756+
.. seealso:: :ref:`rfc64` and ticket `#3736 <https://github.com/MapServer/MapServer/issues/3736>`__
752757

753758
------------------------------
754759
Mapfile Changes - Label Styles
@@ -852,7 +857,8 @@ CGI Changes
852857
Runtime substitution now *requires* a validation pattern be present before the
853858
substitution will take place (this had been optional). This can be done via
854859
a layer metadata tag as before or within layer or web VALIDATION blocks. See
855-
ticket #3522 for more information.
860+
ticket `#3522 <https://github.com/MapServer/MapServer/issues/3522>`__
861+
for more information.
856862

857863
All of the query map related modes (e.g. NQUERYMAP, ITEMQUERYMAP, etc...) have
858864
been removed in favor of using the "qformat" parameter. That parameter takes
@@ -871,7 +877,7 @@ MAP::WEB section::
871877

872878
"ows_enable_request" "*"
873879

874-
See also: https://mapserver.org/development/rfc/ms-rfc-67.html
880+
.. seealso:: :ref:`rfc67`
875881

876882
------------------------------
877883
Mapfile Changes - WCS Metadata
@@ -1028,7 +1034,7 @@ To access shapes independently of a query use the new resultObj class:
10281034
$shape = $layer->getShape(new mapscript::resultObj(1));
10291035
$layer->close();
10301036

1031-
See https://mapserver.org/development/rfc/ms-rfc-65.html for more information.
1037+
.. seealso:: :ref:`rfc65`
10321038

10331039
------------
10341040
OUTPUTFORMAT
@@ -1094,7 +1100,7 @@ on the data instead of two passes. This is transparent for CGI applications,
10941100
but MapScript scripts must be modified to use the layer.resultsGetShape()
10951101
method instead of layer.getShape().
10961102

1097-
See also: https://mapserver.org/development/rfc/ms-rfc-52.html
1103+
.. seealso:: :ref:`rfc52`
10981104

10991105
(Note: the new resultsGetShape() method is not yet available for PHP MapScript
11001106
in 5.6.0-beta1)
@@ -1118,7 +1124,7 @@ Change of mime-type for the imagemap outputformat
11181124
-------------------------------------------------
11191125

11201126
RFC 36 added support for templated outputformats, but this new feature
1121-
was not available for WMS GetFeatureInfo output (see ticket #3024).
1127+
was not available for WMS GetFeatureInfo output (see ticket `#3024 <https://github.com/MapServer/MapServer/issues/3024>`__).
11221128
In MapServer 5.6 this has been resolved by implementing lookup of output
11231129
formats for query templates by mime-type. However this caused a conflict
11241130
for the text/html mime-type between the actual text/html query
@@ -1163,8 +1169,7 @@ The new requirements are as follows:
11631169

11641170
* In JavaScript: // MapServer Template
11651171

1166-
See also: https://mapserver.org/development/rfc/ms-rfc-56.html
1167-
1172+
.. seealso:: :ref:`rfc56`
11681173

11691174
MapServer 4.10 to 5.0 Migration
11701175
===============================

0 commit comments

Comments
 (0)