Skip to content

Commit 388506b

Browse files
committed
Updated help file in preparation for 5.6.8 release.
1 parent 9e96160 commit 388506b

328 files changed

Lines changed: 5188 additions & 4542 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

Documentation/CodeGen.chm

56 Bytes
Binary file not shown.

Documentation/CodeGen.hsm

8 Bytes
Binary file not shown.

docs/css/topics/style.css

Lines changed: 120 additions & 82 deletions
Large diffs are not rendered by default.

docs/index.htm

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
99
<meta name="generator" content="HelpSmith 8.4 (Build 20.825)" />
1010
<link type="text/css" rel="stylesheet" href="css/index.css?e72569b7" />
11-
<link type="text/css" rel="stylesheet" href="css/indexu.css?fa37b6cd" />
11+
<link type="text/css" rel="stylesheet" href="css/indexu.css?d6764f70" />
1212
<script type="text/javascript" src="js/jquery-3.5.1.min.js"></script>
1313
<script type="text/javascript" src="js/core.min.js?e72569b7"></script>
14-
<script type="text/javascript" src="js/settings.js?fa37b6cd"></script>
14+
<script type="text/javascript" src="js/settings.js?d6764f70"></script>
1515
<script type="text/javascript" src="js/index.min.js?e72569b7"></script>
16-
<script type="text/javascript" src="js/topic-table.min.js?fa37b6cd" charset="UTF-8"></script>
16+
<script type="text/javascript" src="js/topic-table.min.js?d6764f70" charset="UTF-8"></script>
1717
<!-- Web Help IndexPage -->
1818

1919

docs/js/search-index.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/js/topic-table.min.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/navi.htm

Lines changed: 683 additions & 675 deletions
Large diffs are not rendered by default.

docs/topics/buttonloopexpansiontokens.htm

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
3636
<script type="text/javascript" src="../js/jquery-3.5.1.min.js"></script>
3737
<script type="text/javascript" src="../js/nsa.js?e72569b7"></script>
38-
<script type="text/javascript" src="../js/settings.js?fa37b6cd"></script>
38+
<script type="text/javascript" src="../js/settings.js?d6764f70"></script>
3939
<script type="text/javascript" src="../js/core.min.js?e72569b7"></script>
4040
<script type="text/javascript" src="../js/topic.min.js?e72569b7"></script>
4141
<script type="text/javascript">

