Add new tags keycombo, keysym, menuchoice, guimenuitem and shortcut to the documentation stylesheets.

git-svn-id: https://svn.apache.org/repos/asf/jmeter/trunk@1717543 13f79535-47bb-0310-9956-ffa450edef68

Former-commit-id: d7bcb06e80

xdocs/changes.xml

@@ -130,7 +130,9 @@ Summary
 <h3>General</h3>
 <ul>
 <li><bug>57913</bug>Automated backups of last saved JMX files. Contributed by Benoit Vatan (benoit.vatan at gmail.com)</li>
-<li><bug>57988</bug>Shortcuts (Ctrl+1 .. Ctrl+9) to quick add elements into test plan. Implemented by Andrey Pokhilko (andrey at blazemeter.com) and contributed by BlazeMeter Ltd.</li>
+<li><bug>57988</bug>Shortcuts (<keycombo><keysym>Ctrl</keysym><keysym>1</keysym></keycombo> &hellip;
+    <keycombo><keysym>Ctrl</keysym><keysym>9</keysym></keycombo>) to quick add elements into test plan.
+    Implemented by Andrey Pokhilko (andrey at blazemeter.com) and contributed by BlazeMeter Ltd.</li>
 <li><bug>58100</bug>Performance enhancements : Replace Random by ThreadLocalRandom.</li>
 <li><bug>58465</bug>JMS Read response field is badly named and documented</li>
 <li><bug>58601</bug>Change check for modification of <code>saveservice.properties</code> from <code>$Revision$</code> to sha1 sum of the file itself.</li>

xdocs/changes_history.xml

@@ -4527,7 +4527,8 @@ To change the list of removed headers, define the property proxy.headers.remove
 <li><bugzilla>28715</bugzilla> - allow variable cookie values (set CookieManager.allow_variable_cookies=false to disable)</li>
 <li><bugzilla>40873</bugzilla> - add JMS point-to-point non-persistent delivery option</li>
 <li><bugzilla>43283</bugzilla> - Save action adds .jmx if not present; checks for existing file on Save As</li>
-<li>Control+A key does not work for Save All As; changed to Control+Shift+S</li>
+<li><keycombo><keysym>Control</keysym><keysym>A</keysym></keycombo> key does not work for Save All As;
+    changed to <keycombo><keysym>Control</keysym><keysym>Shift</keysym><keysym>S</keysym></keycombo></li>
 <li><bugzilla>40991</bugzilla> - Allow Assertions to check Headers</li>
 </ul>
 
@@ -4596,7 +4597,8 @@ The main bug fixes are:
 <ul>
 <li>HTTPS (SSL) handling now much improved</li>
 <li>Various Remote mode bugs fixed</li>
-<li>Control+C and Control+V now work in the test tree</li>
+<li><keycombo><keysym>Control</keysym><keysym>C</keysym></keycombo>
+    and <keycombo><keysym>Control</keysym><keysym>V</keysym></keycombo> now work in the test tree</li>
 <li>Latency and Encoding now available in CSV log output</li>
 <li>Test elements no longer default to previous contents; test elements no longer cleared when changing language.</li>
 </ul>
@@ -4634,7 +4636,8 @@ so the temporary work-round of using '\' and '@' in the username to delimit the
 has been removed.
 </p>
 <p>
-Control-Z no longer used for Remote Start All - this now uses Control+Shift+R
+<keycombo><keysym>Control</keysym><keysym>Z</keysym></keycombo> no longer used for Remote Start All - this
+now uses <keycombo><keysym>Control</keysym><keysym>Shift</keysym><keysym>R</keysym></keycombo>
 </p>
 <p>
 HttpClient now uses pre-emptive authentication. 

xdocs/css/new-style.css

@@ -334,6 +334,24 @@ table {
   display: none;
 }
 
