109 lines
6.5 KiB
HTML
109 lines
6.5 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="reference" />
|
||
|
|
<meta name="DC.Title" content="HLPDOC (Help Document) keyword for display files" />
|
||
|
|
<meta name="abstract" content="Use this file- or help-specification-level keyword to define the document to use as help information text for a specific location on the display." />
|
||
|
|
<meta name="description" content="Use this file- or help-specification-level keyword to define the document to use as help information text for a specific location on the display." />
|
||
|
|
<meta name="DC.subject" content="HLPDOC (Help Document) keyword, Help Document (HLPDOC) keyword" />
|
||
|
|
<meta name="keywords" content="HLPDOC (Help Document) keyword, Help Document (HLPDOC) keyword" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="rzakcmstkeyent.htm" />
|
||
|
|
<meta name="DC.Relation" scheme="URI" content="../dds/rbafpmstddsnam.htm" />
|
||
|
|
<meta name="copyright" content="(C) Copyright IBM Corporation 2001, 2006" />
|
||
|
|
<meta name="DC.Rights.Owner" content="(C) Copyright IBM Corporation 2001, 2006" />
|
||
|
|
<meta name="DC.Format" content="XHTML" />
|
||
|
|
<meta name="DC.Identifier" content="rzakcmstdfhlpdc" />
|
||
|
|
<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>HLPDOC (Help Document) keyword for display files </title>
|
||
|
|
</head>
|
||
|
|
<body id="rzakcmstdfhlpdc"><a name="rzakcmstdfhlpdc"><!-- --></a>
|
||
|
|
<!-- Java sync-link --><script language="Javascript" src="../rzahg/synch.js" type="text/javascript"></script>
|
||
|
|
<h1 class="topictitle1">HLPDOC (Help Document) keyword for display files </h1>
|
||
|
|
<div><p>Use this file- or help-specification-level keyword to define the
|
||
|
|
document to use as help information text for a specific location on the display.</p>
|
||
|
|
<div class="section"><div class="p">The format of the keyword is: <pre>HLPDOC(online-help-information-text-label-name document-name folder-name)</pre>
|
||
|
|
</div>
|
||
|
|
<p>The online-help-information-text-label-name parameter corresponds to a label
|
||
|
|
in the online help document and marks the point at which the document's display
|
||
|
|
begins.</p>
|
||
|
|
<p>The document-name parameter identifies the online document containing
|
||
|
|
the online help information.</p>
|
||
|
|
<p>The folder-name parameter identifies the
|
||
|
|
folder containing the document specified. Because folders can reside inside
|
||
|
|
other folders, and because any given folder or document name is only unique
|
||
|
|
within its containing folder, you might be required to concatenate
|
||
|
|
several folder names together to identify a document/folder. The folder name
|
||
|
|
you specify on the HLPDOC keyword can be a simple folder name, which follows
|
||
|
|
the same syntax rules as the document name, or you can specify the folder
|
||
|
|
name as a concatenated name.</p>
|
||
|
|
<p>The document specified on an H specification
|
||
|
|
level HLPDOC keyword is displayed if both of the following conditions are
|
||
|
|
true:</p>
|
||
|
|
<ul><li>The cursor is located in the help area (defined by HLPARA) for that H
|
||
|
|
specification.</li>
|
||
|
|
<li>The H specification is active. (The option indicator on the H specification
|
||
|
|
level HLPDOC keyword determines if the H specification is active.)</li>
|
||
|
|
</ul>
|
||
|
|
<p>The document specified on a file level HLPDOC keyword is displayed
|
||
|
|
when no help area for the active records contains the current cursor location.</p>
|
||
|
|
<p>You
|
||
|
|
cannot specify HLPDOC with HLPBDY, HLPPNLGRP, or HLPRTN.</p>
|
||
|
|
<p>Option indicators
|
||
|
|
are valid for this keyword.</p>
|
||
|
|
</div>
|
||
|
|
<div class="example"><h4 class="sectiontitle">Example</h4><p>The following example shows how to specify
|
||
|
|
the HLPDOC keyword.</p>
|
||
|
|
<pre>|...+....1....+....2....+....3....+....4....+....5....+....6....+....7....+....8
|
||
|
|
A HELP
|
||
|
|
A HLPDOC(START GENERAL.HLP HELP.F1)
|
||
|
|
A R REC1 OVERLAY
|
||
|
|
A H HLPDOC(LBL1 HELP#1 HELP.F1)
|
||
|
|
A HLPARA(10 3 12 50)
|
||
|
|
A H HLPARA(15 9 17 61)
|
||
|
|
A 90 HLPDOC(LBL2 HELP#2 HELP/FLD)
|
||
|
|
A H HLPARA(15 9 17 61)
|
||
|
|
A N90 HLPDOC(LBL3 HELP#3 HELP.F1/FLD)
|
||
|
|
A</pre>
|
||
|
|
<p>The HELP keyword enables the Help key.</p>
|
||
|
|
<p>The HLPDOC
|
||
|
|
keyword at the file level specifies that the GENERAL.HLP document in the HELP.F1
|
||
|
|
folder will be displayed starting at the START help label if the Help key
|
||
|
|
is pressed and the cursor is not in a help area defined by a HLPARA keyword
|
||
|
|
at the H specification level.</p>
|
||
|
|
<p>At the H specification level:</p>
|
||
|
|
<ul><li>The first H specification indicates that the HELP#1 document in the HELP.F1
|
||
|
|
folder will be displayed starting at the LBL1 help label if the Help key is
|
||
|
|
pressed and the cursor is in positions 3 through 50 of lines 10, 11, or 12.</li>
|
||
|
|
<li>The second H specification indicates that the HELP#2 document in the HELP/FLD
|
||
|
|
folder will be displayed starting at the LBL2 help label if the REC1 record
|
||
|
|
is put with indicator 90 on, the Help key is pressed, and the cursor is in
|
||
|
|
positions 9 through 61 of lines 15, 16, or 17.</li>
|
||
|
|
<li>The third H specification indicates that the HELP#3 document in the HELP.F1/FLD
|
||
|
|
folder will be displayed starting at the LBL3 help label if the REC1 record
|
||
|
|
is put with indicator 90 off, the Help key is pressed, and the cursor is in
|
||
|
|
positions 9 through 61 of lines 15, 16, or 17.</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div>
|
||
|
|
<div class="familylinks">
|
||
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="rzakcmstkeyent.htm" title="You type the keyword entries that define display files in positions 45 through 80 (functions).">DDS keyword entries for display files (positions 45 through 80)</a></div>
|
||
|
|
</div>
|
||
|
|
<div class="relref"><strong>Related reference</strong><br />
|
||
|
|
<div><a href="../dds/rbafpmstddsnam.htm">DDS naming conventions</a></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|