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

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

Browse source
This commit is contained in:
Warren Block 2013-07-12 03:52:31 +00:00
parent 5bbb3c8791
commit 6ff913542f
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42258
1 changed files with 39 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -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 &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>
<programlisting><sgmltag class="starttag">para</sgmltag>An email address that does not actually exist, like
<sgmltag class="starttag">email</sgmltag>notreal@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@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 &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>
<programlisting><sgmltag class="starttag">para</sgmltag>Sometimes a link to an email address like
<sgmltag class="starttag">email role="nolink"</sgmltag>notreal@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@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>[&amp;nbsp;Save&amp;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>[&nbsp;Save&nbsp;]</guibutton> to save the
changes.</para>
</example>
</sect2>
<sect2 id="docbook-markup-system-errors">
<title>Quoting System Errors</title>