Updated documentation for 5.9.7 release.

Synergex · Jun 9, 2023 · ac83dd4 · ac83dd4
1 parent fe3c020
commit ac83dd4
Show file tree

Hide file tree

Showing 134 changed files with 2,194 additions and 1,865 deletions.
diff --git a/Documentation/CodeGen.chm b/Documentation/CodeGen.chm
diff --git a/Documentation/CodeGen.hsmx b/Documentation/CodeGen.hsmx
diff --git a/docs/css/topics/style.css b/docs/css/topics/style.css
diff --git a/docs/index.htm b/docs/index.htm
@@ -8,16 +8,19 @@
 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 <meta name="generator" content="HelpSmith 9.6 (Build 23.117)" />
 <link type="text/css" rel="stylesheet" href="css/index.css?0edcc3c9" />
-<link type="text/css" rel="stylesheet" href="css/indexu.css?b2c00fb1" />
+<link type="text/css" rel="stylesheet" href="css/indexu.css?3855ee9e" />
 <script type="text/javascript" src="js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="js/core.min.js?0edcc3c9"></script>
-<script type="text/javascript" src="js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="js/index.min.js?0edcc3c9"></script>
-<script type="text/javascript" src="js/topic-table.min.js?b2c00fb1"></script>
+<script type="text/javascript" src="js/topic-table.min.js?3855ee9e"></script>
 <!-- Web Help IndexPage -->
 
 
 <!-- Web Help Layout -->
+
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="hs-header-d">

diff --git a/docs/js/search-index.min.js b/docs/js/search-index.min.js
diff --git a/docs/navi.htm b/docs/navi.htm
@@ -9,18 +9,21 @@
 <link type="text/css" rel="stylesheet" href="css/ui/jquery-ui-1.9.2.custom.min.css" />
 <link type="text/css" rel="stylesheet" href="css/tree.css?0edcc3c9" />
 <link type="text/css" rel="stylesheet" href="css/navi.css?0edcc3c9" />
-<link type="text/css" rel="stylesheet" href="css/naviu.css?b2c00fb1" />
+<link type="text/css" rel="stylesheet" href="css/naviu.css?3855ee9e" />
 <script type="text/javascript" src="js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="js/jquery-ui-1.9.2.custom.min.js"></script>
 <script type="text/javascript" src="js/jquery.cookie.js?0edcc3c9"></script>
 <script type="text/javascript" src="js/tree.min.js?0edcc3c9"></script>
-<script type="text/javascript" src="js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="js/search.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="js/navi.min.js?0edcc3c9"></script>
-<script type="text/javascript" src="js/topic-table.min.js?b2c00fb1"></script>
-<script type="text/javascript" src="js/search-index.min.js?b2c00fb1"></script>
+<script type="text/javascript" src="js/topic-table.min.js?3855ee9e"></script>
+<script type="text/javascript" src="js/search-index.min.js?3855ee9e"></script>
 <!-- Web Help Layout -->
+
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body data-sort-title="Sort by" data-sort-byrank="Most relevant" data-sort-bytitle="Topic title" data-search-notopics="No topics found." data-search-found="%s topic(s) found:" data-index-noentry="To locate information about this keyword, please select one of the subentries in the list.">
 <div id="tabs">

diff --git a/docs/topics/buttonloopexpansiontokens.htm b/docs/topics/buttonloopexpansiontokens.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 4280;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">
@@ -56,106 +58,106 @@ <h1 class="hd0"><span class="ts0">Button Loop Expansion Tokens</span></h1>
       <div class="block0">
         <table class="tbl1">
           <tr class="row0">
-            <td class="cell48">
+            <td class="cell46">
               <p class="ps1"><span class="ts5">Button Loop Token</span></p>
             </td>
-            <td class="cell90">
+            <td class="cell88">
               <p class="ps1"><span class="ts5">Description</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell51">
+            <td class="cell49">
               <p><a id="BUTTON_CAPTION"></a><span class="ts3">&lt;BUTTON_CAPTION&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell91">
+            <td class="cell89">
               <p><span class="ts2">Inserts the buttons caption. In UI Toolkit a button can have a caption, or an image, but not both. The </span><span class="ts3">&lt;IF CAPTION&gt;</span><span class="ts2">&nbsp;and </span><span class="ts3">&lt;IF IMAGE&gt;</span><span class="ts2">&nbsp;expressions will allow you to provide the appropriate code.</span></p>
               <p><span class="ts2">&nbsp;</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell51">
