You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cxf.apache.org by Glen Mazza <gl...@gmail.com> on 2008/10/08 01:25:55 UTC

Re: svn commit: r702656 - in /cxf/trunk/rt/transports/jms/src: main/java/org/apache/cxf/transport/jms/ test/java/org/apache/cxf/transport/jms/

Christian, usage of "you" is somewhat uncommon in error messages, wouldn't
you say?  Although I think it's more permissable for the first two messages
below, because you're asking a question, but normally the latter two should
avoid "you".

Glen

cschneider-2 wrote:
> 
>  DISPATCH_FAILURE_MSG = Dispatch of incoming JMS request failed
> +INSUFFICIENT_CONFIGURATION_CONDUIT = Insufficient configuration for
> Conduit. Did you configure a <jms:conduit name=\"{0}\"> and set the
> jndiConnectionFactoryName ?

Be sure to configure a ... and set the jndiConnectionFactoryName.

> +INSUFFICIENT_CONFIGURATION_DESTINATION = Insufficient configuration for
> Destination. Did you configure a <jms:destination name=\"{0}\"> and set
> the jndiConnectionFactoryName ?

Be sure to configure a ... and set the jndiConnectionFactoryName.

> +JMSCONFIGFEATURE_ONLY_JMS = You can only use JMSConfigFeature with the
> jms transport

JMSConfigFeature can only be used with jms transport.

> +JMSCONFIG_REQUIRED = You have to set the property jmsConfig

Property jmsConfig has to be set -or- was not set -or- must be set

-- 
View this message in context: http://www.nabble.com/Re%3A-svn-commit%3A-r702656---in--cxf-trunk-rt-transports-jms-src%3A-main-java-org-apache-cxf-transport-jms--test-java-org-apache-cxf-transport-jms--tp19869512p19869512.html
Sent from the cxf-dev mailing list archive at Nabble.com.


Re: svn commit: r702656 - in /cxf/trunk/rt/transports/jms/src: main/java/org/apache/cxf/transport/jms/ test/java/org/apache/cxf/transport/jms/

Posted by Glen Mazza <gl...@gmail.com>.
Technical documentation, yes, I use "you" all the time there.  Windows- and
browser-error messages, frequently yes also, because you're trying to be
warm and friendly to a non-technical user.  Lower-level Oracle database
error[1] or operating system messages, I would say "you" looks strange, and
irritating to the reader.  I guess CXF is in a grey zone between the
two--but since these are config errors, perhaps OK to use "you".

Sometimes firmness/coldness in error messages gives the user a more
comfortable feeling about the robustness of the application he/she are
using.  Oracle probably wouldn't seem as solid a database if it used "you"
in its system-level error messages.  It is similar to the situation with
automated voices.  While setting your voicemail account or listening to your
cell phone messages, a pleasant female voice is normally used, but in
prerecorded emergency messages over a loudspeaker (say for a fire alarm), a
male voice is used because it makes people more comfortable in that
scenario.

Glen

[1] http://www.oracle.com/pls/db92/db92.error_search



Benson Margulies-4 wrote:
> 
> Well, I've always liked technical writing that uses 'you' to avoid the
> passive. Since this is a config error, it seems to me to have an audience
> that can handle a you. But that's just my opinion.
> 
> On Tue, Oct 7, 2008 at 7:25 PM, Glen Mazza <gl...@gmail.com> wrote:
> 
>>
>> Christian, usage of "you" is somewhat uncommon in error messages,
>> wouldn't
>> you say?  Although I think it's more permissable for the first two
>> messages
>> below, because you're asking a question, but normally the latter two
>> should
>> avoid "you".
>>
>> Glen
>>
>> cschneider-2 wrote:
>> >
>> >  DISPATCH_FAILURE_MSG = Dispatch of incoming JMS request failed
>> > +INSUFFICIENT_CONFIGURATION_CONDUIT = Insufficient configuration for
>> > Conduit. Did you configure a <jms:conduit name=\"{0}\"> and set the
>> > jndiConnectionFactoryName ?
>>
>> Be sure to configure a ... and set the jndiConnectionFactoryName.
>>
>> > +INSUFFICIENT_CONFIGURATION_DESTINATION = Insufficient configuration
>> for
>> > Destination. Did you configure a <jms:destination name=\"{0}\"> and set
>> > the jndiConnectionFactoryName ?
>>
>> Be sure to configure a ... and set the jndiConnectionFactoryName.
>>
>> > +JMSCONFIGFEATURE_ONLY_JMS = You can only use JMSConfigFeature with the
>> > jms transport
>>
>> JMSConfigFeature can only be used with jms transport.
>>
>> > +JMSCONFIG_REQUIRED = You have to set the property jmsConfig
>>
>> Property jmsConfig has to be set -or- was not set -or- must be set
>>
>> --
>> View this message in context:
>> http://www.nabble.com/Re%3A-svn-commit%3A-r702656---in--cxf-trunk-rt-transports-jms-src%3A-main-java-org-apache-cxf-transport-jms--test-java-org-apache-cxf-transport-jms--tp19869512p19869512.html
>> Sent from the cxf-dev mailing list archive at Nabble.com.
>>
>>
> 
> 

