svn commit: r42258 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup

[Warren Block]

Author: wblock
Date: Fri Jul 12 03:52:31 2013
New Revision: 42258
URL: http://svnweb.freebsd.org/changeset/doc/42258

Log:
  Improve the clarity of the email examples and add a guibutton example.

Modified:
  head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml

Modified: head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml	Fri Jul 12 03:21:55 2013	(r42257)
+++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml	Fri Jul 12 03:52:31 2013	(r42258)
@@ -1572,8 +1572,8 @@ This is the file called 'foo2'</screen>
     <sect2 id="docbook-markup-email-addresses">
       <title>Email Addresses</title>
 
-      <para>Email addresses are marked up with
-	<sgmltag>email</sgmltag> tags.  In the <acronym>HTML</acronym>
+      <para>Email addresses are marked up as
+	<sgmltag>email</sgmltag> elements.  In the <acronym>HTML</acronym>
 	output format, the wrapped text becomes a hyperlink to the
 	email address.  Other output formats that support hyperlinks
 	may also make the email address into a link.</para>
@@ -1583,13 +1583,15 @@ This is the file called 'foo2'</screen>
 
 	<para>Usage:</para>
 
-	<programlisting><sgmltag class="starttag">para</sgmltag>Questions about &os; may be sent to
-  <sgmltag class="starttag">email</sgmltag>questions@&os;.org<sgmltag class="endtag">email</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+	<programlisting><sgmltag class="starttag">para</sgmltag>An email address that does not actually exist, like
+  <sgmltag class="starttag">email</sgmltag>notreal at example.com<sgmltag class="endtag">email</sgmltag>, can be used as an
+  example.<sgmltag class="endtag">para</sgmltag></programlisting>
 
 	<para>Appearance:</para>
 
-	<para>Questions about &os; may be sent to
-	  <email>questions@&os;.org</email>.</para>
+	<para>An email address that does not actually exist, like
+	  <email>notreal at example.com</email>, can be used as an
+	  example.</para>
       </example>
 
       <para>A &os;-specific extension allows setting the
@@ -1602,13 +1604,15 @@ This is the file called 'foo2'</screen>
 
 	<para>Usage:</para>
 
-	<programlisting><sgmltag class="starttag">para</sgmltag>Questions about &os; may be sent to
-  <sgmltag class="starttag">email role="nolink"</sgmltag>questions@&os;.org<sgmltag class="endtag">email</sgmltag>.<sgmltag class="endtag">para</sgmltag></programlisting>
+	<programlisting><sgmltag class="starttag">para</sgmltag>Sometimes a link to an email address like
+  <sgmltag class="starttag">email role="nolink"</sgmltag>notreal at example.com<sgmltag class="endtag">email</sgmltag> is not
+  desired.<sgmltag class="endtag">para</sgmltag></programlisting>
 
 	<para>Appearance:</para>
 
-	<para>Questions about &os; may be sent to
-	  <email role="nolink">questions@&os;.org</email>.</para>
+	<para>Sometimes a link to an email address like
+	  <email role="nolink">notreal at example.com</email> is not
+	  desired.</para>
       </example>
     </sect2>
 
@@ -1767,6 +1771,31 @@ This is the file called 'foo2'</screen>
       </example>
     </sect2>
 
+    <sect2 id="docbook-markup-gui-buttons">
+      <title>Showing <acronym>GUI</acronym> Buttons</title>
+
+      <para>Buttons presented by a graphical user interface are marked
+	with <sgmltag>guibutton</sgmltag>.  To make the text look more
+	like a graphical button, brackets and non-breaking spaces are
+	added surrounding the text.</para>
+
+      <example>
+	<title><sgmltag>guibutton</sgmltag></title>
+
+	<para>Usage:</para>
+
+	<programlisting><sgmltag class="starttag">para</sgmltag>Edit the file, then click
+  <sgmltag class="starttag">guibutton</sgmltag>[&nbsp;Save&nbsp;]<sgmltag class="endtag">guibutton</sgmltag> to save the
+  changes.<sgmltag class="endtag">para</sgmltag></programlisting>
+
+	<para>Appearance:</para>
+
+	<para>Edit the file, then click
+	  <guibutton>[ Save ]</guibutton> to save the
+	  changes.</para>
+      </example>
+    </sect2>
+
     <sect2 id="docbook-markup-system-errors">
       <title>Quoting System Errors</title>