+            <td class="cell49">
               <p><a id="BUTTON_COLPX"></a><span class="ts3">&lt;BUTTON_COLPX&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell92">
+            <td class="cell90">
               <p><span class="ts2">Inserts the calculated column position for the button in pixels. The column position is calculated by adding the sizes of all preceding buttons, with 15 pixels of space allowed before each button.</span></p>
               <p><span class="ts2">&nbsp;</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell51">
+            <td class="cell49">
               <p><a id="BUTTON_ELB"></a><span class="ts3">&lt;BUTTON_ELB&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell91">
+            <td class="cell89">
               <p><span class="ts2">Inserts the name of the ELB containing the buttons method. Refer to the discussion relating to </span><span class="ts3">&lt;BUTTON_METHOD&gt;</span><span class="ts2">. Methods are very rare, and specifying an external ELB is even rarer. You can use the expression </span><span class="ts3">&lt;IF ELB&gt;</span><span class="ts2">&nbsp;to determine if a button method ELB is specified.</span></p>
               <p><span class="ts2">&nbsp;</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell51">
+            <td class="cell49">
               <p><a id="BUTTON_IMAGE"></a><span class="ts3">&lt;BUTTON_IMAGE&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell91">
+            <td class="cell89">
               <p><span class="ts2">Inserts the name of the buttons image file. In UI Toolkit a button can have a caption, or an image, but not both. The </span><span class="ts3">&lt;IF CAPTION&gt;</span><span class="ts2">&nbsp;and </span><span class="ts3">&lt;IF IMAGE&gt;</span><span class="ts2">&nbsp;expressions will allow you to provide the appropriate code.</span></p>
               <p><span class="ts2">&nbsp;</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell50">
+            <td class="cell48">
               <p><a id="BUTTON_METHOD"></a><span class="ts3">&lt;BUTTON_METHOD&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell90">
+            <td class="cell88">
               <p><span class="ts2">Inserts the name of the buttons method. In UI Toolkit a button method may be specified as the event handler to be executed when the button is clicked. This is rare however, most applications relying on the fact that if a button method is not specified then the name of the button is signaled as a menu entry.</span></p>
               <p class="ps1"><span class="ts2">Most buttons will not have a method specified. You can use the </span><span class="ts3">&lt;IF METHOD&gt;</span><span class="ts2">&nbsp;expression to determine if a method is specified.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell50">
+            <td class="cell48">
               <p><a id="BUTTON_NAME"></a><span class="ts3">&lt;BUTTON_NAME&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell90">
+            <td class="cell88">
               <p><span class="ts2">Inserts the Name of the button. All buttons will have a name defined.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell50">
+            <td class="cell48">
               <p><a id="BUTTON_NUMBER"></a><span class="ts3">&lt;BUTTON_NUMBER&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell90">
+            <td class="cell88">
               <p><span class="ts2">Inserts the one-based index number of the button in the windows Buttons collection.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell50">
+            <td class="cell48">
               <p><a id="BUTTON_QUICKSELECT"></a><span class="ts3">&lt;BUTTON_QUICKSELECT&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell90">
+            <td class="cell88">
               <p><span class="ts2">Inserts the buttons explicitly specified quick-select character.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell51">
+            <td class="cell49">
               <p><a id="BUTTON_ROWPX"></a><span class="ts3">&lt;BUTTON_ROWPX&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell91">
+            <td class="cell89">
               <p><span class="ts2">Inserts the calculated row position for the button in pixels. The calculation takes into account the pixel height of the window, as well as the additional space which will have been allowed in the window height when the window size was calculated. If code generation is based on an existing UI Toolkit window then the height of the source window is used to calculate the value, otherwise the number of fields in the structure is used.</span></p>
               <p><span class="ts2">&nbsp;</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell51">
+            <td class="cell49">
               <p><a id="BUTTON_WIDTHPX"></a><span class="ts3">&lt;BUTTON_WIDTHPX&gt;</span></p>
               <p><span class="ts3">&nbsp;</span></p>
             </td>
-            <td class="cell91">
+            <td class="cell89">
               <p><span class="ts2">Inserts the width of the button in pixels. The width is calculated by multiplying the number of characters in the buttons caption by 12 pixels per character, and this value can be overridden using the -cw option. If the calculated button width is less than 75 pixels then 75 pixels is used.</span></p>
               <p><span class="ts2">&nbsp;</span></p>
             </td>

