[mapserver-commits] r8171 - in trunk/docs/mapscript: . php
svn at osgeo.org
svn at osgeo.org
Tue Dec 2 14:58:11 EST 2008
Author: hobu
Date: 2008-12-02 14:58:10 -0500 (Tue, 02 Dec 2008)
New Revision: 8171
Modified:
trunk/docs/mapscript/mapfile.txt
trunk/docs/mapscript/php/class-intro.txt
trunk/docs/mapscript/php/index.txt
trunk/docs/mapscript/php/install.txt
trunk/docs/mapscript/python.txt
Log:
start adding some indexing
Modified: trunk/docs/mapscript/mapfile.txt
===================================================================
--- trunk/docs/mapscript/mapfile.txt 2008-12-02 17:28:34 UTC (rev 8170)
+++ trunk/docs/mapscript/mapfile.txt 2008-12-02 19:58:10 UTC (rev 8171)
@@ -1,5 +1,8 @@
.. ms_mapscript:
+.. index::
+ pair: MapScript; mapfile
+
*****************************************************************************
Mapscript Mapfile HOWTO
*****************************************************************************
@@ -16,7 +19,7 @@
Introduction
============
-The mapscript HOWTO docs are intended to complement the API reference with
+The MapScript HowTo docs are intended to complement the API reference with
examples of usage for specific subjects. All examples in this document refer
to the mapfile and testing layers distributed with MapServer 4.2+ and found
under mapserver/tests.
@@ -34,7 +37,7 @@
================
By "Mapfile" here, I mean all the elements that can occur in (nearly)
-arbitrary numbers within a mapscript mapObj: Layers, Classes, and Styles.
+arbitrary numbers within a MapScript mapObj: Layers, Classes, and Styles.
MapServer 4.4 has greatly improved capability to manipulate these objects.
The mapObj Class
@@ -55,6 +58,9 @@
test_map = new mapscript.mapObj('tests/test.map')
+.. index::
+ pair: cloning; mapfile
+
Cloning
-------
@@ -63,9 +69,13 @@
clone_map = test_map.clone()
-.. note:: the Java mapscript module implements a "cloneMap" method to avoid
+.. note:: the Java MapScript module implements a "cloneMap" method to avoid
conflict with the clone method of Java's Object class.
+
+.. index::
+ pair: saving; mapfile
+
Saving
------
@@ -97,6 +107,9 @@
these references after the parent mapObj has been deleted and freed from
memory.
+.. index::
+ pair: LAYER; cloning
+
Cloning a Child
---------------
Modified: trunk/docs/mapscript/php/class-intro.txt
===================================================================
--- trunk/docs/mapscript/php/class-intro.txt 2008-12-02 17:28:34 UTC (rev 8170)
+++ trunk/docs/mapscript/php/class-intro.txt 2008-12-02 19:58:10 UTC (rev 8171)
@@ -1,3 +1,8 @@
+.. _php_introduction:
+
+.. index::
+ pair: php; introduction
+
*****************************************************************************
Introduction
*****************************************************************************
@@ -28,20 +33,16 @@
This module is constantly under development.
-How to Get More Information on PHP/Mapscript
+How to Get More Information on PHP/MapScript
--------------------------------------------
- The main resource for help is the `PHP/MapScript page`_ on MapTools.org.
- The `MapServer Wiki`_ might have more information on this module
-- For installation questions regarding the PHP/Mapscript module, see the
- `PHP/Mapscript Installation HOWTO`_
-- Also, see the `Mapserver MapScript API reference`_ and the `MapServer MapFile documentation`_
+- For installation questions regarding the PHP/MapScript module, see
+ :ref:`php_install`.
+- Also, see the :ref:`mapscript`, :ref:`php` and the :ref:`mapfile`
- Refer to the `main PHP site`_ for their official documentation
.. _`PHP/MapScript page`: http://www.maptools.org/php_mapscript/
.. _`MapServer Wiki`: http://mapserver.gis.umn.edu/cgi-bin/wiki.pl?PHPMapScript
-.. _`PHP/Mapscript Installation HOWTO`: http://mapserver.gis.umn.edu/doc/phpmapscript-install-howto.html
-
-.. _`Mapserver MapScript API reference`: http://ms.gis.umn.edu/docs/reference/mapscript
-.. _`MapServer MapFile documentation`: http://ms.gis.umn.edu/docs/reference/mapfile
.. _`main PHP site`: http://www.php.net
\ No newline at end of file
Modified: trunk/docs/mapscript/php/index.txt
===================================================================
--- trunk/docs/mapscript/php/index.txt 2008-12-02 17:28:34 UTC (rev 8170)
+++ trunk/docs/mapscript/php/index.txt 2008-12-02 19:58:10 UTC (rev 8171)
@@ -53,6 +53,8 @@
fixed eventually but in the meantime you should be careful about these
side-effects.
+.. index::
+ single: php; constants
Constants
----------
Modified: trunk/docs/mapscript/php/install.txt
===================================================================
--- trunk/docs/mapscript/php/install.txt 2008-12-02 17:28:34 UTC (rev 8170)
+++ trunk/docs/mapscript/php/install.txt 2008-12-02 19:58:10 UTC (rev 8171)
@@ -1,7 +1,7 @@
.. _php_install:
.. index::
- single: php; installation
+ pair: php; installation
*****************************************************************************
Installation
@@ -33,8 +33,8 @@
- For Unix/Linux users, a familiarity with the build environment, notably *make*.
- For Windows users, some compilation skills if you don't have ready access to
- a precompiled installation and need to compile your own copy of MapServer with
- the PHP/Mapscript module.
+ a pre-compiled installation and need to compile your own copy of MapServer with
+ the PHP/MapScript module.
Which version of PHP is supported?
----------------------------------
@@ -43,30 +43,33 @@
support for PHP3 has been dropped and as of the last update of this document,
PHP 4.3.11 or more recent was required (PHP5 is well supported).
-The best combinations of Mapscript and PHP versions are:
+The best combinations of MapScript and PHP versions are:
-- Mapscript 4.10 with PHP 5.2.1 and up
+- MapScript 4.10 with PHP 5.2.1 and up
-- Mapscript 4.10 with PHP 4.4.6 and up
+- MapScript 4.10 with PHP 4.4.6 and up
-How to Get More Information on the PHP/Mapscript Module for MapServer
+How to Get More Information on the PHP/MapScript Module for MapServer
---------------------------------------------------------------------
- For a list of all classes, properties, and methods available in the module
- see the `PHP/Mapscript Class reference`_.
+ see the :ref:`php`.
-- More information on the PHP/Mapscript module can be found on the
- `PHP/Mapscript page`_ on MapTools.org.
+- More information on the PHP/MapScript module can be found on the
+ `PHP/MapScript page`_ on MapTools.org.
-- The old `MapServer Wiki`_ also has PHP/Mapscript build and installation notes
+- The old `MapServer Wiki`_ also has PHP/MapScript build and installation notes
and some php code snippets.
- Questions regarding the module should be forwarded to the `MapServer mailing list`_.
-Obtaining, Compiling, and Installing PHP and the PHP/Mascript Module
+Obtaining, Compiling, and Installing PHP and the PHP/MapScript Module
====================================================================
-Download PHP and PHP/Mapscript
+.. index::
+ pair: php; download
+
+Download PHP and PHP/MapScript
------------------------------
- The PHP source or the Win32 binaries can be obtained from the `PHP web site`_.
@@ -85,7 +88,7 @@
**Windows**
- `MS4W (MapServer For Windows)`_ is a package that contains Apache, PHP, and
- PHP/Mapscript ready to use in a simple zipfile. Several Open Source applications
+ PHP/MapScript ready to use in a simple zipfile. Several Open Source applications
are also available for use in MS4W.
- Windows users can follow steps in the `Installing Apache, PHP and MySQL on Windows tutorial`_
@@ -106,13 +109,13 @@
as an Apache module (See the `Example Steps of a Full Windows Installation section`_
of this document).
-Build/Install the PHP/Mapscript Module
+Build/Install the PHP/MapScript Module
--------------------------------------
**Building on a Linux Box**
-NOTE: For UNIX users, see the README.CONFIGURE file in the MapServer source, or see the `UNIX Compilation howto`_.
+NOTE: For UNIX users, see the README.CONFIGURE file in the MapServer source, or see the :ref:`unix`.
- The main MapServer configure script will automatically setup the main makefile
to compile php_mapscript.so if you pass the *--with-php=DIR* argument to the configure script.
@@ -141,7 +144,7 @@
- If for some reason you really need to compile your own Windows binary then see the
README.WIN32 file in the MapServer source (good luck!).
-Installing PHP/Mapscript
+Installing PHP/MapScript
------------------------
Simply copy the file php4_mapscript.dll to your PHP4 extensions directory
@@ -150,7 +153,7 @@
Using phpinfo()
-To verify that PHP and PHP/Mapscript were installed properly, create a '.php' file
+To verify that PHP and PHP/MapScript were installed properly, create a '.php' file
containing the following code and try to access it through your web server:
::
@@ -174,8 +177,8 @@
</HTML>
-If PHP and PHP/Mapscript were installed properly, several tables should be
-displayed on your page, and 'Mapscript' should be listed in the 'Extensions'
+If PHP and PHP/MapScript were installed properly, several tables should be
+displayed on your page, and 'MapScript' should be listed in the 'Extensions'
table.
Example Steps of a Full Windows Installation
@@ -192,7 +195,7 @@
Apache Web server.
4. In a web browser goto http://127.0.0.1. You should see an MS4W opening page.
- You are now running PHP, PHP/Mapscript, and Apache.
+ You are now running PHP, PHP/MapScript, and Apache.
5. You can now optionally install other applications that are pre-configured
for MS4W, which are located on the `MS4W download page`_.
@@ -252,7 +255,7 @@
1. Install IIS if required (see the `IIS 4.0 installation procedure`_).
-2. Install PHP and PHP/Mapscript (see above).
+2. Install PHP and PHP/MapScript (see above).
3. Open the Internet Service Manager (eg. C/WINNT/system32/inetsrv/inetmgr.exe).
@@ -297,15 +300,15 @@
:Q: **Is there any documentation available?**
-:A: The main reference document is the `PHP/Mapscript Class reference`_,
+:A: The main reference document is the :ref:`php`,
which describes all of the current classes, properties and methods
- associated with the PHP/Mapscript module.
+ associated with the PHP/MapScript module.
To get a more complete description of each class and the meaning of
- their member variables, see the `Mapscript reference`_
- and the `mapfile reference`_.
+ their member variables, see the :ref:`mapscript`
+ and the :ref:`mapfile`.
- The `MapServer Wiki`_ also has PHP/Mapscript build and installation
+ The `MapServer Wiki`_ also has PHP/MapScript build and installation
notes and some php code snippets.
--------
@@ -317,7 +320,7 @@
*test_draw_map.phtml*: it's a very simple script that just draws a map,
legend and scalebar in an HTML page.
- A good intermediate example is the `PHP/Mapscript By Example howto`_
+ A good intermediate example is the :ref:`php_example`
(note that this document was created for an earlier MapServer version
but the code might be still useful).
@@ -397,9 +400,9 @@
--------
-:Q: **Does PHP/Mapscript have to be setup as a CGI? If so, why?**
+:Q: **Does PHP/MapScript have to be setup as a CGI? If so, why?**
-:A: Yes, please see the `PHP/Mapscript CGI page`_ in the Mapserver Wiki for details.
+:A: Yes, please see the `PHP/MapScript CGI page`_ in the Mapserver Wiki for details.
--------
@@ -418,13 +421,13 @@
--------
-:Q: **What are the best combinations of Mapscript and PHP versions?**
+:Q: **What are the best combinations of MapScript and PHP versions?**
:A: The best combinations are:
- - Mapscript 4.10 with PHP 5.2.1 and up
+ - MapScript 4.10 with PHP 5.2.1 and up
- - Mapscript 4.10 with PHP 4.4.6 and up
+ - MapScript 4.10 with PHP 4.4.6 and up
--------
@@ -436,40 +439,13 @@
built with the same GD as PHPMapScript. A workaround is to load the php_mapscript
module before the GD module.
---------
-
-About This Document
-===================
-
-Copyright Information
----------------------
-
-Copyright (c) 2007, Jeff McKenna.
-
-This documentation is covered by the same Open Source license as the MapServer
-software itself. See MapServer's `License and Credits`__ page for the complete
-text.
-
-__ http://ms.gis.umn.edu/License
-
-Disclaimer
-----------
-
-No liability for the contents of this document can be accepted.
-Use the concepts, examples and other content at your own risk.
-As this is a new edition of this document, there may be errors
-and inaccuracies that may be damaging to your system.
-Although this is highly unlikely, the author(s) do not take any
-responsibility for that: proceed with caution.
-
.. #### rST Link Section ####
.. _`SWIG`: http://www.swig.org/
.. _`DM Solutions Group`: http://www.dmsolutions.ca/
-.. _`PHP/Mapscript page`: http://www.maptools.org/php_mapscript/
+.. _`PHP/MapScript page`: http://www.maptools.org/php_mapscript/
.. _`MapServer Wiki`: http://mapserver.gis.umn.edu/cgi-bin/wiki.pl?PHPMapScript
.. _`MapServer mailing list`: http://mapserver.gis.umn.edu/community/mailinglists/
-.. _`PHP/Mapscript Class reference`: http://mapserver.gis.umn.edu/docs/reference/phpmapscript-class
.. _`PHP web site`: http://www.php.net/
.. _`MapServer source`: http://mapserver.gis.umn.edu/download
.. _`Installation on Unix systems`: http://php.net/manual/en/install.unix.php
@@ -477,7 +453,6 @@
.. _`Installing Apache, PHP and MySQL on Windows tutorial`: http://www.php-mysql-tutorial.com/install-apache-php-mysql.php
.. _`php.net's howto`: http://www.php.net/manual/en/install.iis.php
.. _`Example Steps of a Full Windows Installation section`: http://mapserver.gis.umn.edu/docs/howto/phpmapscript-install/#example-steps-of-a-full-windows-installation
-.. _`UNIX Compilation howto`: http://mapserver.gis.umn.edu/docs/howto/compiling_on_unix
.. _`extension_loaded()`: http://www.php.net/manual/en/function.extension-loaded.php
.. _`MapServer download page`: http://mapserver.gis.umn.edu/download/current/windows/
.. _`MapTools.org`: http://www.maptools.org/php_mapscript/index.phtml?page=downloads.html
@@ -485,13 +460,9 @@
.. _`MS4W download page`: http://www.maptools.org/ms4w/index.phtml?page=downloads.html
.. _`Apache Web Server`: http://httpd.apache.org/
.. _`PHP4`: http://www.php.net/
-.. _`mapfile`: http://mapserver.gis.umn.edu/docs/reference/mapfile/web
.. _`IIS 4.0 installation procedure`: http://support.microsoft.com/support/iis/install/install_iis4.asp
.. _`MapServer IIS Setup howto`: http://mapserver.gis.umn.edu/docs/howto/setupiis
-.. _`Mapscript reference`: http://mapserver.gis.umn.edu/docs/reference/mapscript
-.. _`mapfile reference`: http://mapserver.gis.umn.edu/docs/reference/mapfile
-.. _`PHP/Mapscript By Example howto`: http://mapserver.gis.umn.edu/doc/phpmapscript-byexample-howto.html
.. _`MapTools.org download page`: http://www.maptools.org/dl/
.. _`GMap demo`: http://www.mapsherpa.com/gmap/
-.. _`PHP/Mapscript CGI page`: http://mapserver.gis.umn.edu/cgi-bin/wiki.pl?PHPMapScriptCGI
+.. _`PHP/MapScript CGI page`: http://mapserver.gis.umn.edu/cgi-bin/wiki.pl?PHPMapScriptCGI
Modified: trunk/docs/mapscript/python.txt
===================================================================
--- trunk/docs/mapscript/python.txt 2008-12-02 17:28:34 UTC (rev 8170)
+++ trunk/docs/mapscript/python.txt 2008-12-02 19:58:10 UTC (rev 8171)
@@ -12,11 +12,14 @@
:depth: 2
:backlinks: top
+.. index::
+ pair: MapScript; python
+
=============================================================================
Introduction
=============================================================================
-The Python mapscript module contains some class extension methods that have
+The Python MapScript module contains some class extension methods that have
not yet been implemented for other languages.
=============================================================================
@@ -31,7 +34,7 @@
The Python Imaging Library, http://www.pythonware.com/products/pil/, is an
indispensible tool for image manipulation. The extensions to imageObj are
-all geared towards better integration of PIL in mapscript applications.
+all geared towards better integration of PIL in MapScript applications.
imageObj Methods
----------------
@@ -157,7 +160,7 @@
Exception Handling
=============================================================================
-The Python mapscript module maps a few MapServer errors into Python exceptions.
+The Python MapScript module maps a few MapServer errors into Python exceptions.
Attempting to load a non-existent mapfile raises an 'IOError', for example
::
More information about the mapserver-commits
mailing list