docs/topics/buttonloopexpressiontokens.htm

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
3636
<script type="text/javascript" src="../js/jquery-3.5.1.min.js"></script>
3737
<script type="text/javascript" src="../js/nsa.js?e72569b7"></script>
38-
<script type="text/javascript" src="../js/settings.js?fa37b6cd"></script>
38+
<script type="text/javascript" src="../js/settings.js?d6764f70"></script>
3939
<script type="text/javascript" src="../js/core.min.js?e72569b7"></script>
4040
<script type="text/javascript" src="../js/topic.min.js?e72569b7"></script>
4141
<script type="text/javascript">
@@ -53,7 +53,7 @@
5353
<div id="content-background">
5454
<div id="content">
5555
<p>&nbsp;</p>
56-
<p class="ps0"><span class="ts2">Button loop </span><a href="expressiontokens.htm" class="hs0">expressions </a><span class="ts2">are expressions that can only be used within the context of a </span><a href="buttonloops.htm" class="hs0">button loop</a><span class="ts4">&nbsp;</span><span class="ts2">and allow you to conditionally include or exclude code based on the attributes of the current button. </span></p>
56+
<p class="ps0"><span class="ts2">Button loop </span><a href="expressiontokens.htm" class="hs0">expressions </a><span class="ts2">are expressions that can only be used within the context of a </span><a href="buttonloops.htm" class="hs0">button loop</a><span class="ts3">&nbsp;</span><span class="ts2">and allow you to conditionally include or exclude code based on the attributes of the current button. </span></p>
5757
<div class="block0">
5858
<table class="tbl1">
5959
<tr class="row0">
@@ -66,63 +66,63 @@
6666
</tr>
6767
<tr class="row0">
6868
<td class="cell78">
69-
<p class="ps0"><a id="CANCELBUTTON"></a><span class="ts3">&lt;IF CANCELBUTTON&gt;</span></p>
69+
<p class="ps0"><a id="CANCELBUTTON"></a><span class="ts4">&lt;IF CANCELBUTTON&gt;</span></p>
7070
</td>
7171
<td class="cell79">
7272
<p class="ps0"><span class="ts2">The button is a Cancel button.</span></p>
7373
</td>
7474
</tr>
7575
<tr class="row0">
7676
<td class="cell78">
77-
<p class="ps0"><a id="CAPTION"></a><span class="ts3">&lt;IF CAPTION&gt;</span></p>
77+
<p class="ps0"><a id="CAPTION"></a><span class="ts4">&lt;IF CAPTION&gt;</span></p>
7878
</td>
7979
<td class="cell79">
8080
<p class="ps0"><span class="ts2">The button has a caption specified.</span></p>
8181
</td>
8282
</tr>
8383
<tr class="row0">
8484
<td class="cell80">
85-
<p class="ps0"><a id="ELB"></a><span class="ts3">&lt;IF ELB&gt;</span></p>
85+
<p class="ps0"><a id="ELB"></a><span class="ts4">&lt;IF ELB&gt;</span></p>
8686
</td>
8787
<td class="cell81">
8888
<p class="ps0"><span class="ts2">The event handler method is specified to be in an external ELB.</span></p>
8989
</td>
9090
</tr>
9191
<tr class="row0">
9292
<td class="cell80">
93-
<p class="ps0"><a id="GENERICBUTTON"></a><span class="ts3">&lt;IF GENERICBUTTON&gt;</span></p>
93+
<p class="ps0"><a id="GENERICBUTTON"></a><span class="ts4">&lt;IF GENERICBUTTON&gt;</span></p>
9494
</td>
9595
<td class="cell82">
9696
<p class="ps0"><span class="ts2">The button is a generic button (i.e. it is not an OK or Cancel button).</span></p>
9797
</td>
9898
</tr>
9999
<tr class="row0">
100100
<td class="cell78">
101-
<p class="ps0"><a id="IMAGE"></a><span class="ts3">&lt;IF IMAGE&gt;</span></p>
101+
<p class="ps0"><a id="IMAGE"></a><span class="ts4">&lt;IF IMAGE&gt;</span></p>
102102
</td>
103103
<td class="cell83">
104104
<p class="ps0"><span class="ts2">The button has an image file specified.</span></p>
105105
</td>
106106
</tr>
107107
<tr class="row0">
108108
<td class="cell78">
109-
<p class="ps0"><a id="METHOD"></a><span class="ts3">&lt;IF METHOD&gt;</span></p>
109+
<p class="ps0"><a id="METHOD"></a><span class="ts4">&lt;IF METHOD&gt;</span></p>
110110
</td>
111111
<td class="cell83">
112112
<p class="ps0"><span class="ts2">The image has an event handler method specified.</span></p>
113113
</td>
114114
</tr>
115115
<tr class="row0">
116116
<td class="cell78">
117-
<p class="ps0"><a id="OKBUTTON"></a><span class="ts3">&lt;IF OKBUTTON&gt;</span></p>
117+
<p class="ps0"><a id="OKBUTTON"></a><span class="ts4">&lt;IF OKBUTTON&gt;</span></p>
118118
</td>
119119
<td class="cell83">
120120
<p class="ps0"><span class="ts2">The button is an OK button.</span></p>
121121
</td>
122122
</tr>
123123
<tr class="row0">
124124
<td class="cell78">
125-
<p class="ps0"><a id="QUICKSELECT"></a><span class="ts3">&lt;IF QUICKSELECT&gt;</span></p>
125+
<p class="ps0"><a id="QUICKSELECT"></a><span class="ts4">&lt;IF QUICKSELECT&gt;</span></p>
126126
</td>
127127
<td class="cell83">
128128
<p class="ps0"><span class="ts2">The button has a quick-select character specified.</span></p>