-- 
View this message in context: http://www.nabble.com/Re%3A-svn-commit%3A-r702656---in--cxf-trunk-rt-transports-jms-src%3A-main-java-org-apache-cxf-transport-jms--test-java-org-apache-cxf-transport-jms--tp19869512p19869996.html
Sent from the cxf-dev mailing list archive at Nabble.com.


Re: svn commit: r702656 - in /cxf/trunk/rt/transports/jms/src: main/java/org/apache/cxf/transport/jms/ test/java/org/apache/cxf/transport/jms/

Posted by Eric Johnson <er...@iona.com>.
I like the use of "you" also. It  avoids needlessly convoluted syntax
and it makes the messages a little more personal.

That said consistency is king.

How about:

Configure a <jms:conduit name=\"{0}\"> and set the
jndiConnectionFactoryName.

The jmsConfig property is required.

Benson's suggestion for the second error message is perfect.


> 
On Tue, 2008-10-07 at 19:28 -0400, Benson Margulies wrote:
> Well, I've always liked technical writing that uses 'you' to avoid the
> passive. Since this is a config error, it seems to me to have an audience
> that can handle a you. But that's just my opinion.
> 
> On Tue, Oct 7, 2008 at 7:25 PM, Glen Mazza <gl...@gmail.com> wrote:
> 
> >
> > Christian, usage of "you" is somewhat uncommon in error messages, wouldn't
> > you say?  Although I think it's more permissable for the first two messages
> > below, because you're asking a question, but normally the latter two should
> > avoid "you".
> >
> > Glen
> >
> > cschneider-2 wrote:
> > >
> > >  DISPATCH_FAILURE_MSG = Dispatch of incoming JMS request failed
> > > +INSUFFICIENT_CONFIGURATION_CONDUIT = Insufficient configuration for
> > > Conduit. Did you configure a <jms:conduit name=\"{0}\"> and set the
> > > jndiConnectionFactoryName ?
> >
> > Be sure to configure a ... and set the jndiConnectionFactoryName.
> >
> > > +INSUFFICIENT_CONFIGURATION_DESTINATION = Insufficient configuration for
> > > Destination. Did you configure a <jms:destination name=\"{0}\"> and set
> > > the jndiConnectionFactoryName ?
> >
> > Be sure to configure a ... and set the jndiConnectionFactoryName.
> >
> > > +JMSCONFIGFEATURE_ONLY_JMS = You can only use JMSConfigFeature with the
> > > jms transport
> >
> > JMSConfigFeature can only be used with jms transport.
> >
> > > +JMSCONFIG_REQUIRED = You have to set the property jmsConfig
> >
> > Property jmsConfig has to be set -or- was not set -or- must be set
> >
> > --
> > View this message in context:
> > http://www.nabble.com/Re%3A-svn-commit%3A-r702656---in--cxf-trunk-rt-transports-jms-src%3A-main-java-org-apache-cxf-transport-jms--test-java-org-apache-cxf-transport-jms--tp19869512p19869512.html
> > Sent from the cxf-dev mailing list archive at Nabble.com.
> >
> >

Re: svn commit: r702656 - in /cxf/trunk/rt/transports/jms/src: main/java/org/apache/cxf/transport/jms/ test/java/org/apache/cxf/transport/jms/

Posted by Benson Margulies <bi...@gmail.com>.
Well, I've always liked technical writing that uses 'you' to avoid the
passive. Since this is a config error, it seems to me to have an audience
that can handle a you. But that's just my opinion.

On Tue, Oct 7, 2008 at 7:25 PM, Glen Mazza <gl...@gmail.com> wrote:

>
> Christian, usage of "you" is somewhat uncommon in error messages, wouldn't
> you say?  Although I think it's more permissable for the first two messages
> below, because you're asking a question, but normally the latter two should
> avoid "you".
>
> Glen
>
> cschneider-2 wrote:
> >
> >  DISPATCH_FAILURE_MSG = Dispatch of incoming JMS request failed
> > +INSUFFICIENT_CONFIGURATION_CONDUIT = Insufficient configuration for
> > Conduit. Did you configure a <jms:conduit name=\"{0}\"> and set the
> > jndiConnectionFactoryName ?
>
> Be sure to configure a ... and set the jndiConnectionFactoryName.
>
> > +INSUFFICIENT_CONFIGURATION_DESTINATION = Insufficient configuration for
> > Destination. Did you configure a <jms:destination name=\"{0}\"> and set
> > the jndiConnectionFactoryName ?
>
> Be sure to configure a ... and set the jndiConnectionFactoryName.
>
> > +JMSCONFIGFEATURE_ONLY_JMS = You can only use JMSConfigFeature with the
> > jms transport
>
> JMSConfigFeature can only be used with jms transport.
>
> > +JMSCONFIG_REQUIRED = You have to set the property jmsConfig
>
> Property jmsConfig has to be set -or- was not set -or- must be set
>
> --
> View this message in context:
> http://www.nabble.com/Re%3A-svn-commit%3A-r702656---in--cxf-trunk-rt-transports-jms-src%3A-main-java-org-apache-cxf-transport-jms--test-java-org-apache-cxf-transport-jms--tp19869512p19869512.html
> Sent from the cxf-dev mailing list archive at Nabble.com.
>
>