Re: [tdf-discuss] "Error in scripting framework"

I apologize for the length of my comment.  Also for the length of
the lines; turn of wrapping if you can.

On Fri, 2011-09-16 at 00:48 -0400, Andrew Douglas Pitonyak wrote:
> On 09/12/2011 11:39 AM, Olivier Hallot wrote:
> > Couldn't we write just "Oh dear, I am unable to find a macro you asked me to
> > execute!"?
>
> What I would prefer to see on an error is:
>
> <error for a dummy>
> <error for a technical person>
>
> Rather than just <error for a dummy>
>
> The trick is to find a way to express the error such that a 
> non-technical person is not horrified, yet, a technical person has a 
> chance to find the actual problem. A dialog with a details button is great.

IMHO, the messages on the IBM i, a.k.a. AS/400, do a good
job of providing a second level of explanation.  I am used
to a system which lets me dig deeper into a message; it
feels strange not to have this available.

(For the examples, remember that the user being addressed is
a programmer.  That is the reason for the programming
jargon; the technology lets you use the jargon you choose.)

In the images here, the text of "Message" is what the user
sees first.  For more, the system displays "Message",
"Cause", and "Recovery".  Some messages have an additional
"Technical description" which gives information expected to
be less commonly interesting.

For example, here is the English definition of one message.
Items of the form "&<digit-string>" are place-holders for
items to be supplied by the program at run-time.

|                         Display Formatted Message Text
|                                                              System:   PUB1
|  Message ID . . . . . . . . . :   CPF2103
|  Message file . . . . . . . . :   QCPFMSG
|    Library  . . . . . . . . . :     QSYS
| 
|  Message . . . . :   Library &1 already exists in library list.
|  Cause . . . . . :   The library &1 already exists in the library search list.
|    The library was not added.
|  Recovery  . . . :   If &1 is the library you specified omit the command. If
|    you did not specify library &1 then change the library name (LIB parameter).
|    Then try the command again.

Oooh.  I think I know how to make that happen.  Here is a
bit of the terminal session.  The right pointy bracket is
this system's analog of the trailing "$" of a bash prompt
string.

| Previous commands and messages:
|     > addlible tenger1
|       Library TENGER1 added to library list.
|     > addlible tenger1
|       Library TENGER1 already exists in library list.

Digging into the completion message from the second command
above, we see ...

|                          Additional Message Information
| 
|  Message ID . . . . . . :   CPF2103       Severity . . . . . . . :   40
|  Message type . . . . . :   Escape
|  Date sent  . . . . . . :   09/16/11      Time sent  . . . . . . :   11:50:28
| 
|  Message . . . . :   Library TENGER1 already exists in library list.
|  Cause . . . . . :   The library TENGER1 already exists in the library search
|    list. The library was not added.
|  Recovery  . . . :   If TENGER1 is the library you specified omit the command.
|    If you did not specify library TENGER1 then change the library name (LIB
|    parameter). Then try the command again.

The message has an existence independent of its appearance
on the screen.  Just for fun, let me change the date format
of my job to one I like better and look at the same message
again.

|                          Additional Message Information
| 
|  Message ID . . . . . . :   CPF2103       Severity . . . . . . . :   40
|  Message type . . . . . :   Escape
|  Date sent  . . . . . . :   11/09/16      Time sent  . . . . . . :   11:50:28
| 
|  Message . . . . :   Library TENGER1 already exists in library list.
|  Cause . . . . . :   The library TENGER1 already exists in the library search
|    list. The library was not added.
|  Recovery  . . . :   If TENGER1 is the library you specified omit the command.
|    If you did not specify library TENGER1 then change the library name (LIB
|    parameter). Then try the command again.

Another benefit of the technology is that the program is
generally unconcerned with the language of the display.
Here is the message description in German ...

|                          Display Formatted Message Text
|                                                              System:   PUB1
|  Message ID . . . . . . . . . :   CPF2103
|  Message file . . . . . . . . :   QCPFMSG
|    Library  . . . . . . . . . :     QSYS2929
| 
|  Nachricht . . . :   Bibliothek &1 in Bibliotheksliste bereits vorhanden.
|  Ursache  . . . . :  Die Bibliothek &1 ist in der Bibliothekssuchliste bereits
|    vorhanden. Die Bibliothek wurde nicht hinzugef�gt.
|  Fehlerbeseitigung:  Wenn &1 die angegebne Bibliothek ist, den Befehl
|    auslassen. Wurde Bibliothek &1 nicht angegeben, dann den Bibliotheksnamen
|    (Parameter LIB) �ndern. Anschlie�end den Befehl wiederholen.

and a message instance ... 

|                          Additional Message Information
| 
|  Message ID . . . . . . :   CPF2103       Severity . . . . . . . :   40
|  Message type . . . . . :   Escape
|  Sendedatum . . . . . . :   11/09/16      Sendezeit  . . . . . . :   12:32:01
| 
|  Nachricht . . . :   Bibliothek TENGER1 in Bibliotheksliste bereits vorhanden.
|  Ursache  . . . . :  Die Bibliothek TENGER1 ist in der Bibliothekssuchliste
|    bereits vorhanden. Die Bibliothek wurde nicht hinzugef�gt.
|  Fehlerbeseitigung:  Wenn TENGER1 die angegebne Bibliothek ist, den Befehl
|    auslassen. Wurde Bibliothek TENGER1 nicht angegeben, dann den
|    Bibliotheksnamen (Parameter LIB) �ndern. Anschlie�end den Befehl
|    wiederholen.

> Now, that said, we would need to have a chat with the developers to make 
> that happen

Well, Base already does that in at least one situation.  I
attach three screenshots.

I hope this was a bit interesting.

Terry.


-- 
Unsubscribe instructions: E-mail to discuss+help@documentfoundation.org
Problems? http://www.libreoffice.org/get-help/mailing-lists/how-to-unsubscribe/
Posting guidelines + more: http://wiki.documentfoundation.org/Netiquette
List archive: http://listarchives.documentfoundation.org/www/discuss/
All messages sent to this list will be publicly archived and cannot be deleted