110 lines
7.2 KiB
HTML
110 lines
7.2 KiB
HTML
|
<?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="task" />
|
||
|
|
<meta name="DC.Title" content="Generate UIM source for command help" />
|
||
|
|
<meta name="abstract" content="You can generate online help for commands using the GENCMDDOC command." />
|
||
|
|
<meta name="description" content="You can generate online help for commands using the GENCMDDOC command." />
|
||
|
|
<meta name="DC.subject" content="GENCMDDOC (Generate Command Documentation) command, CL program, Generate Command Documentation (GENCMDDOC) command, CL program, UIM (user interface manager), User interface manager (UIM)" />
|
||
|
|
<meta name="keywords" content="GENCMDDOC (Generate Command Documentation) command, CL program, Generate Command Documentation (GENCMDDOC) command, CL program, UIM (user interface manager), User interface manager (UIM)" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="clhelp.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../cl/crtpnlgrp.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../cl/gencmddoc.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="genuim" />
|
||
|
|
<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>Generate UIM source for command help</title>
|
||
|
|
</head>
|
||
|
|
<body id="genuim"><a name="genuim"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">Generate UIM source for command help</h1>
|
||
|
|
<div><p>You can generate online help for commands using the GENCMDDOC command.</p>
|
||
|
|
<div class="section"> <p>As a simpler alternative to learning UIM syntax, you can use
|
||
|
|
the <span class="cmdname">Generate Command Documentation (GENCMDDOC)</span> command.
|
||
|
|
This command allows you to create a file containing UIM source; the file provides
|
||
|
|
a template for the online command help. To create the UIM source, you need
|
||
|
|
to specify *UIM for the GENOPT (Generation Options) parameter. The information
|
||
|
|
used to create the template is retrieved from the command object (*CMD) you
|
||
|
|
specify. Using <span class="cmdname">Generate Command Documentation (GENCMDDOC)</span> to
|
||
|
|
create the UIM source can simplify writing online help for your CL commands.</p>
|
||
|
|
<p>The
|
||
|
|
following is an example of using the <span class="cmdname">Generate Command Documentation
|
||
|
|
(GENCMDDOC)</span> command to generate a UIM template: </p>
|
||
|
|
<pre>GENCMDDOC CMD(MYLIB/MYCMD)
|
||
|
|
TODIR('/QSYS.LIB/MYLIB.LIB/QPNLSRC.FILE')
|
||
|
|
TOSTMF(*CMD) GENOPT(*UIM)</pre>
|
||
|
|
<p>In the example, the command retrieves information from the
|
||
|
|
command object named MYCMD in library MYLIB and generates UIM source into
|
||
|
|
member MYCMD of source file QPNLSRC in library MYLIB. After the template
|
||
|
|
UIM source has been generated, you will need to edit the UIM source as follows:
|
||
|
|
</p>
|
||
|
|
<ul><li>Ensure that the command-level help module describes the purpose of the
|
||
|
|
command. The start of the first sentence is provided followed by a <strong><...></strong> marker
|
||
|
|
that you need to replace with the appropriate text. Ensure that restrictions
|
||
|
|
that apply to running the command are described, such as commands that must
|
||
|
|
be run first, or special authorizations needed. Some example restrictions
|
||
|
|
are provided; you should edit these to match your command's restrictions.</li>
|
||
|
|
<li>Ensure that each parameter-level help module explains the purpose of the
|
||
|
|
parameter. The start of the first sentence is provided followed by a <strong><...></strong> marker
|
||
|
|
that you need to replace with the appropriate text. You may also want to
|
||
|
|
describe any inter-parameter dependencies or restrictions; you can use the
|
||
|
|
:NT. (Note) and :ENT. (End of Note) UIM tags for these parameter-level restrictions.
|
||
|
|
<p>The parameter-level help module also should provide a description of
|
||
|
|
the possible choices for the parameter. Headings for each special value
|
||
|
|
or single value are provided, but you need to replace the <strong><...></strong> markers
|
||
|
|
with the parameter value descriptions.</p>
|
||
|
|
</li>
|
||
|
|
<li>Ensure that examples are provided as needed. The command examples help
|
||
|
|
module is primed with headings for two examples. If the command has no parameters,
|
||
|
|
you could edit this help module to have only a single example.
|
||
|
|
If the command has many parameters, or provides several distinct functions,
|
||
|
|
you can copy the headings to create additional command examples. You need
|
||
|
|
to edit the command examples to insert your own commands' parameter keywords
|
||
|
|
and parameter values and to replace the <strong><...></strong> markers with the
|
||
|
|
descriptions of what the example commands would do.</li>
|
||
|
|
<li>Ensure that error message text is provided as needed. The command error
|
||
|
|
messages help module is primed with headings showing how you can use the &MSG.
|
||
|
|
built-in function to imbed the message text of error messages sent by the
|
||
|
|
command. You need to edit the list of messages to contain the actual message
|
||
|
|
identifiers of messages signaled from your command, along with the message
|
||
|
|
file that contains the message descriptions.</li>
|
||
|
|
</ul>
|
||
|
|
<p>Once you've edited the UIM source to tailor it to your command, you
|
||
|
|
can create the online help panel group by using the <span class="cmdname">Create Panel
|
||
|
|
Group (CRTPNLGRP)</span> command. The following is an example of using
|
||
|
|
the <span class="cmdname">Create Panel Group (CRTPNLGRP)</span> command: </p>
|
||
|
|
<pre> CRTPNLGRP PNLGRP(MYLIB/MYCMD)
|
||
|
|
SRCFILE(MYLIB/QPNLSRC) SRCMBR(MYCMD)</pre>
|
||
|
|
<p>This command attempts to create a panel group from the UIM
|
||
|
|
source in member MYCMD in source physical file QPNLSRC in library MYLIB.
|
||
|
|
If there are no severe errors found when compiling the UIM source, a panel
|
||
|
|
group (*PNLGRP) object named MYCMD is created in library MYCMD. The command
|
||
|
|
generates a spooled file, which can be viewed to see informational, warning,
|
||
|
|
and severe errors found by the UIM compiler.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="clhelp.htm" title="You can write online help to describe your commands for users.">Write command help</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relinfo"><strong>Related information</strong><br />
|
||
|
|
<div><a href="../cl/crtpnlgrp.htm">Create Panel Group (CRTPNLGRP) command</a></div>
|
||
|
|
<div><a href="../cl/gencmddoc.htm">Generate Command Documentation (GENCMDDOC) command</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|