svn commit: r43311 - head/en_US.ISO8859-1/books/fdp-primer/docbook-markup
Warren Block
wblock at FreeBSD.org
Sun Dec 8 22:56:22 UTC 2013
Author: wblock
Date: Sun Dec 8 22:56:21 2013
New Revision: 43311
URL: http://svnweb.freebsd.org/changeset/doc/43311
Log:
Correct old hostid tag examples to show the new systemitem tag. Merge
the username example into the same section.
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 Sun Dec 8 22:25:41 2013 (r43310)
+++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml Sun Dec 8 22:56:21 2013 (r43311)
@@ -1688,7 +1688,8 @@ This is the file called 'foo2'</screen>
</sect2>
<sect2 xml:id="docbook-markup-hosts">
- <title>Hosts, Domains, IP Addresses, and So Forth</title>
+ <title>Hosts, Domains, IP Addresses, User Names, and Other
+ System Items</title>
<note>
<title>&os; Extension</title>
@@ -1698,30 +1699,25 @@ This is the file called 'foo2'</screen>
<acronym>DTD</acronym>.</para>
</note>
- <para>Identification information for networked computers (hosts)
- can be marked up in several ways, depending on the nature of
- the information. All of them use <tag>hostid</tag> as
- the element, with the <literal>role</literal> attribute
- selecting the type of the marked up information.</para>
+ <para>Information for <quote>system items</quote> is marked up
+ with <tag>systemitem</tag>. The <literal>class</literal>
+ attribute is used to identify the particular type of
+ information shown.</para>
<variablelist>
<varlistentry>
- <term>No <literal>role</literal> attribute, or
- <literal>role="hostname"</literal></term>
+ <term><literal>class="systemname"</literal></term>
<listitem>
- <para>With no <literal>role</literal> attribute (i.e.,
- <tag>hostid</tag>...<tag>/hostid</tag>)
+ <para>With <literal>class="systemname"</literal>
the marked up information is the simple hostname, such
as <literal>freefall</literal> or
- <literal>wcarchive</literal>. The hostname can be
- explicitly specified with
- <literal>role="hostname"</literal>.</para>
+ <literal>wcarchive</literal>.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><literal>role="domainname"</literal></term>
+ <term><literal>class="domainname"</literal></term>
<listitem>
<para>The text is a domain name, such as
@@ -1732,7 +1728,7 @@ This is the file called 'foo2'</screen>
</varlistentry>
<varlistentry>
- <term><literal>role="fqdn"</literal></term>
+ <term><literal>class="fqdomainname"</literal></term>
<listitem>
<para>The text is a Fully Qualified Domain Name, with
@@ -1741,7 +1737,7 @@ This is the file called 'foo2'</screen>
</varlistentry>
<varlistentry>
- <term><literal>role="ipaddr"</literal></term>
+ <term><literal>class="ipaddr"</literal></term>
<listitem>
<para>The text is an <acronym>IP</acronym> address,
@@ -1750,16 +1746,7 @@ This is the file called 'foo2'</screen>
</varlistentry>
<varlistentry>
- <term><literal>role="ip6addr"</literal></term>
-
- <listitem>
- <para>The text is an <acronym>IPv6</acronym>
- address.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>role="netmask"</literal></term>
+ <term><literal>class="netmask"</literal></term>
<listitem>
<para>The text is a network mask, which might be
@@ -1770,7 +1757,7 @@ This is the file called 'foo2'</screen>
</varlistentry>
<varlistentry>
- <term><literal>role="mac"</literal></term>
+ <term><literal>class="etheraddress"</literal></term>
<listitem>
<para>The text is an Ethernet <acronym>MAC</acronym>
@@ -1781,30 +1768,33 @@ This is the file called 'foo2'</screen>
</variablelist>
<example>
- <title><tag>hostid</tag> and Roles</title>
+ <title><tag>systemitem</tag> and Classes</title>
<para>Usage:</para>
<programlisting><tag class="starttag">para</tag>The local machine can always be referred to by the
- name <tag class="starttag">hostid</tag>localhost<tag class="endtag">hostid</tag>, which will have the IP
- address <tag class="starttag">hostid role="ipaddr"</tag>127.0.0.1<tag class="endtag">hostid</tag>.<tag class="endtag">para</tag>
+ name <tag class="starttag">systemitem class="systemname"</tag>localhost<tag class="endtag">systemitem</tag>, which will have the IP
+ address <tag class="starttag">systemitem class="ipaddr"</tag>127.0.0.1<tag class="endtag">systemitem</tag>.<tag class="endtag">para</tag>
-<tag class="starttag">para</tag>The <tag class="starttag">hostid role="domainname"</tag>FreeBSD.org<tag class="endtag">hostid</tag>
+<tag class="starttag">para</tag>The <tag class="starttag">systemitem class="domainname"</tag>FreeBSD.org<tag class="endtag">systemitem</tag>
domain contains a number of different hosts, including
- <tag class="starttag">hostid role="fqdn"</tag>freefall.FreeBSD.org<tag class="endtag">hostid</tag> and
- <tag class="starttag">hostid role="fqdn"</tag>bento.FreeBSD.org<tag class="endtag">hostid</tag>.<tag class="endtag">para</tag>
+ <tag class="starttag">systemitem class="fqdomainname"</tag>freefall.FreeBSD.org<tag class="endtag">systemitem</tag> and
+ <tag class="starttag">systemitem class="fqdomainname"</tag>bento.FreeBSD.org<tag class="endtag">systemitem</tag>.<tag class="endtag">para</tag>
<tag class="starttag">para</tag>When adding an <tag class="starttag">acronym</tag>IP<tag class="endtag">acronym</tag> alias to an
interface (using <tag class="starttag">command</tag>ifconfig<tag class="endtag">command</tag>)
<tag class="starttag">emphasis</tag>always<tag class="endtag">emphasis</tag> use a netmask of
- <tag class="starttag">hostid role="netmask"</tag>255.255.255.255<tag class="endtag">hostid</tag> (which can
+ <tag class="starttag">systemitem class="netmask"</tag>255.255.255.255<tag class="endtag">systemitem</tag> (which can
also be expressed as
- <tag class="starttag">hostid role="netmask"</tag>0xffffffff<tag class="endtag">hostid</tag>).<tag class="endtag">para</tag>
+ <tag class="starttag">systemitem class="netmask"</tag>0xffffffff<tag class="endtag">systemitem</tag>).<tag class="endtag">para</tag>
<tag class="starttag">para</tag>The <tag class="starttag">acronym</tag>MAC<tag class="endtag">acronym</tag> address uniquely identifies
every network card in existence. A typical
<tag class="starttag">acronym</tag>MAC<tag class="endtag">acronym</tag> address looks like
- <tag class="starttag">hostid role="mac"</tag>08:00:20:87:ef:d0<tag class="endtag">hostid</tag>.<tag class="endtag">para</tag></programlisting>
+ <tag class="starttag">systemitem class="etheraddress"</tag>08:00:20:87:ef:d0<tag class="endtag">systemitem</tag>.<tag class="endtag">para</tag>
+
+<tag class="starttag">para</tag>To carry out most system administration functions
+ requires logging in as <tag class="starttag">systemitem class="username"</tag>root<tag class="endtag">systemitem</tag>.<tag class="endtag">para</tag></programlisting>
<para>Appearance:</para>
@@ -1832,33 +1822,6 @@ This is the file called 'foo2'</screen>
every network card in existence. A typical
<acronym>MAC</acronym> address looks like <systemitem
class="etheraddress">08:00:20:87:ef:d0</systemitem>.</para>
- </example>
- </sect2>
-
- <sect2 xml:id="docbook-markup-usernames">
- <title>Usernames</title>
-
- <note>
- <title>&os; Extension</title>
-
- <para>These elements are part of the &os; extension to
- DocBook, and do not exist in the original DocBook
- <acronym>DTD</acronym>.</para>
- </note>
-
- <para>To refer to a specific username, such as
- <literal>root</literal> or <literal>bin</literal>, use
- <tag>username</tag>.</para>
-
- <example>
- <title><tag>username</tag></title>
-
- <para>Usage:</para>
-
- <programlisting><tag class="starttag">para</tag>To carry out most system administration functions
- requires logging in as <tag class="starttag">username</tag>root<tag class="endtag">username</tag>.<tag class="endtag">para</tag></programlisting>
-
- <para>Appearance:</para>
<para>To carry out most system administration functions
requires logging in as
More information about the svn-doc-head
mailing list