Programming Format

For the programming format of messages, see the following list.

• Do not construct messages from clauses. Use flags or other means within the program to pass information so that a complete message can be issued at the proper time.

• Do not use hardcoded English text as a variable for a %s string in an existing message. This is also the construction of messages and is not translatable.

• Capitalize the first word of the sentence, and use a period at the end of the sentence or phrase.

• End the last line of the message with \n (backslash followed by a lowercase n, indicating a new line). This also applies to one-line messages.

• Begin the second and remaining lines of a message with \t (backslash followed by a lowercase t, indicating a tab).

• End all other lines with \n\ (backslash followed by a lowercase n, followed by another backslash, indicating a new line).

• If, for some reason, the message should not end with a new line, use a comment to tell the writers.

• Precede each message with the name of the command that called the message, followed by a colon. The command name should precede the component number in error messages. The command name is shown in the following example as it should appear in a message:

  OPIE "foo: Opening the file."