version 1.6, 2003/12/01 19:53:49
|
version 1.7, 2006/08/16 13:45:04
|
|
|
used as part of the table name inside the bundle.<br> | used as part of the table name inside the bundle.<br> |
</td> | </td> |
</tr> | </tr> |
|
<tr> |
|
<td style="vertical-align: top;">08/04/06<br> |
|
</td> |
|
<td style="vertical-align: top;">Marek Szermutzky<br> |
|
</td> |
|
<td style="vertical-align: top;">Section 2.2.5. Added information how to write platform specific messages.<br> |
|
</td> |
|
</tr> |
</tbody> | </tbody> |
</table> | </table> |
<p><br> | <p><br> |
|
|
String localizedMsg = MessageLoader::getMessage(parms); <br> | String localizedMsg = MessageLoader::getMessage(parms); <br> |
<br> | <br> |
</p> | </p> |
<h4> 2.2.4 Message Writing Guidelines</h4> |
<h4> 2.2.5 Message Writing Guidelines</h4> |
<p><br> | <p><br> |
Here are some basic rules for writing messages: <br> | Here are some basic rules for writing messages: <br> |
</p> | </p> |
|
|
ultimately the customer.</li> | ultimately the customer.</li> |
<li> <b>TODO </b>- find a good message writing guide to link to</li> | <li> <b>TODO </b>- find a good message writing guide to link to</li> |
</ul> | </ul> |
|
|
|
<p><b>When do I create a new message ?</b></p> |
|
|
|
<p>A new message should be created if a message is needed with a content not |
|
described by any existing message.</p> |
|
|
|
<p>A new message should be created if the number or placement of substitution |
|
parameters of an existing message would require an update.</p> |
|
|
|
<p>It is not necessary to create a new message if just the text of the message |
|
is changed, while the meaning is kept. For instance if the |
|
event(error,warning,whatever) is described more precisely by the new message |
|
text, it is not necessary to create a new message, but the existing one should |
|
be updated.</p> |
|
|
|
<p><b>How do I write a platform specific |
|
message ? </b></p> |
|
|
|
<p>Platform specific messages generate in a non-platform specific source file |
|
should be formatted with a .<platform> or .STANDARD suffix.</p> |
|
|
|
<p><i>Example:</i></p> |
|
<p>Compiler.cmdline.cimmof.cmdline.MENU.PEGASUS_OS_HPUX</p> |
|
<p>Compiler.cmdline.cimmof.cmdline.MENU.PEGASUS_OS_OS40</p> |
|
<p>Compiler.cmdline.cimmof.cmdline.MENU.STANDARD</p> |
|
|
|
<p> </p> |
|
|
|
<p><b>Where should I place platform specific |
|
messages ? </b></p> |
|
|
|
<p>As described in the message bundle file pegasusServer_en.txt messages belong |
|
into the section corresponding the file they are created in. This does account |
|
the same to platform specific messages.</p> |
|
<p>If a message is generated inside a source file not specific to a single |
|
platform, the message should be part of the message bundle section of that |
|
source file.</p> |
|
<p>If a new platform specific message is generated inside a platform specific |
|
source file, the message belongs to the platform specific section of the |
|
message bundle file.</p> |
|
|
|
<p><i>Examples:</i></p> |
|
|
|
<p>ProviderManager.ProviderAgent.ProviderAgent.UNINITIALIZED_SECURITY_SETUP.PEGASUS_OS_ZOS |
|
- this message is and should be part of the section for the ProviderAgent as it |
|
is generated inside the provider agent and not a z/OS platform specific file</p> |
|
<p>Common.safCheckzOS_inline.BAD_WBEM_SECURITY_SETUP - this message does and |
|
should reside inside the platform specific section as the message is generated |
|
in a z/OS platform only file</p> |
|
|
|
<p> </p> |
|
|
<h4> 2.2.5 Localized Exceptions</h4> | <h4> 2.2.5 Localized Exceptions</h4> |
<p><br> | <p><br> |
The base Exception class, and derived classes, have been updated to | The base Exception class, and derived classes, have been updated to |
|
|
</p> | </p> |
<p> </p> | <p> </p> |
<hr> | <hr> |
<p><i>Copyright (c) 2003 BMC Software; Hewlett-Packard Development |
<p><i> |
Company, L.P.; IBM Corp.; The Open Group</i> </p> |
Copyright (c) 2000, 2001, 2002 BMC Software; Hewlett-Packard Development |
<p><i>Permission is hereby granted, free of charge, to any person |
Company, L.P.; IBM Corp.; The Open Group; Tivoli Systems. |
obtaining a copy of this software and associated documentation |
Copyright (c) 2003 BMC Software; Hewlett-Packard Development Company, L.P.; |
files (the "Software"), to deal in the Software without restriction, |
IBM Corp.; EMC Corporation, The Open Group. |
including without limitation the rights to use, copy, modify, merge, |
Copyright (c) 2004 BMC Software; Hewlett-Packard Development Company, L.P.; |
publish, distribute, sublicense, and/or sell copies of the Software, and |
IBM Corp.; EMC Corporation; VERITAS Software Corporation; The Open Group. |
to permit persons to whom the Software is furnished to do so, subject |
Copyright (c) 2005 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
to the following conditions:</i> </p> |
EMC Corporation; VERITAS Software Corporation; The Open Group. |
<p><i>THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE |
Copyright (c) 2006 Hewlett-Packard Development Company, L.P.; IBM Corp.; |
INCLUDED IN ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE |
EMC Corporation; Symantec Corporation; The Open Group. |
SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
</i> </p> |
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
|
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. |
<p><i> |
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY |
Permission is hereby granted, free of charge, to any person obtaining a copy |
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, |
of this software and associated documentation files (the "Software"), to |
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE |
deal in the Software without restriction, including without limitation the |
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</i> <br> |
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
<br> |
sell copies of the Software, and to permit persons to whom the Software is |
</p> |
furnished to do so, subject to the following conditions: |
|
</i> </p> |
|
|
|
<p><i> |
|
THE ABOVE COPYRIGHT NOTICE AND THIS PERMISSION NOTICE SHALL BE INCLUDED IN |
|
ALL COPIES OR SUBSTANTIAL PORTIONS OF THE SOFTWARE. THE SOFTWARE IS PROVIDED |
|
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT |
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR |
|
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT |
|
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
|
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION |
|
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
|
</i> <br> |
|
<br> |
|
</p> |
</body> | </body> |
</html> | </html> |