You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by "Rick Hillegas (JIRA)" <ji...@apache.org> on 2012/07/24 20:53:34 UTC

[jira] [Created] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Rick Hillegas created DERBY-5878:
------------------------------------

             Summary: Add message argument names, as comments, to English message file produced by MessageBuilder.
                 Key: DERBY-5878
                 URL: https://issues.apache.org/jira/browse/DERBY-5878
             Project: Derby
          Issue Type: Improvement
          Components: Build tools
    Affects Versions: 10.10.0.0
            Reporter: Rick Hillegas


The MessageBuilder program turns messages.xml into two output files:

1) The DITA source for the Reference Guide section on error messages.

2) The messages_en.properties file of engine messages.

All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.

Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Commented] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/DERBY-5878?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13422195#comment-13422195 ] 

Rick Hillegas commented on DERBY-5878:
--------------------------------------

Tests passed cleanly for me on derby-5878-01-aa-argsAsComments.diff. Committed at subversion revision 1365552.
                
> Add message argument names, as comments, to English message file produced by MessageBuilder.
> --------------------------------------------------------------------------------------------
>
>                 Key: DERBY-5878
>                 URL: https://issues.apache.org/jira/browse/DERBY-5878
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions: 10.10.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-5878-01-aa-argsAsComments.diff
>
>
> The MessageBuilder program turns messages.xml into two output files:
> 1) The DITA source for the Reference Guide section on error messages.
> 2) The messages_en.properties file of engine messages.
> All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.
> Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5878?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Hillegas updated DERBY-5878:
---------------------------------

    Attachment: derby-5878-04-aa-updateMessageDTD.diff

Attaching derby-5878-04-aa-updateMessageDTD.diff. This adds the <comment> element to the grammar description of messages.xml so that the dtd agrees with the changes introduced by derby-5878-02-aa-commentElements.diff. Committed at subversion revision 1371234.

Touches the following file:

M       java/engine/org/apache/derby/loc/messages.dtd

                
> Add message argument names, as comments, to English message file produced by MessageBuilder.
> --------------------------------------------------------------------------------------------
>
>                 Key: DERBY-5878
>                 URL: https://issues.apache.org/jira/browse/DERBY-5878
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions: 10.10.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-5878-01-aa-argsAsComments.diff, derby-5878-02-aa-commentElements.diff, derby-5878-03-aa-addBracketedArgNumbersToComments.diff, derby-5878-04-aa-updateMessageDTD.diff
>
>
> The MessageBuilder program turns messages.xml into two output files:
> 1) The DITA source for the Reference Guide section on error messages.
> 2) The messages_en.properties file of engine messages.
> All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.
> Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5878?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Hillegas updated DERBY-5878:
---------------------------------

    Attachment: derby-5878-03-aa-addBracketedArgNumbersToComments.diff

Attaching derby-5878-03-aa-addBracketedArgNumbersToComments.diff. Committed at subversion revision 1369040.

The translators asked me to add bracketed argument numbers to the comments in the generated English properties file. So, instead of generating

# Arguments:
#
#    connectionName
#

...we now generate

# Arguments:
#
#    {0} = connectionName
#

Touches the following file:

M       java/build/org/apache/derbyBuild/MessageBuilder.java

                
> Add message argument names, as comments, to English message file produced by MessageBuilder.
> --------------------------------------------------------------------------------------------
>
>                 Key: DERBY-5878
>                 URL: https://issues.apache.org/jira/browse/DERBY-5878
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions: 10.10.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-5878-01-aa-argsAsComments.diff, derby-5878-02-aa-commentElements.diff, derby-5878-03-aa-addBracketedArgNumbersToComments.diff
>
>
> The MessageBuilder program turns messages.xml into two output files:
> 1) The DITA source for the Reference Guide section on error messages.
> 2) The messages_en.properties file of engine messages.
> All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.
> Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5878?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Hillegas updated DERBY-5878:
---------------------------------

    Attachment: derby-5878-01-aa-argsAsComments.diff

Attaching derby-5878-01-aa-argsAsComments.diff. This patch changes MessageBuilder so that it writes message arguments into messages_en.properties. I will run regression tests.

Here is a sample message from messages_en.properties BEFORE applying the patch:

08004.C.9=Missing permission for user ''{0}'' to shutdown system [{1}].

Here is the same message AFTER applying this patch:

# Arguments:
#
#    authorizationID
#    exceptionMsg
#
08004.C.9=Missing permission for user ''{0}'' to shutdown system [{1}].



Touches the following file:

M       java/build/org/apache/derbyBuild/MessageBuilder.java

                
> Add message argument names, as comments, to English message file produced by MessageBuilder.
> --------------------------------------------------------------------------------------------
>
>                 Key: DERBY-5878
>                 URL: https://issues.apache.org/jira/browse/DERBY-5878
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions: 10.10.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-5878-01-aa-argsAsComments.diff
>
>
> The MessageBuilder program turns messages.xml into two output files:
> 1) The DITA source for the Reference Guide section on error messages.
> 2) The messages_en.properties file of engine messages.
> All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.
> Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Updated] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5878?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Hillegas updated DERBY-5878:
---------------------------------

    Attachment: derby-5878-02-aa-commentElements.diff

Attaching derby-5878-02-aa-commentElements.diff. This patch adds the ability to add comment blocks to English messages in messages.xml. These comments are copied to messages_en.properties to help translators understand the messages better. Committed at subversion revision 1367230.

Touches the following files:

--------------

M       java/build/org/apache/derbyBuild/MessageBuilder.java

Added code to look for <comment> sub-elements of <msg> elements. When they are found, they are prefixed as a comment header on the corresponding English property in messages_en.properties.

--------------

M       java/engine/org/apache/derby/loc/messages.xml

Added a header comment noting that comments can now be added to message descriptors.

                
> Add message argument names, as comments, to English message file produced by MessageBuilder.
> --------------------------------------------------------------------------------------------
>
>                 Key: DERBY-5878
>                 URL: https://issues.apache.org/jira/browse/DERBY-5878
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions: 10.10.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>         Attachments: derby-5878-01-aa-argsAsComments.diff, derby-5878-02-aa-commentElements.diff
>
>
> The MessageBuilder program turns messages.xml into two output files:
> 1) The DITA source for the Reference Guide section on error messages.
> 2) The messages_en.properties file of engine messages.
> All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.
> Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] [Assigned] (DERBY-5878) Add message argument names, as comments, to English message file produced by MessageBuilder.

Posted by "Rick Hillegas (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/DERBY-5878?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Hillegas reassigned DERBY-5878:
------------------------------------

    Assignee: Rick Hillegas
    
> Add message argument names, as comments, to English message file produced by MessageBuilder.
> --------------------------------------------------------------------------------------------
>
>                 Key: DERBY-5878
>                 URL: https://issues.apache.org/jira/browse/DERBY-5878
>             Project: Derby
>          Issue Type: Improvement
>          Components: Build tools
>    Affects Versions: 10.10.0.0
>            Reporter: Rick Hillegas
>            Assignee: Rick Hillegas
>
> The MessageBuilder program turns messages.xml into two output files:
> 1) The DITA source for the Reference Guide section on error messages.
> 2) The messages_en.properties file of engine messages.
> All of the translators I have dealt with want to use (2) as the English input for their translations. I believe this is because translators have written their own tools and those tools expect to work on properties files.
> Messages may have arguments. Those arguments appear as sub-elements of the messages in messages.xml. The arguments turn up in (1) but are thrown away when MessageBuilder produces (2). We can help translators do a better job by also writing the arguments as comments in (2).

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira