[mapserver-commits] r11993 - branches/branch-6-0/docs/en/mapfile
trunk/docs/en/mapfile
svn at osgeo.org
svn at osgeo.org
Thu Aug 4 08:57:32 EDT 2011
Author: havatv
Date: 2011-08-04 05:57:32 -0700 (Thu, 04 Aug 2011)
New Revision: 11993
Modified:
branches/branch-6-0/docs/en/mapfile/labelencoding.txt
trunk/docs/en/mapfile/labelencoding.txt
Log:
Updated documentation for label encoding (#2934). Also did some line breaking.
Modified: branches/branch-6-0/docs/en/mapfile/labelencoding.txt
===================================================================
--- branches/branch-6-0/docs/en/mapfile/labelencoding.txt 2011-08-04 12:35:04 UTC (rev 11992)
+++ branches/branch-6-0/docs/en/mapfile/labelencoding.txt 2011-08-04 12:57:32 UTC (rev 11993)
@@ -15,11 +15,13 @@
Credit
======
-The following functionality was added to MapServer 4.4.0 as a part of a project sponsored by the
-Information-technology Promotion Agency (IPA), in Japan. Project members included: Venkatesh Raghavan,
-Masumoto Shinji, Nonogaki Susumu, Nemoto Tatsuya, Hirai Naoki (Osaka City University, Japan),
-Mario Basa, Hagiwara Akira, Niwa Makoto, Mori Toru (Orkney Inc., Japan), and Hattori Norihiro
-(E-Solution Service, Inc., Japan).
+The following functionality was added to MapServer 4.4.0 as a part of
+a project sponsored by the Information-technology Promotion Agency
+(IPA), in Japan. Project members included: Venkatesh Raghavan,
+Masumoto Shinji, Nonogaki Susumu, Nemoto Tatsuya, Hirai Naoki (Osaka
+City University, Japan), Mario Basa, Hagiwara Akira, Niwa Makoto, Mori
+Toru (Orkney Inc., Japan), and Hattori Norihiro (E-Solution Service,
+Inc., Japan).
Related Links
=============
@@ -35,18 +37,31 @@
How to Enable in Your Mapfile
=============================
-The mapfile :ref:`LABEL <label>` object's parameter named *ENCODING* can be used to convert strings from its original
-encoding system into one that can be understood by the True Type Fonts.
-The *ENCODING* parameter accepts the encoding name as its parameter.
+The mapfile :ref:`LABEL <label>` object's parameter named *ENCODING*
+can be used to convert strings from its original encoding system into
+one that can be understood by the True Type Fonts. The *ENCODING*
+parameter accepts the encoding name as its parameter.
-This uses GNU's libiconv ( http://www.gnu.org/software/libiconv/ ) so theoretically, every string
-with an encoding system supported by libiconv can be displayed as labels in MapServer as long as
-it has a matching font-set.
+.. index::
+ single: libiconv
+Mapserver uses GNU's libiconv library (
+http://www.gnu.org/software/libiconv/ ) to deal with encodings. The
+libiconv web site has a list of supported encodings. One can also use
+the "iconv -l" command on a system with libiconv installed to get the
+complete list of supported encodings on that specific system.
+
+So, theoretically, every string with an encoding system supported by
+libiconv can be displayed as labels in MapServer as long as it has a
+matching font-set.
+
+
Step 1: Verify ICONV Support and MapServer Version
--------------------------------------------------
-Execute ''mapserv -v' at the commandline, and verify that your MapServer version >= 4.4.0 and it includes ''SUPPORTS=ICONV'', such as:
+Execute ''mapserv -v' at the commandline, and verify that your
+MapServer version >= 4.4.0 and it includes ''SUPPORTS=ICONV'', such
+as:
::
@@ -64,8 +79,9 @@
Step 2: Verify That Your Files' Encoding is Supported by ICONV
--------------------------------------------------------------
-Since MapServer uses the libiconv library to handle encodings, you can check the list of supported encodings
-here: http://www.gnu.org/software/libiconv/
+Since MapServer uses the libiconv library to handle encodings, you can
+check the list of supported encodings here:
+http://www.gnu.org/software/libiconv/
Unix users can also use the *iconv -l* command on a system with
libiconv installed to get the complete list of supported encodings on
@@ -74,7 +90,8 @@
Step 3: Add ENCODING Parameter to your LABEL Object
---------------------------------------------------
-Now you can simply add the ENCODING parameter to your mapfile LAYER object, such as:
+Now you can simply add the ENCODING parameter to your mapfile LAYER
+object, such as:
.. code-block:: mapfile
@@ -93,8 +110,13 @@
END
-One of the benefits of having an "ENCODING" parameter within the LABEL object is that different LAYERS with different encoding systems can be combined together and display labels within a single map. For example, labels from a Layer using Shapefile as it source which contains attributes in SHIFT-JIS can be combined with a Layer from a PostGIS database server with EUC-JP attributes.
-A sample Mapfile can look like this:
+One of the benefits of having an "ENCODING" parameter within the LABEL
+object is that different LAYERS with different encoding systems can be
+combined together and display labels within a single map. For
+example, labels from a Layer using Shapefile as it source which
+contains attributes in SHIFT-JIS can be combined with a Layer from a
+PostGIS database server with EUC-JP attributes. A sample Mapfile can
+look like this:
.. code-block:: mapfile
@@ -156,8 +178,9 @@
Example Using PHP MapScript
===========================
-For PHP Mapscript, the *Encoding* parameter is included in the LabelObj Class, so that the
-encoding parameter of a layer can be modified such as:
+For PHP Mapscript, the *Encoding* parameter is included in the
+LabelObj Class, so that the encoding parameter of a layer can be
+modified such as:
::
@@ -187,5 +210,8 @@
Notes
=====
-During initial implementation, this functionality was tested using the different Japanese encoding systems:
-Shift-JIS, EUC-JP, UTF-8, as well as Thai's TIS-620 encoding system.
+.. note::
+
+ During initial implementation, this functionality was tested using
+ the different Japanese encoding systems: Shift-JIS, EUC-JP, UTF-8,
+ as well as Thai's TIS-620 encoding system.
Modified: trunk/docs/en/mapfile/labelencoding.txt
===================================================================
--- trunk/docs/en/mapfile/labelencoding.txt 2011-08-04 12:35:04 UTC (rev 11992)
+++ trunk/docs/en/mapfile/labelencoding.txt 2011-08-04 12:57:32 UTC (rev 11993)
@@ -15,11 +15,13 @@
Credit
======
-The following functionality was added to MapServer 4.4.0 as a part of a project sponsored by the
-Information-technology Promotion Agency (IPA), in Japan. Project members included: Venkatesh Raghavan,
-Masumoto Shinji, Nonogaki Susumu, Nemoto Tatsuya, Hirai Naoki (Osaka City University, Japan),
-Mario Basa, Hagiwara Akira, Niwa Makoto, Mori Toru (Orkney Inc., Japan), and Hattori Norihiro
-(E-Solution Service, Inc., Japan).
+The following functionality was added to MapServer 4.4.0 as a part of
+a project sponsored by the Information-technology Promotion Agency
+(IPA), in Japan. Project members included: Venkatesh Raghavan,
+Masumoto Shinji, Nonogaki Susumu, Nemoto Tatsuya, Hirai Naoki (Osaka
+City University, Japan), Mario Basa, Hagiwara Akira, Niwa Makoto, Mori
+Toru (Orkney Inc., Japan), and Hattori Norihiro (E-Solution Service,
+Inc., Japan).
Related Links
=============
@@ -35,18 +37,31 @@
How to Enable in Your Mapfile
=============================
-The mapfile :ref:`LABEL <label>` object's parameter named *ENCODING* can be used to convert strings from its original
-encoding system into one that can be understood by the True Type Fonts.
-The *ENCODING* parameter accepts the encoding name as its parameter.
+The mapfile :ref:`LABEL <label>` object's parameter named *ENCODING*
+can be used to convert strings from its original encoding system into
+one that can be understood by the True Type Fonts. The *ENCODING*
+parameter accepts the encoding name as its parameter.
-This uses GNU's libiconv ( http://www.gnu.org/software/libiconv/ ) so theoretically, every string
-with an encoding system supported by libiconv can be displayed as labels in MapServer as long as
-it has a matching font-set.
+.. index::
+ single: libiconv
+Mapserver uses GNU's libiconv library (
+http://www.gnu.org/software/libiconv/ ) to deal with encodings. The
+libiconv web site has a list of supported encodings. One can also use
+the "iconv -l" command on a system with libiconv installed to get the
+complete list of supported encodings on that specific system.
+
+So, theoretically, every string with an encoding system supported by
+libiconv can be displayed as labels in MapServer as long as it has a
+matching font-set.
+
+
Step 1: Verify ICONV Support and MapServer Version
--------------------------------------------------
-Execute ''mapserv -v' at the commandline, and verify that your MapServer version >= 4.4.0 and it includes ''SUPPORTS=ICONV'', such as:
+Execute ''mapserv -v' at the commandline, and verify that your
+MapServer version >= 4.4.0 and it includes ''SUPPORTS=ICONV'', such
+as:
::
@@ -64,8 +79,9 @@
Step 2: Verify That Your Files' Encoding is Supported by ICONV
--------------------------------------------------------------
-Since MapServer uses the libiconv library to handle encodings, you can check the list of supported encodings
-here: http://www.gnu.org/software/libiconv/
+Since MapServer uses the libiconv library to handle encodings, you can
+check the list of supported encodings here:
+http://www.gnu.org/software/libiconv/
Unix users can also use the *iconv -l* command on a system with
libiconv installed to get the complete list of supported encodings on
@@ -74,7 +90,8 @@
Step 3: Add ENCODING Parameter to your LABEL Object
---------------------------------------------------
-Now you can simply add the ENCODING parameter to your mapfile LAYER object, such as:
+Now you can simply add the ENCODING parameter to your mapfile LAYER
+object, such as:
.. code-block:: mapfile
@@ -93,8 +110,13 @@
END
-One of the benefits of having an "ENCODING" parameter within the LABEL object is that different LAYERS with different encoding systems can be combined together and display labels within a single map. For example, labels from a Layer using Shapefile as it source which contains attributes in SHIFT-JIS can be combined with a Layer from a PostGIS database server with EUC-JP attributes.
-A sample Mapfile can look like this:
+One of the benefits of having an "ENCODING" parameter within the LABEL
+object is that different LAYERS with different encoding systems can be
+combined together and display labels within a single map. For
+example, labels from a Layer using Shapefile as it source which
+contains attributes in SHIFT-JIS can be combined with a Layer from a
+PostGIS database server with EUC-JP attributes. A sample Mapfile can
+look like this:
.. code-block:: mapfile
@@ -156,8 +178,9 @@
Example Using PHP MapScript
===========================
-For PHP Mapscript, the *Encoding* parameter is included in the LabelObj Class, so that the
-encoding parameter of a layer can be modified such as:
+For PHP Mapscript, the *Encoding* parameter is included in the
+LabelObj Class, so that the encoding parameter of a layer can be
+modified such as:
::
@@ -187,5 +210,8 @@
Notes
=====
-During initial implementation, this functionality was tested using the different Japanese encoding systems:
-Shift-JIS, EUC-JP, UTF-8, as well as Thai's TIS-620 encoding system.
+.. note::
+
+ During initial implementation, this functionality was tested using
+ the different Japanese encoding systems: Shift-JIS, EUC-JP, UTF-8,
+ as well as Thai's TIS-620 encoding system.
More information about the mapserver-commits
mailing list