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

[Warren Block]

Author: wblock
Date: Wed Jul 10 11:35:47 2013
New Revision: 42235
URL: http://svnweb.freebsd.org/changeset/doc/42235

Log:
  Add a section showing use of <email> tags, both with and without
  "nolink".  Move the sample <procedure> inside the <example>, the
  comment that noted procedures could not be inside examples is no
  longer correct.

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	Wed Jul 10 10:38:06 2013	(r42234)
+++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml	Wed Jul 10 11:35:47 2013	(r42235)
@@ -664,10 +664,7 @@
 	    <para>This is the second ordered item.</para>
 	  </listitem>
 	</orderedlist>
-      </example>
 
-      <!-- Cannot have <procedure> inside <example>, so this is a
-	cheat -->
 
       <procedure>
 	<step>
@@ -682,6 +679,7 @@
 	  <para>And now do this.</para>
 	</step>
       </procedure>
+      </example>
     </sect2>
 
     <sect2 id="docbook-markup-showing-file-samples">
@@ -1572,6 +1570,49 @@ This is the file called 'foo2'</screen>
       </example>
     </sect2>
 
+    <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> 
+	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>
+
+      <example>
+	<title><sgmltag>email</sgmltag> with a Hyperlink</title>
+
+	<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>
+
+	<para>Appearance:</para>
+
+	<para>Questions about &os; may be sent to
+	  <email>questions@&os;.org</email>.</para>
+      </example>
+
+      <para>A &os;-specific extension allows setting the
+	<literal>role</literal> attribute to <literal>nolink</literal>
+	to prevent the creation of the hyperlink to the email
+	address.</para>
+
+      <example>
+	<title><sgmltag>email</sgmltag> Without a Hyperlink</title>
+
+	<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>
+
+	<para>Appearance:</para>
+
+	<para>Questions about &os; may be sent to
+	  <email role="nolink">questions@&os;.org</email>.</para>
+      </example>
+    </sect2>
+
     <sect2 id="docbook-markup-describing-makefiles">
       <title>Describing <filename>Makefile</filename>s</title>