[mapserver-commits] r9755 - branches/branch-5-6/docs/en/mapfile

Mon Jan 25 23:02:07 EST 2010

Author: sdlime
Date: 2010-01-25 23:02:07 -0500 (Mon, 25 Jan 2010)
New Revision: 9755

Modified:
   branches/branch-5-6/docs/en/mapfile/template.txt
Log:
Updated templating documentation to reflect the need for a magic string.

Modified: branches/branch-5-6/docs/en/mapfile/template.txt
===================================================================

--- branches/branch-5-6/docs/en/mapfile/template.txt	2010-01-26 03:58:33 UTC (rev 9754)
+++ branches/branch-5-6/docs/en/mapfile/template.txt	2010-01-26 04:02:07 UTC (rev 9755)
@@ -10,7 +10,7 @@
 :Contact: jmckenna at gatewaygeomatics.com
 :Revision: $Revision$
 :Date: $Date$
-:Last Updated: 2008/07/18
+:Last Updated: 2010/01/25
 
 .. contents:: Table of Contents
     :depth: 2
@@ -36,6 +36,11 @@
 Notes
 -----
 
+- Templates *must* contain the magic string 'mapserver template' in the first
+  line of the template. Often this takes the form of an HTML, javascript or
+  XML comment. This line is *not* written to the client. The magic string
+  is not case sensitive.
+
 - All :ref:`CGI parameters <cgi>` can be referenced in template substitutions,
   MapServer specific parameters as well as user defined ones. In principle
   parameters are handed through by the MapServer 1:1. This feature is
@@ -635,6 +640,7 @@
 .. code-block:: guess
     :linenos:
     
+    <!-- MapServer Template -->
     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
            "http://www.w3.org/TR/html4/transitional.dtd">
     <html>

