db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rhille...@apache.org
Subject svn commit: r1370383 - in /db/derby/site/trunk: build/site/manuals/messages.html src/documentation/content/xdocs/manuals/messages.xml
Date Tue, 07 Aug 2012 17:41:00 GMT
Author: rhillegas
Date: Tue Aug  7 17:41:00 2012
New Revision: 1370383

URL: http://svn.apache.org/viewvc?rev=1370383&view=rev
Log:
DERBY-5892: Add more advice to the Derby website about how to write messages which are easy
to translate and to present in the Reference Guide.

Modified:
    db/derby/site/trunk/build/site/manuals/messages.html
    db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml

Modified: db/derby/site/trunk/build/site/manuals/messages.html
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/build/site/manuals/messages.html?rev=1370383&r1=1370382&r2=1370383&view=diff
==============================================================================
--- db/derby/site/trunk/build/site/manuals/messages.html (original)
+++ db/derby/site/trunk/build/site/manuals/messages.html Tue Aug  7 17:41:00 2012
@@ -161,7 +161,7 @@ Error and warning messages are documente
 When you add internationalized messages to the Derby engine, add the messages to 
 the xml descriptors file that is located in <span class="codefrag">..java/engine/org/apache/derby/loc/messages.xml</span>.

 Specify friendly names for the message arguments. The friendly names appear in the SQLState
tables in
-the Derby Reference Manual. Valid friendly names are:
+the Derby Reference Manual. Avoid vacuous names like "value". Useful, friendly names are:
 </p>
 
 <ul>
@@ -182,19 +182,38 @@ the Derby Reference Manual. Valid friend
 
 <li>triggerName</li>
 
-<li>valueName</li>
-
 <li>viewName</li>
 
 </ul>
 
+
+<p>
+Make sure that you list the friendly argument names in the <strong>numeric</strong>
order that they appear in their messages.
+For instance, for the following message...
+</p>
+
+
+<p class="code-block">Table {1} in schema {0} cannot be indexed.
+</p>
+
+
+<p>
+...the order of arguments would be...
+</p>
+
+
+<p class="code-block">schemaName
+tableName
+</p>
+
+
 <p>
 <strong>Do not edit the java/engine/org/apache/derby/loc/messages_en.properties file</strong>.
This file
 has been removed from code management and is now generated from
 messages.xml during the Derby build.</p>
 
 
-<p>A utility takes the content of the <span class="codefrag">..java/engine/org/apache/derby/loc/messages.xml</span>

+<p>The MessageBuilder utility takes the content of the <span class="codefrag">..java/engine/org/apache/derby/loc/messages.xml</span>

 file, and updates the topic in the Derby Reference Manual that lists all of the 
 messages. That topic is <strong>rrefexcept71493.dita</strong>.
 </p>
@@ -206,10 +225,6 @@ Please post feedback to the 
 </p>
 
 
-<p>
-<em>Last Updated: November 7, 2006</em>
-</p>
-
 </div>
 <!--+
     |end content

Modified: db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml
URL: http://svn.apache.org/viewvc/db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml?rev=1370383&r1=1370382&r2=1370383&view=diff
==============================================================================
--- db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml (original)
+++ db/derby/site/trunk/src/documentation/content/xdocs/manuals/messages.xml Tue Aug  7 17:41:00
2012
@@ -27,7 +27,7 @@ Error and warning messages are documente
 When you add internationalized messages to the Derby engine, add the messages to 
 the xml descriptors file that is located in <code>..java/engine/org/apache/derby/loc/messages.xml</code>.

 Specify friendly names for the message arguments. The friendly names appear in the SQLState
tables in
-the Derby Reference Manual. Valid friendly names are:
+the Derby Reference Manual. Avoid vacuous names like "value". Useful, friendly names are:
 </p>
 <ul>
 <li>authorizationID</li>
@@ -38,14 +38,30 @@ the Derby Reference Manual. Valid friend
 <li>objectName</li>
 <li>tableName</li>
 <li>triggerName</li>
-<li>valueName</li>
 <li>viewName</li>
 </ul>
+
+<p>
+Make sure that you list the friendly argument names in the <strong>numeric</strong>
order that they appear in their messages.
+For instance, for the following message...
+</p>
+
+<p class="code-block">Table {1} in schema {0} cannot be indexed.
+</p>
+
+<p>
+...the order of arguments would be...
+</p>
+
+<p class="code-block">schemaName
+tableName
+</p>
+
 <p><strong>Do not edit the java/engine/org/apache/derby/loc/messages_en.properties
file</strong>. This file
 has been removed from code management and is now generated from
 messages.xml during the Derby build.</p>
 
-<p>A utility takes the content of the <code>..java/engine/org/apache/derby/loc/messages.xml</code>

+<p>The MessageBuilder utility takes the content of the <code>..java/engine/org/apache/derby/loc/messages.xml</code>

 file, and updates the topic in the Derby Reference Manual that lists all of the 
 messages. That topic is <strong>rrefexcept71493.dita</strong>.
 </p>
@@ -55,6 +71,5 @@ Please post feedback to the 
 <a href="../derby_mail.html">derby-dev</a> mail list.
 </p>
 
-<p><em>Last Updated: November 7, 2006</em></p>
 </body>
 </document>



Mime
View raw message