docs/topics/buttonloops.htm

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
3636
<script type="text/javascript" src="../js/jquery-3.5.1.min.js"></script>
3737
<script type="text/javascript" src="../js/nsa.js?e72569b7"></script>
38-
<script type="text/javascript" src="../js/settings.js?fa37b6cd"></script>
38+
<script type="text/javascript" src="../js/settings.js?d6764f70"></script>
3939
<script type="text/javascript" src="../js/core.min.js?e72569b7"></script>
4040
<script type="text/javascript" src="../js/topic.min.js?e72569b7"></script>
4141
<script type="text/javascript">
@@ -54,29 +54,29 @@
5454
<div id="content">
5555
<p>&nbsp;</p>
5656
<p class="ps0"><span class="ts2">A button loop is a </span><a href="templatefiles.htm" class="hs0">template file</a><span class="ts2">&nbsp;construct which allows you to iterate through the collection of buttons that CodeGen has information about.</span></p>
57-
<p class="ps0"><span class="ts2">The definition of the buttons processed in a button loop can come from one of two places.&nbsp; If you are processing based on a UI Toolkit input window definition then by default the collection of buttons is determined by the buttons found in that input window definition.&nbsp; Otherwise the button collection is defined by a configuration file called </span><span class="ts3">DefaultButtons.xml</span><span class="ts2">, which you will find in the folder that you installed CodeGen into.</span></p>
58-
<p class="ps0"><span class="ts2">Note: Even if you are processing based on a UI Toolkit input window definition, you can chose to ignore the definition of buttons found in the window and use the definitions from </span><span class="ts3">DefaultButtons.xml</span><span class="ts2">&nbsp;via the </span><a href="commandlinereference.htm#option_b" class="hs0">&ndash;b&nbsp;command line option</a><span class="ts2">.</span></p>
59-
<p class="ps0"><span class="ts2">Button loops are delimited by a matching pair of </span><span class="ts4">&lt;BUTTON_LOOP&gt;</span><span class="ts2">&nbsp;and </span><span class="ts4">&lt;/BUTTON_LOOP&gt;</span><span class="ts2">&nbsp;tags that surround the template code to be inserted for each button.&nbsp; The code between the opening and closing tags of a button loop is repeated for each button in the button collection.</span></p>
57+
<p class="ps0"><span class="ts2">The definition of the buttons processed in a button loop can come from one of two places.&nbsp; If you are processing based on a UI Toolkit input window definition then by default the collection of buttons is determined by the buttons found in that input window definition.&nbsp; Otherwise the button collection is defined by a configuration file called </span><span class="ts4">DefaultButtons.xml</span><span class="ts2">, which you will find in the folder that you installed CodeGen into.</span></p>
58+
<p class="ps0"><span class="ts2">Note: Even if you are processing based on a UI Toolkit input window definition, you can chose to ignore the definition of buttons found in the window and use the definitions from </span><span class="ts4">DefaultButtons.xml</span><span class="ts2">&nbsp;via the </span><a href="commandlinereference.htm#option_b" class="hs0">&ndash;b&nbsp;command line option</a><span class="ts2">.</span></p>
59+
<p class="ps0"><span class="ts2">Button loops are delimited by a matching pair of </span><span class="ts3">&lt;BUTTON_LOOP&gt;</span><span class="ts2">&nbsp;and </span><span class="ts3">&lt;/BUTTON_LOOP&gt;</span><span class="ts2">&nbsp;tags that surround the template code to be inserted for each button.&nbsp; The code between the opening and closing tags of a button loop is repeated for each button in the button collection.</span></p>
6060
<p class="ps0"><span class="ts2">Button loop tokens are tokens that can only be used within a button loop:</span></p>
6161
<p class="ps1"><span style="font-size: 14pt; line-height: 0; vertical-align: middle; color: Black">&bull;</span><span style="display: inline-block; width: 18px"></span><a href="buttonloopexpansiontokens.htm" class="hs0">Button Loop Expansion Tokens</a></p>
6262
<p class="ps1"><span style="font-size: 14pt; line-height: 0; vertical-align: middle; color: Black">&bull;</span><span style="display: inline-block; width: 18px"></span><a href="buttonloopexpressiontokens.htm" class="hs0">Button Loop Expression Tokens</a></p>
6363
<p class="ps0"><span class="ts2">There are two types of button loop, multi-line button loops and in-line button loops.</span></p>
6464
<p class="ps0"><span class="ts1">Multi-Line Button Loops</span></p>
6565
<p class="ps0"><span class="ts2">Multi-line button loops occur when the opening and closing button loop tags appear on separate lines in a template file, and delimit one or more entire lines of template code, like this:</span></p>
66-
<p class="ps9"><span class="ts3">[code]</span><br /><span class="ts4">&lt;BUTTON_LOOP&gt;</span><br /><span class="ts4">code</span><br /><span class="ts4">&lt;/BUTTON_LOOP&gt;</span><br /><span class="ts3">[code]</span></p>
66+
<p class="ps9"><span class="ts4">[code]</span><br /><span class="ts3">&lt;BUTTON_LOOP&gt;</span><br /><span class="ts3">code</span><br /><span class="ts3">&lt;/BUTTON_LOOP&gt;</span><br /><span class="ts4">[code]</span></p>
6767
<p class="ps0"><span class="ts2">Multi-line button loops generate one or more lines of output code for each button that is processed.</span></p>
6868
<p class="ps0"><span class="ts1">In-Line Button Loops</span></p>
6969
<p class="ps0"><span class="ts2">In-line button loops exist when the opening and closing button loop tags appear on the same line in a template file, and delimit part of a line of template code, like this:</span></p>
70-
<p class="ps9"><span class="ts3">[code] </span><span class="ts4">&lt;BUTTON_LOOP&gt; code &lt;/BUTTON_LOOP&gt;</span><span class="ts3">&nbsp;[code]</span></p>
70+
<p class="ps9"><span class="ts4">[code] </span><span class="ts3">&lt;BUTTON_LOOP&gt; code &lt;/BUTTON_LOOP&gt;</span><span class="ts4">&nbsp;[code]</span></p>
7171
<p class="ps0"><span class="ts2">In-line button loops generate code into the current output line only.</span></p>
7272
<p class="ps0"><span class="ts1">Default Buttons</span></p>
73-
<p class="ps0"><span class="ts2">The default buttons are defined in </span><span class="ts3">DefaultButtons.xml</span><span class="ts2">, as follows:</span></p>
74-
<p class="ps9"><span class="ts3">&lt;?xml version='1.0'?&gt;</span><br /><span class="ts3">&lt;CodeGenDefaultButtons&gt;</span><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="ts3">&lt;Button name=&quot;Ok&quot; caption=&quot;OK&quot; image=&quot;&quot; method=&quot;&quot; elb=&quot;&quot; quickselect=&quot;O&quot; /&gt;</span><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="ts3">&lt;Button name=&quot;Cancel&quot; caption=&quot;Cancel&quot; image=&quot;&quot; method=&quot;&quot; elb=&quot;&quot; quickselect=&quot;C&quot; /&gt;</span><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="ts3">&lt;Button name=&quot;Help&quot; caption=&quot;Help&quot; image=&quot;&quot; method=&quot;&quot; elb=&quot;&quot;quickselect=&quot;H&quot; /&gt;</span><br /><span class="ts3">&lt;/CodeGenDefaultButtons&gt;</span></p>
73+
<p class="ps0"><span class="ts2">The default buttons are defined in </span><span class="ts4">DefaultButtons.xml</span><span class="ts2">, as follows:</span></p>
74+
<p class="ps9"><span class="ts4">&lt;?xml version='1.0'?&gt;</span><br /><span class="ts4">&lt;CodeGenDefaultButtons&gt;</span><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="ts4">&lt;Button name=&quot;Ok&quot; caption=&quot;OK&quot; image=&quot;&quot; method=&quot;&quot; elb=&quot;&quot; quickselect=&quot;O&quot; /&gt;</span><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="ts4">&lt;Button name=&quot;Cancel&quot; caption=&quot;Cancel&quot; image=&quot;&quot; method=&quot;&quot; elb=&quot;&quot; quickselect=&quot;C&quot; /&gt;</span><br />&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<span class="ts4">&lt;Button name=&quot;Help&quot; caption=&quot;Help&quot; image=&quot;&quot; method=&quot;&quot; elb=&quot;&quot;quickselect=&quot;H&quot; /&gt;</span><br /><span class="ts4">&lt;/CodeGenDefaultButtons&gt;</span></p>
7575
<p class="ps0"><span class="ts1">Special Button Processing</span></p>
7676
<p class="ps0"><span class="ts2">When generating application source code, and in particular forms, it is often useful to be able to identify a button as either an &quot;OK&quot; button (which generally saves the data and closes the form) or a &quot;Cancel&quot; button (which closes the form without saving the data). Unfortunately there is no way to easily identify this from information in a UI Toolkit input window script.</span></p>
7777
<p class="ps0"><span class="ts2">CodeGen considers a button to be an &quot;OK&quot; button if the term &quot;OK&quot; appears in either the name or caption of the button.</span></p>
7878
<p class="ps0"><span class="ts2">CodeGen considers a button to be a &quot;Cancel&quot; button if the word &quot;Cancel&quot; appears in the buttons name or caption, or if the word &quot;abandon&quot; appears in the buttons name (UI Toolkit programmers often name the cancel button O_ABANDON).</span></p>
79-
<p class="ps0"><span class="ts2">The status a button as either an OK or Cancel button can be tested with the button loop expressions </span><span class="ts3">&lt;IF OKBUTTON&gt;</span><span class="ts2">&nbsp;and </span><span class="ts3">&lt;IF CANCELBUTTON&gt;</span><span class="ts2">.</span></p>
79+
<p class="ps0"><span class="ts2">The status a button as either an OK or Cancel button can be tested with the button loop expressions </span><span class="ts4">&lt;IF OKBUTTON&gt;</span><span class="ts2">&nbsp;and </span><span class="ts4">&lt;IF CANCELBUTTON&gt;</span><span class="ts2">.</span></p>
8080
<p class="ps0"><span class="ts2">&nbsp;</span></p>
8181
<p><span class="ts2">&nbsp;</span></p>
8282
<p><span class="ts2">&nbsp;</span></p>

0 commit comments

Comments
 (0)