- venkman only -

bug 122021, add comments re: leading/trailing spaces and quotes in venkman string files.

extensions/venkman/resources/content/venkman-msg.js

@@ -55,6 +55,9 @@ function getMsg (msgName, params, deflt)
             rv = console._bundle.GetStringFromName (msgName);
         }
         
+        /* strip leading and trailing quote characters, see comment at the
+         * top of venkman.properties.
+         */
         rv = rv.replace (/^\"/, "");
         rv = rv.replace (/\"$/, "");
 

extensions/venkman/resources/locale/en-US/venkman.properties

@@ -31,6 +31,25 @@
 #  Robert Ginda, <rginda@netscape.com>, original author
 #
 
+# NOTE ON LEADING/TRAILING SPACES AND QUOTES...
+# Strings in this file are stripped of leading and trailing qoutes, if they are
+# present.  This allows you to express leading and trailing whitespace, which
+# would otherwise be trimmed by the stringbundle code.  In order to express
+# a leading or trailing quote, use two of them.
+#
+# For example...
+#
+# my.message1 = "          foo"
+# my.message2 = "          foo
+#  Both of these produce 10 spaces, followed by the word ``foo''.
+# my.message3 = "foo          "
+# my.message3 = foo          "
+#  Both of these produce the word ``foo'', followed by 10 spaces.
+# my.message4 = A sphinctor says "what?""
+# my.message4 = "A sphinctor says "what?""
+#  Both of these produce the phrase ``A sphinctor says "what?"''
+#
+
 ## exception descriptions ##
 err.notimplemented = Not implemented
 err.required.param = Missing required parameter %1$S