+.menuchoice > span {
+  color: brown;
+  font-style: italic;
+}
+
+.keysym {
+  background-color: #f0f0f0;
+  border: 1px solid #bbb;
+  border-radius: 0.3rem;
+  padding: 0.1rem;
+  font-style: normal;
+  font-weight: bold;
+}
+
+.example .keysym {
+  background-color: white;
+}
+
 @media screen and (max-width: 1000px) {
   .nav {
   width: 100%;

xdocs/css/style.css

@@ -37,3 +37,14 @@ a[name]:hover:after{
   /* Green so shows up on section headings too */
   color: rgb(0,255,0);
 }
+
+.keysym {
+  background-color: #f0f0f0;
+  border: 1px solid #aaa;
+  padding-left: 0.2em;
+  padding-right: 0.2em;
+}
+
+.guimenuitem {
+  font-style: italic;
+}

xdocs/stylesheets/site_printable.vsl

@@ -294,6 +294,16 @@ Contributed by $id.getAttributeValue("name") <$id.getAttributeValue("mail")&g
 #ch_category ($node)
 #elseif ($node.getName().equals("ch_title"))
 #ch_title ($node)
+#elseif ($node.getName().equals("menuchoice"))
+#menuchoice ($node)
+#elseif ($node.getName().equals("shortcut"))
+#shortcut ($node)
+#elseif ($node.getName().equals("keycombo"))
+#keycombo ($node)
+#elseif ($node.getName().equals("keysym"))
+#keysym ($node)
+#elseif ($node.getName().equals("guimenuitem"))
+#guimenuitem ($node)
 #else
 #outputTag($node)
 #runloop($node)
@@ -317,6 +327,25 @@ Contributed by $id.getAttributeValue("name") <$id.getAttributeValue("mail")&g
 </$tag.getName()>
 #end
 
+#macro (menuchoice $items)
+ <span class="menuchoice">
+ #foreach ($item in $items.getChildren("guimenuitem"))#guimenuitem($item)#if ($foreach.hasNext)&nbsp;&rarr;&nbsp;#end#end
+ #foreach ($item in $items.getChildren("shortcut"))
+  #shortcut($item)
+ #end
+ </span>
+#end
+
+#macro (guimenuitem $item)<span class="guimenuitem">$item.getText()</span>#end
+
+#macro (shortcut $shortcut)
+ (#foreach ($keycombo in $shortcut.getChildren("keycombo"))#keycombo ($keycombo)#end)
+#end
+
+#macro (keycombo $combo)<span class="keycombo">#foreach ($key in $combo.getChildren("keysym"))#keysym($key)#if ($foreach.hasNext)&nbsp;+&nbsp;#end#end</span>#end
+
+#macro (keysym $keysym)<span class="keysym">$keysym.getText()</span>#end
+
 #macro (runloop $itemToLoop)
 #foreach ($node in $itemToLoop.getContent())
 #if($node.getClass().getName().indexOf("Element") > -1)

xdocs/stylesheets/website-style.xsl

@@ -16,6 +16,7 @@
   <!ENTITY nbsp  "&#160;">
   <!ENTITY ndash "&#x02013;">
   <!ENTITY para  "&#x000B6;">
+  <!ENTITY rarr  "&#x02192;">
   <!ENTITY trade "&#x02122;">
 ]>
 <xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
@@ -579,4 +580,29 @@
     </xsl:copy>
   </xsl:template>
 
+  <xsl:template match="guimenuitem">
+    <span class="guimenuitem"><xsl:apply-templates /></span>
+    <xsl:if test="following-sibling::guimenuitem">&nbsp;&rarr;&nbsp;</xsl:if>
+  </xsl:template>
+
+  <xsl:template match="keysym">
+    <span class="keysym"><xsl:apply-templates /></span>
+    <xsl:if test="following-sibling::keysym and parent::keycombo">&nbsp;+&nbsp;</xsl:if>
+  </xsl:template>
+
+  <xsl:template match="keycombo">
+    <span class="keycombo"><xsl:apply-templates select="keysym" /></span>
+  </xsl:template>
+
+  <xsl:template match="shortcut">
+    (<xsl:apply-templates select="keycombo"/>)
+  </xsl:template>
+
+  <xsl:template match="menuchoice">
+    <span class="menuchoice">
+      <xsl:apply-templates select="guimenuitem"/>
+      <xsl:apply-templates select="shortcut"/>
+    </span>
+  </xsl:template>
+
 </xsl:stylesheet>

xdocs/usermanual/build-db-test-plan.xml

@@ -18,7 +18,6 @@
 
 <!DOCTYPE document[
 <!ENTITY sect-num '7'>
-<!ENTITY rarr     "&#x02192;" >
 ]>
 
 <document prev="build-adv-web-test-plan.html" next="build-ftp-test-plan.html" id="$Id$">
@@ -53,8 +52,11 @@ tells JMeter the number of users you want to simulate, how often the users shoul
 send requests, and the how many requests they should send.</p>
 
 <p>Go ahead and add the ThreadGroup element by first selecting the Test Plan,
-clicking your right mouse button to get the Add menu, and then select
-<b>Add</b> &rarr; <b>ThreadGroup</b>.</p>
+clicking your right mouse button to get the <code>Add</code> menu, and then select
+<menuchoice>
+  <guimenuitem>Add</guimenuitem>
+  <guimenuitem>ThreadGroup</guimenuitem>
+</menuchoice>.</p>
 
 <p>You should now see the Thread Group element under Test Plan. If you do not
 see the element, then "expand" the Test Plan tree by clicking on the
@@ -109,7 +111,11 @@ will be performing.  In this section, you will specify the JDBC requests to
 perform.</p>
 
 <p>Begin by selecting the JDBC Users element. Click your right mouse button
-to get the w<b>Add</b> menu, and then select <b>Add</b> &rarr; <b>Config Element</b> &rarr; <b>JDBC Connection Configuration</b>.
+to get the <b>Add</b> menu, and then select <menuchoice>
+  <guimenuitem>Add</guimenuitem>
+  <guimenuitem>Config Element</guimenuitem>
+  <guimenuitem>JDBC Connection Configuration</guimenuitem>
+</menuchoice>.
 Then, select this new element to view its Control Panel (see Figure &sect-num;.3).</p>
 
 <p>Set up the following fields (these assume we will be using a MySQL database called 'cloud'):</p>
@@ -131,7 +137,11 @@ More than one JDBC Request can refer to the same pool.
 Figure &sect-num;.3. JDBC Configuration</figure>
 
 <p>Selecting the JDBC Users element again. Click your right mouse button
-to get the <b>Add</b> menu, and then select <b>Add</b> &rarr; <b>Sampler</b> &rarr; <b>JDBC Request</b>.
+to get the <b>Add</b> menu, and then select <menuchoice>
+  <guimenuitem>Add</guimenuitem>
+  <guimenuitem>Sampler</guimenuitem>
+  <guimenuitem>JDBC Request</guimenuitem>
+</menuchoice>.
 Then, select this new element to view its Control Panel (see Figure &sect-num;.4).</p>
 
 <figure image="jdbctest/JDBCRequest.png">
@@ -177,9 +187,16 @@ responsible for storing all of the results of your JDBC requests in a file
 and presenting the results.</p>
 
 <p>Select the <i>JDBC Users</i> element and add a <complink name="Summary Report"/>
-listener (<b>Add</b> &rarr; <b>Listener</b> &rarr; <b>Summary Report</b>).</p>
+listener (<menuchoice>
+    <guimenuitem>Add</guimenuitem>
+    <guimenuitem>Listener</guimenuitem>
+    <guimenuitem>Summary Report</guimenuitem>
+</menuchoice>).</p>
 
-<p>Save the test plan, and run the test with the menu <b>Run</b> &rarr; <b>Start</b> or <b>Ctrl+R</b></p>
+<p>Save the test plan, and run the test with the menu
+<menuchoice><guimenuitem>Run</guimenuitem><guimenuitem>Start</guimenuitem></menuchoice> or
+<keycombo><keysym>Ctrl</keysym><keysym>R</keysym></keycombo>
+</p>
 
 <p>The listener shows the results.</p>
 

xdocs/usermanual/component_reference.xml

@@ -2743,8 +2743,23 @@ To read existing results and display them, use the file panel Browse button to o
 <p>
 Versions of JMeter up to 2.3.2 <b>used to clear any current data</b> before loading the new file.<br></br>
 This is no longer done, thus <b>allowing files to be merged</b>.
-If the previous behaviour is required, 
-use the menu item <code>Run</code> &rarr; <code>Clear</code> (Ctrl+Shift+E) or <code>Run</code> &rarr; <code>Clear All</code> (Ctrl+E) before loading the file.
+If the previous behaviour is required, use the menu item
+<menuchoice>
+  <guimenuitem>Run</guimenuitem>
+  <guimenuitem>Clear</guimenuitem>
+  <shortcut>
+    <keycombo><keysym>Ctrl</keysym><keysym>Shift</keysym><keysym>E</keysym></keycombo>
+  </shortcut>
+</menuchoice>
+or
+<menuchoice>
+  <guimenuitem>Run</guimenuitem>
+  <guimenuitem>Clear All</guimenuitem>
+  <shortcut>
+    <keycombo><keysym>Ctrl</keysym><keysym>E</keysym></keycombo>
+  </shortcut>
+</menuchoice>
+before loading the file.
 </p>
 <p>Results can be read from XML or CSV format files.
 When reading from CSV results files, the header (if present) is used to determine which fields are present.

xdocs/usermanual/hints_and_tips.xml

@@ -156,43 +156,43 @@ values: <code>22x22</code> (default size), <code>32x32</code> or <code>48x48</co
         </p>
         <dl>
             <dt>
-                <code>Ctrl+0</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>0</keysym></keycombo>
             </dt>
             <dd>Thread Group</dd>
             <dt>
-                <code>Ctrl+1</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>1</keysym></keycombo>
             </dt>
             <dd>HTTP Request</dd>
             <dt>
-                <code>Ctrl+2</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>2</keysym></keycombo>
             </dt>
             <dd>Regular Expression Extractor</dd>
             <dt>
-                <code>Ctrl+3</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>3</keysym></keycombo>
             </dt>
             <dd>Response Assertion</dd>
             <dt>
-                <code>Ctrl+4</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>4</keysym></keycombo>
             </dt>
             <dd>Constant Timer</dd>
             <dt>
-                <code>Ctrl+5</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>5</keysym></keycombo>
             </dt>
             <dd>Test Action</dd>
             <dt>
-                <code>Ctrl+6</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>6</keysym></keycombo>
             </dt>
             <dd>JSR223 PostProcessor</dd>
             <dt>
-                <code>Ctrl+7</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>7</keysym></keycombo>
             </dt>
             <dd>JSR223 PreProcessor</dd>
             <dt>
-                <code>Ctrl+8</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>8</keysym></keycombo>
             </dt>
             <dd>Debug Sampler</dd>
             <dt>
-                <code>Ctrl+9</code>
+                <keycombo><keysym>Ctrl</keysym><keysym>9</keysym></keycombo>
             </dt>
             <dd>View Results Tree</dd>
         </dl>

xdocs/usermanual/listeners.xml

@@ -480,21 +480,49 @@ When reading from CSV results files, the header (if present) is used to determin
 Versions of JMeter up to 2.3.2 used to clear any current data before loading the new file.
 This is no longer done, thus allowing files to be merged.
 If the previous behaviour is required, 
-use the menu item Run/Clear (Ctrl+Shift+E) or Run/Clear All (Ctrl+E) before loading the file.
+use the menu item
+  <menuchoice>
+    <guimenuitem>Run</guimenuitem>
+    <guimenuitem>Clear</guimenuitem>
+    <shortcut>
+      <keycombo>
+        <keysym>Ctrl</keysym>
+        <keysym>Shift</keysym>
+        <keysym>E</keysym>
+      </keycombo>
+    </shortcut>
+  </menuchoice>
+or
+  <menuchoice>
+    <guimenuitem>Run</guimenuitem>
+    <guimenuitem>Clear All</guimenuitem>
+    <shortcut>
+      <keycombo>
+        <keysym>Ctrl</keysym>
+        <keysym>E</keysym>
+      </keycombo>
+    </shortcut>
+  </menuchoice>
+before loading the file.
 </note>
 </section>
 <section name="&sect-num;.10 Saving Listener GUI data" anchor="screencap">
 <p>JMeter is capable of saving any listener as a PNG file. To do so, select the
-listener in the left panel. Click <code>Edit</code> &gt; <code>Save As Image</code>. A file dialog will
+listener in the left panel. Click
+  <menuchoice>
+    <guimenuitem>Edit</guimenuitem>
+    <guimenuitem>Save As Image</guimenuitem>
+  </menuchoice>.
+A file dialog will
 appear. Enter the desired name and save the listener.
 </p>
 <p>
 The Listeners which generate output as tables can also be saved using Copy/Paste.
-Select the desired cells in the table, and use the OS Copy short-cut (normally Control+C).
+Select the desired cells in the table, and use the OS Copy short-cut (normally <keycombo><keysym>Ctrl</keysym><keysym>C</keysym></keycombo>).
 The data will be saved to the clipboard, from where it can be pasted into another application,
 e.g. a spreadsheet or text editor.
 </p>
-<figure image="save_image.png">Figure 1 - Edit &gt; Save As Image</figure>
+<figure image="save_image.png">Figure 1 - <menuchoice><guimenuitem>Edit</guimenuitem><guimenuitem>Save As Image</guimenuitem></menuchoice></figure>
 
 </section>
 </body>