Correcting display.input.option() signature (#2)

Correcting display.input.option() signature so that it will get parsed correctly in json and lua definition file
tektronix · May 15, 2024 · 682353e · 682353e
1 parent 671716e
commit 682353e
Show file tree

Hide file tree

Showing 10 changed files with 38 additions and 58 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,11 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
     Security -- in case of vulnerabilities.
 -->
 
+## [0.15.3]
+
+### Fixed
+- display.input.option() command signature has been corrected for all tti models
+
 ## [0.15.0]
 
 ### Fixed
@@ -34,6 +39,7 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 - Language feature has been added for  DAQ6510 and DMM6500 command set(TSP-304)
 - Language feature has been added for 24XX and DMM7510 command set(TSP-232)
 
+[0.15.3]: https://github.com/tektronix/tsp-toolkit-webhelp/releases/tag/v0.15.3
 [0.15.0]: https://github.com/tektronix/tsp-toolkit-webhelp/releases/tag/v0.15.0
 [0.14.1]: https://github.com/tektronix/tsp-toolkit-webhelp/releases/tag/v0.14.1
 [0.11.2]: https://github.com/tektronix/tsp-toolkit-webhelp/releases/tag/v0.11.2
diff --git a/WebHelpDocs/Commands_2450/40052.htm b/WebHelpDocs/Commands_2450/40052.htm
@@ -56,13 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">

diff --git a/WebHelpDocs/Commands_2460/40052.htm b/WebHelpDocs/Commands_2460/40052.htm
@@ -56,13 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">

diff --git a/WebHelpDocs/Commands_2461/40052.htm b/WebHelpDocs/Commands_2461/40052.htm
@@ -56,13 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">

diff --git a/WebHelpDocs/Commands_2470/40052.htm b/WebHelpDocs/Commands_2470/40052.htm
@@ -56,13 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">
@@ -78,15 +78,9 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 </td>
 </tr>
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitle2</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">...</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the name of the second button; up to 15 characters</p>
-</td>
-</tr>
-<tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitleN</em></p>
-</td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 3 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
 </td>
 </tr>
 

diff --git a/WebHelpDocs/Commands_DAQ6510/40052.htm b/WebHelpDocs/Commands_DAQ6510/40052.htm
@@ -56,14 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, &quot;<em class="emphasis">buttonTitle2</em>&quot;)</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, &quot;<em class="emphasis">buttonTitle2</em>&quot;<em class="emphasis">, </em>&quot;<em class="emphasis">buttonTitleN</em>&quot;<em class="emphasis">, ... </em>&quot;<em class="emphasis">buttonTitleN</em>&quot;)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">
@@ -79,15 +78,9 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 </td>
 </tr>
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitle2</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">...</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the name of the second button; up to 15 characters</p>
-</td>
-</tr>
-<tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitleN</em></p>
-</td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 3 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
 </td>
 </tr>
 

diff --git a/WebHelpDocs/Commands_DMM6500/40052.htm b/WebHelpDocs/Commands_DMM6500/40052.htm
@@ -56,14 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, &quot;<em class="emphasis">buttonTitle2</em>&quot;)</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, &quot;<em class="emphasis">buttonTitle2</em>&quot;<em class="emphasis">, </em>&quot;<em class="emphasis">buttonTitleN</em>&quot;<em class="emphasis">, ... </em>&quot;<em class="emphasis">buttonTitleN</em>&quot;)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">
@@ -79,15 +78,9 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 </td>
 </tr>
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitle2</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">...</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the name of the second button; up to 15 characters</p>
-</td>
-</tr>
-<tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitleN</em></p>
-</td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 3 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
 </td>
 </tr>
 

diff --git a/WebHelpDocs/Commands_DMM7510/40052.htm b/WebHelpDocs/Commands_DMM7510/40052.htm
@@ -56,13 +56,13 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 
 </table>
 <p class="iclsubheading">Usage</p>
-<p class="iclcode">display.BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
+<p class="iclcode">BUTTON_OPTION<em class="emphasis">n</em> = display.input.option(&quot;<em class="emphasis">dialogTitle</em>&quot;, &quot;<em class="emphasis">buttonTitle1</em>&quot;, ...)</p>
 <p class="iclspacing"></p>
 <table class="tableintopic" width="600" cellpadding="2" cellspacing="0" border="1" style="border-collapse:collapse; border:1px solid #C0C0C0">
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">n</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable">BUTTON_OPTION<em class="emphasis">n</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">The number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext"><em class="emphasis">n</em> is the number of the button that is selected from the front-panel display; <code class="monospace">nil</code> if Cancel is pressed on the keypad; buttons are numbered top to bottom, left to right</p>
 </td>
 </tr>
 <tr align="left" valign="top">
@@ -78,15 +78,9 @@ <h2 id="t40052" class="heading2-icl">display.input.option()</h2>
 </td>
 </tr>
 <tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitle2</em></p>
+<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">...</em></p>
 </td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the name of the second button; up to 15 characters</p>
-</td>
-</tr>
-<tr align="left" valign="top">
-<td style="border:1px solid #C0C0C0;" width="139"><p class="codetable"><em class="emphasis">buttonTitleN</em></p>
-</td>
-<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 3 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
+<td style="border:1px solid #C0C0C0;" width="461"><p class="tablebodytext">A string that contains the names of subsequent buttons, where <span class="monospaceitalic">N</span> is a number from 2 to 10; you can define up to 10 buttons; each button can be up to 15 characters</p>
 </td>
 </tr>
 

diff --git a/WebHelpDocs/package-lock.json b/WebHelpDocs/package-lock.json
diff --git a/WebHelpDocs/package.json b/WebHelpDocs/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@tektronix/web-help-documents",
-  "version": "0.15.0",
+  "version": "0.15.3",
   "description": "",
   "main": "index.js",
   "scripts": {