os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Add a section showing use of <email> tags, both with and without

Browse source 
"nolink".  Move the sample <procedure> inside the <example>, the
comment that noted procedures could not be inside examples is no
longer correct.
This commit is contained in:
Warren Block 2013-07-10 11:35:47 +00:00
parent b9dcf8fe1b
commit bd7adfb41a
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42235
1 changed files with 44 additions and 3 deletions

47
en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml
View file

@ -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 &amp;os; may be sent to
<sgmltag class="starttag">email</sgmltag>questions@&amp;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 &amp;os; may be sent to
<sgmltag class="starttag">email role="nolink"</sgmltag>questions@&amp;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>