Opened 17 years ago

Closed 17 years ago

Last modified 16 years ago

#2119 closed task (fixed)

MapServer terminogy cleanup (RFC 26).

Reported by: sdlime Owned by: sdlime
Priority: normal Milestone: 5.0 release
Component: MapServer C Library Version: 5.0
Severity: normal Keywords:
Cc: dmorissette, assefa@…, jmckenna

Description (last modified by sdlime)

This ticket will trac changes related to RFC 26 - a terminology cleanup for version 5.0. The primary changes include:

  • converting TRANSPARENCY to OPACITY (keyword change, interpretation is the same)
  • appending DENOM to all scale related parameters (e.g. MINSCALE => MINSCALEDENOM)
  • converting symbolObj->style to ->pattern to avoid confusion with the main styleObj

A few other minor changes may be tracked here as well.

Change History (12)

comment:1 by sdlime, 17 years ago

Status: newassigned

Committed TRANSPARENCY to OPACITY switch. Mapfile backwards compatibility is maintained but since the parameter hung of the layerObj structure has changed this breaks MapScript compatability. This will be noted in the 4.10 to 5.0 migration guide.

Steve

comment:2 by sdlime, 17 years ago

Description: modified (diff)

comment:3 by sdlime, 17 years ago

Committed STYLE to PATTERN switch for symbolObj's. Mapfile and symbol files are backwards compatible (e.g. STYLE still works). MapScript is broken, setStyle and getStyle are replaced by setPattern and getPattern. I updated both SWIG/MapScript and PHP/MapScript.

Steve

comment:4 by sdlime, 17 years ago

Cc: morrissette@… assefa@… added

Committed ...SCALE to ...SCALEDENOM switch for various objects. Mapfiles are backwards compatible as the old keywords still work. For SWIG/MapScript, since the keywords have changed scripts will break. $layer->{maxscale} in Perl will have to be changed to $layer->{minscaledenom}.

I did not touch PHP/MapScript on this modification. I was checking the source and there may be options the maintainers want to consider. (cc'ing Dan and Assefa)

Steve

comment:5 by dmorissette, 17 years ago

Cc: dmorissette added; morrissette@… removed

comment:6 by dmorissette, 17 years ago

The conversion of symbol style to pattern in r6375 had not been done in mappdf.c. I have added that in r6379 and the build passes.

Doing changes required to PHP MapScript now.

comment:7 by dmorissette, 17 years ago

Resolution: fixed
Status: assignedclosed

I have updated PHP MapScript in r6381 with the changes for scale -> scaledenom and for renaming the symbol style to pattern. PHP MapScript's docs (mapscript/php3/README) also updated.

Note that in the PHP MapScript case, all the renamed members have been only deprecated, so the old names still work for this release, but should be removed in a future release. I have created ticket #2170 to remind us to do that in v5.2 or 5.4.

Closing ticket.

comment:8 by dmorissette, 17 years ago

I had missed the transparency -> opacity change that had been done earlier. In r6382 I have re-enabled transparency to make it deprecated in PHP MapScript, and updated the docs accordingly.

I have also updated the MIGRATION_GUIDE.TXT with a note about the deprecated members for PHP MapScript.

comment:9 by sdlime, 17 years ago

I wonder if we should try and make Swig/MapScript backwards compatible as well then...

steve

comment:10 by dmorissette, 17 years ago

That was relatively easy for PHP MapScript because we maintain it manually. I'm not sure if it's possible at all with SWIG or how much trouble that would be so I am not sure if that's worth the trouble. Users will have to fix their scripts at some point anyway... we just give them a little extension with the deprecation phase in PHP MapScript, but in 5.2 (or 5.4) I'm sure lots of PHP scripts still won't have been updated and will break.

comment:11 by jmckenna, 16 years ago

Cc: jmckenna added

question: i see that RFC 26 mentions that 'At debug level 1 a warning will be issued that the TRANSPARENCY parameter is depricated and OPACITY should be used instead', but was this debugging actually implemented? I ask because I don't see that warning with a "shp2img -all_debug 5" command on a mapfile with transparency.

comment:12 by jmckenna, 16 years ago

  • opened ticket#2706 for the missing debug warnings
Note: See TracTickets for help on using tickets.