Show how to mark up keys, mouse buttons, and combinations (chords).

1 files changed, 58 insertions, 2 deletions

diff --git a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
index 57f02b0c28..0f7a2f4f35 100644
--- a/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
+++ b/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml
@@ -27,13 +27,13 @@
      ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
      POSSIBILITY OF SUCH DAMAGE.
 
-     $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.24 2001/07/08 15:40:00 schweikh Exp $
+     $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/sgml-markup/chapter.sgml,v 1.25 2001/07/13 20:49:09 nik Exp $
 -->
 
 <chapter id="sgml-markup">
   <title>SGML Markup</title>
 
-  <para>This chapter describes the three markup languages you will encounter
+  <para>This chapter describes the two markup languages you will encounter
     when you contribute to the FreeBSD documentation project.  Each section
     describes the markup language, and details the markup that you are likely
     to want to use, or that is already in use.</para>
@@ -1601,6 +1601,62 @@ This is the file called 'foo2'</screen>
 	    like operating system for the Intel architecture.</para>
 	</example>
       </sect3>
+
+      <sect3>
+	<title>Keys, mouse buttons, and combinations</title>
+
+	<para>To refer to a specific key on the keyboard, use
+	  <sgmltag>keycap</sgmltag>.  To refer to a mouse button, use
+	  <sgmltag>mousebutton</sgmltag>.  And to refer to combinations of key
+	  presses or mouse clicks, wrap them all in
+	  <sgmltag>keycombo</sgmltag>.</para>
+
+	<para><sgmltag>keycombo</sgmltag> has an attribute called
+	  <literal>action</literal>, which may be one of
+	  <literal>click</literal>, <literal>double-click</literal>,
+	  <literal>other</literal>, <literal>press</literal>,
+	  <literal>seq</literal>, or <literal>simul</literal>.  The last two
+	  values denote whether the keys or buttons should be pressed in
+	  sequence, or simultaneously.</para>
+
+	<para>The stylesheets automatically add any connecting symbols, such
+	  as <literal>+</literal>, between the key names, when wrapped in
+	  <sgmltag>keycombo</sgmltag>.</para>
+	
+	<example>
+	  <title>Keys, mouse buttons, and combinations</title>
+	  
+	  <para>Use:</para>
+	  
+	  <programlisting><![ CDATA [<para>To switch to the second virtual terminal, press 
+  <keycombo action="simul"><keycap>Alt</keycap>
+    <keycap>F1</keycap></keycombo>.</para>
+
+<para>To exit <command>vi</command> without saving your work, type
+  <keycombo action="seq"><keycap>Esc</keycap><keycap>:</keycap>
+    <keycap>q</keycap><keycap>!</keycap></keycombo>.</para>
+
+<para>My window manager is configured so that
+  <keycombo action="simul"><keycap>Alt</keycap>
+    <mousebutton>right</mousebutton>
+  </keycombo> mouse button is used to move windows.</para>]]></programlisting>
+
+	  <para>Appearance:</para>
+	  
+	  <para>To switch to the second virtual terminal, press 
+	    <keycombo action="simul"><keycap>Alt</keycap>
+	      <keycap>F1</keycap></keycombo>.</para>
+
+	  <para>To exit <command>vi</command> without saving your work, type
+	    <keycombo action="seq"><keycap>Esc</keycap><keycap>:</keycap>
+	      <keycap>q</keycap><keycap>!</keycap></keycombo>.</para>
+
+	  <para>My window manager is configured so that
+	    <keycombo action="simul"><keycap>Alt</keycap>
+	      <mousebutton>right</mousebutton>
+	    </keycombo> mouse button is used to move windows.</para>
+	</example>
+      </sect3>
       
       <sect3>
 	<title>Applications, commands, options, and cites</title>