diff --git a/docs/topics/buttonloopexpressiontokens.htm b/docs/topics/buttonloopexpressiontokens.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 1350;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">
@@ -55,74 +57,74 @@ <h1 class="hd0"><span class="ts0">Button Loop Expression Tokens</span></h1>
       <div class="block0">
         <table class="tbl1">
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><span class="ts5">Button Loop Expression</span></p>
             </td>
-            <td class="cell94">
+            <td class="cell92">
               <p class="ps1"><span class="ts5">Description</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><a id="CANCELBUTTON"></a><span class="ts3">&lt;IF CANCELBUTTON&gt;</span></p>
             </td>
-            <td class="cell94">
+            <td class="cell92">
               <p class="ps1"><span class="ts2">The button is a Cancel button.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><a id="CAPTION"></a><span class="ts3">&lt;IF CAPTION&gt;</span></p>
             </td>
-            <td class="cell94">
+            <td class="cell92">
               <p class="ps1"><span class="ts2">The button has a caption specified.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell95">
+            <td class="cell93">
               <p class="ps1"><a id="ELB"></a><span class="ts3">&lt;IF ELB&gt;</span></p>
             </td>
-            <td class="cell96">
+            <td class="cell94">
               <p class="ps1"><span class="ts2">The event handler method is specified to be in an external ELB.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell95">
+            <td class="cell93">
               <p class="ps1"><a id="GENERICBUTTON"></a><span class="ts3">&lt;IF GENERICBUTTON&gt;</span></p>
             </td>
-            <td class="cell96">
+            <td class="cell94">
               <p class="ps1"><span class="ts2">The button is a generic button (i.e. it is not an OK or Cancel button).</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><a id="IMAGE"></a><span class="ts3">&lt;IF IMAGE&gt;</span></p>
             </td>
-            <td class="cell97">
+            <td class="cell95">
               <p class="ps1"><span class="ts2">The button has an image file specified.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><a id="METHOD"></a><span class="ts3">&lt;IF METHOD&gt;</span></p>
             </td>
-            <td class="cell97">
+            <td class="cell95">
               <p class="ps1"><span class="ts2">The image has an event handler method specified.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><a id="OKBUTTON"></a><span class="ts3">&lt;IF OKBUTTON&gt;</span></p>
             </td>
-            <td class="cell97">
+            <td class="cell95">
               <p class="ps1"><span class="ts2">The button is an OK button.</span></p>
             </td>
           </tr>
           <tr class="row0">
-            <td class="cell93">
+            <td class="cell91">
               <p class="ps1"><a id="QUICKSELECT"></a><span class="ts3">&lt;IF QUICKSELECT&gt;</span></p>
             </td>
-            <td class="cell97">
+            <td class="cell95">
               <p class="ps1"><span class="ts2">The button has a quick-select character specified.</span></p>
             </td>
           </tr>

diff --git a/docs/topics/buttonloops.htm b/docs/topics/buttonloops.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 200;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">

diff --git a/docs/topics/codegenapi.htm b/docs/topics/codegenapi.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 2160;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">

diff --git a/docs/topics/codegenapiclasses.htm b/docs/topics/codegenapiclasses.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 4930;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">

diff --git a/docs/topics/codegenapienumerations.htm b/docs/topics/codegenapienumerations.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 4870;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">

diff --git a/docs/topics/codegenerator.htm b/docs/topics/codegenerator.htm
@@ -35,13 +35,15 @@
 <link type="text/css" rel="stylesheet" href="../css/topics/style.css" />
 <script type="text/javascript" src="../js/jquery-3.6.0.min.js"></script>
 <script type="text/javascript" src="../js/nsa.js?0edcc3c9"></script>
-<script type="text/javascript" src="../js/settings.js?b2c00fb1"></script>
+<script type="text/javascript" src="../js/settings.js?3855ee9e"></script>
 <script type="text/javascript" src="../js/core.min.js?0edcc3c9"></script>
 <script type="text/javascript" src="../js/topic.min.js?0edcc3c9"></script>
 <script type="text/javascript">
 	var topicContext = 2390;
 </script>
 <!-- Web Help Topic -->
+
+<!-- HTML Help (CHM) Topic -->
 </head>
 <body>
 <div id="non-scrolling-area">