Skip to content

Commit

Permalink
add warnings, mostly about the CGI commands/substitutions/wrappers
Browse files Browse the repository at this point in the history
- don't use shell wrappers
- CGI commands and runsubs are not available for mapscript
- antialias document is irrelevant for mapserver >= 6.0
  • Loading branch information
tbonfort committed Aug 27, 2013
1 parent 92c1514 commit ff28660
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 8 deletions.
8 changes: 7 additions & 1 deletion en/cgi/controls.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
MapServer CGI Controls
*****************************************************************************


Variables
=========

Expand Down Expand Up @@ -484,6 +483,13 @@ mapfile parameters through a URL involves changing class expressions
on-the-fly. `VALIDATION` can be used to control run-time substition
(see :ref:`RUNSUB`). Try it out.

.. warning::

This functionality is only available via the :ref:`mapserv` CGI application.
Within MapScript this is easy to do by yourself since the developer has
complete control over how input is handled.



Using MapServer version >= 5
----------------------------
Expand Down
10 changes: 7 additions & 3 deletions en/cgi/runsub.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@ Introduction

Run-time substitution for the MapServer CGI has been around since version 4.0
and it's use has continued to expand. In short, it allows you to alter portions
of a mapfile based on data passed via a CGI request. This functionality is only
available via the standard CGI application. Within MapScript this is easy to do
since the developer has complete control over how input is handled.
of a mapfile based on data passed via a CGI request.

.. warning::

This functionality is only available via the :ref:`mapserv` CGI application.
Within MapScript this is easy to do by yourself since the developer has
complete control over how input is handled.



Expand Down
6 changes: 6 additions & 0 deletions en/cgi/wrapper.txt
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,12 @@ This document presents a simple shell script that can be used to "wrap" the
MapServer CGI, in order to avoid having to specify the 'map' parameter (or any
other chosen parameters) in your MapServer URLs.

.. warning:: Using a wrapper script is inefficient as it implies spawing two
processes (shell+mapserv) instead of only one (mapserv), and
should not be used on production installations. Refer to
:ref:`online_resource_wms` for examples of how to setup similar
functionality directly by using webserver configuration options.

Script Information
------------------

Expand Down
8 changes: 4 additions & 4 deletions en/development/rfc/ms-rfc-93.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Note: due to upcoming changes to text rendering, Truetype symbols and labels ren
be added in the future.

2.2 Exposing Feature Properties
-----------------------------
-------------------------------

A new layer element (UTFDATA) is added to allow the creation of simple JSON templates using MapServer
expression syntax identical to what is used with classObj->text class text syntax. UTFDATA is of type
Expand Down Expand Up @@ -168,7 +168,7 @@ Here is an image rendered as a JSON with UTFGrid renderer:
" ##$$$$$$$### ''''''(",
" ###########'''''''''''",
" %%%%#############'''''''''''"
]
]

And now we get the following keys and datas if we use the UTFITEM with the postal code as the key :

Expand Down Expand Up @@ -238,12 +238,12 @@ The layer object documentation will need to be updated to reflect the new parame
additions to talk about configuration options associated with the new output format.

10. Bug ID
---------
----------

None assigned.

11. Voting history
-----------------
------------------

None

Expand Down
4 changes: 4 additions & 0 deletions en/ogc/mapscript.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,10 @@ This makes it possible to dynamically configure a map object based on
information in the original request, and to capture the output of processing
requests for further post-processing.

.. warning:: :ref:`cgi_controls` and :ref:`runsub` are **not** applied when
using mapscript WxS wrappers. It is up to the mapscript code
you are writing to apply any mapfile modifications.

=============================================================================
Python Examples
=============================================================================
Expand Down
5 changes: 5 additions & 0 deletions en/output/antialias.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@
:Date: $Date$
:Last Updated: 2009/01/17

.. warning:: This document is outdated. Since version 6.0, MapServer will
produce aliased output for the "gd/" drivers, and antialiased
output for the "agg/" and "cairo/" ones


.. note:: For quality antialiased output from mapserver, it is **highly**
recommended to use the :ref:`AGG <agg>` rendering. This document
applies only if you whish to stick to the GD rendering, or if you
Expand Down

0 comments on commit ff28660

Please sign in to comment.