ibm-information-center/dist/eclipse/plugins/i5OS.ic.nls_5.4.0.1/rbagsonlinehelpdesign.htm

74 lines
4.9 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en-us" xml:lang="en-us">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="security" content="public" />
<meta name="Robots" content="index,follow" />
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
<meta name="DC.Type" content="concept" />
<meta name="DC.Title" content="Online help design" />
<meta name="abstract" content="You can define online help by using either panel groups or records." />
<meta name="description" content="You can define online help by using either panel groups or records." />
<meta name="DC.Relation" scheme="URI" content="rbagsuserinterfaceman.htm" />
<meta name="DC.Relation" scheme="URI" content="rbagscommanddesign.htm" />
<meta name="copyright" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 1998, 2006" />
<meta name="DC.Format" content="XHTML" />
<meta name="DC.Identifier" content="rbagsonlinehelpdesign" />
<meta name="DC.Language" content="en-us" />
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<link rel="stylesheet" type="text/css" href="./ibmdita.css" />
<link rel="stylesheet" type="text/css" href="./ic.css" />
<title>Online help design</title>
</head>
<body id="rbagsonlinehelpdesign"><a name="rbagsonlinehelpdesign"><!-- --></a>
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
<h1 class="topictitle1">Online help design</h1>
<div><p>You can define online help by using either panel groups or records.</p>
<p>By using either panel groups, <dfn class="term">online help</dfn> can be defined as
objects into which user interface manager (UIM) source is entered. By using
records, <dfn class="term">online help</dfn> can be defined as a set of DDS keywords
contained in a source file member.</p>
<p>If the user interface manager is used for defining online help, the panel
groups are defined either in place of DDS or in the display file. In either
case, the encoding of the data to be displayed must be indicated by the CHRID
value in the display file or the panel group. A panel group is an object that
can be used to contain help information. The operating system uses *PNLGRP
as an identifier for the object type that contains a collection of help information.</p>
<div class="section"><h4 class="sectiontitle">Guidelines: Online help</h4><p>When defining online help
information to be translated into national language versions, keep in mind
the following considerations about panel groups and records:</p>
<ul><li>Records do not have word processing available (functions such as spell
check and word wrap though system APIs exist to provide spell checking).</li>
<li>Various i5/OS™ messages and panel groups determine
the national language conventions and translations. Not all countries have
a national language version available for the operating system. Not all national
language versions are completely translated, with many parts still in English.
The messages and panel groups that are not translated do not reflect the national
language cultural conventions. The command design information includes an
example of a translated panel in which part of the panel has remained in English
because not all parts of the NLV were translated.</li>
<li>Allow for translation expansion.</li>
</ul>
</div>
<div class="section"><h4 class="sectiontitle">Guidelines: DDS online help design</h4><p>When multiple
languages are installed on one system, the help documents are stored in different
folders. The DDS source file needs to be copied, changed, and compiled again
for each language on the system.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="rbagsuserinterfaceman.htm" title="The i5/OS user interface manager (UIM) is a part of the system that allows you to define panels and dialogs for your application.">User interface manager</a></div>
</div>
<div class="relconcepts"><strong>Related concepts</strong><br />
<div><a href="rbagscommanddesign.htm" title="The i5/OS operating system allows users to define and create their own commands. To create a command, you must first define the command through command definition statements. Then use the Create Command (CRTCMD) command to process the command definition statements to create the command definition object.">Command design</a></div>
</div>
</div>
</body>
</html>