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

Warren Block wblock at FreeBSD.org
Fri Jan 31 23:51:01 UTC 2014


Author: wblock
Date: Fri Jan 31 23:51:01 2014
New Revision: 43715
URL: http://svnweb.freebsd.org/changeset/doc/43715

Log:
  Replace lost replaceable tags.  Fix some examples with &os;, show device
  markup under filenames, and remove the obsolete devicename 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	Fri Jan 31 23:29:13 2014	(r43714)
+++ head/en_US.ISO8859-1/books/fdp-primer/docbook-markup/chapter.xml	Fri Jan 31 23:51:01 2014	(r43715)
@@ -146,8 +146,8 @@
 
 	  <tbody valign="top">
 	    <row>
-	      <entry namest="entity" nameend="notes">&os; Name
-		Entities</entry>
+	      <entry namest="entity" nameend="notes"><emphasis>&os;
+		Name Entities</emphasis></entry>
 	    </row>
 
 	    <row>
@@ -808,7 +808,7 @@
 	<para>Usage:</para>
 
 	<programlisting><tag class="starttag">warning</tag>
-  <tag class="starttag">para</tag>Installing FreeBSD may make you want to delete Windows from your
+  <tag class="starttag">para</tag>Installing &os; may make you want to delete Windows from your
     hard disk.<tag class="endtag">para</tag>
 <tag class="endtag">warning</tag></programlisting>
       </example>
@@ -1304,7 +1304,7 @@ This is the file called 'foo2'</screen>
 
 	<para>Usage:</para>
 
-	<programlisting><tag class="starttag">para</tag>FreeBSD is without doubt <tag class="starttag">emphasis</tag>the<tag class="endtag">emphasis</tag>
+	<programlisting><tag class="starttag">para</tag>&os; is without doubt <tag class="starttag">emphasis</tag>the<tag class="endtag">emphasis</tag>
   premiere &unix;-like operating system for the Intel
   architecture.<tag class="endtag">para</tag></programlisting>
 
@@ -1555,10 +1555,10 @@ This is the file called 'foo2'</screen>
     </sect2>
 
     <sect2 xml:id="docbook-markup-files">
-      <title>Files, Directories, Extensions</title>
+      <title>Files, Directories, Extensions, Device Names</title>
 
-      <para>To refer to the name of a file, a directory, or a file
-	extension, use <tag>filename</tag>.  For directory names, set
+      <para>To refer to the name of a file, a directory, a file
+	extension, or a device name, use <tag>filename</tag>.  For directory names, set
 	the <literal>class</literal> attribute to
 	<literal>directory</literal>.</para>
 
@@ -1572,16 +1572,25 @@ This is the file called 'foo2'</screen>
     class="directory"</tag>/usr/doc/en_US.ISO8859-1/books/handbook/<tag class="endtag">filename</tag>.
   The main file is called <tag class="starttag">filename</tag>book.xml<tag class="endtag">filename</tag>.
   There is also a <tag class="starttag">filename</tag>Makefile<tag class="endtag">filename</tag> and a
-  number of files with a <tag class="starttag">filename</tag>.ent<tag class="endtag">filename</tag> extension.<tag class="endtag">para</tag></programlisting>
+  number of files with a <tag class="starttag">filename</tag>.ent<tag class="endtag">filename</tag> extension.<tag class="endtag">para</tag>
+
+<tag class="starttag">para</tag><tag class="starttag">filename</tag>kbd0<tag class="endtag">filename</tag> is the first keyboard detected
+  by the system, and appears in
+  <tag class="starttag">filename</tag>/dev<tag class="endtag">filename</tag>.<tag class="endtag">para</tag>
+  </programlisting>
 
 	<para>Appearance:</para>
 
 	<para>The source for the Handbook in English is found in
 	  <filename
-	    class="directory">usr/doc/en_US.ISO8859-1/books/handbook/</filename>.
+	    class="directory">/usr/doc/en_US.ISO8859-1/books/handbook/</filename>.
 	  The main file is called <filename>book.xml</filename>.
 	  There is also a <filename>Makefile</filename> and a number
 	  of files with a <filename>.ent</filename> extension.</para>
+
+	<para><filename>kbd0</filename> is the first keyboard detected
+	  by the system, and appears in
+	  <filename>/dev</filename>.</para>
       </example>
     </sect2>
 
@@ -1630,63 +1639,6 @@ This is the file called 'foo2'</screen>
       </example>
     </sect2>
 
-    <sect2 xml:id="docbook-markup-devices">
-      <title>Devices</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>There are two names for devices: the device name as it
-	appears in <filename>/dev</filename>, or the name of the
-	device as it appears in the kernel.  For this latter course,
-	use <tag>devicename</tag>.</para>
-
-      <para>Sometimes there is no choice.  Some devices, such as
-	network cards, do not have entries in
-	<filename>/dev</filename>, or the entries are markedly
-	different from their kernel device names.</para>
-
-      <example>
-	<title><tag>devicename</tag></title>
-
-	<para>Usage:</para>
-
-	<programlisting><tag class="starttag">para</tag><tag class="starttag">devicename</tag>sio<tag class="endtag">devicename</tag> is used for serial
-  communication in FreeBSD.  <tag class="starttag">devicename</tag>sio<tag class="endtag">devicename</tag> manifests
-  through a number of entries in <tag class="starttag">filename</tag>/dev<tag class="endtag">filename</tag>, including
-  <tag class="starttag">filename</tag>/dev/ttyd0<tag class="endtag">filename</tag> and <tag class="starttag">filename</tag>/dev/cuaa0<tag class="endtag">filename</tag>.<tag class="endtag">para</tag>
-
-<tag class="starttag">para</tag>By contrast, network devices such as
-  <tag class="starttag">devicename</tag>ed0<tag class="endtag">devicename</tag> do not appear in <tag class="starttag">filename</tag>/dev<tag class="endtag">filename</tag>.<tag class="endtag">para</tag>
-
-<tag class="starttag">para</tag>In MS-DOS, the first floppy drive is referred to as
-  <tag class="starttag">devicename</tag>a:<tag class="endtag">devicename</tag>.  In FreeBSD it is
-  <tag class="starttag">filename</tag>/dev/fd0<tag class="endtag">filename</tag>.<tag class="endtag">para</tag></programlisting>
-
-	<para>Appearance:</para>
-
-	<para><filename>sio</filename> is used for serial
-	  communication in FreeBSD.  <filename>sio</filename>
-	  manifests through a number of entries in
-	  <filename>/dev</filename>, including
-	  <filename>/dev/ttyd0</filename> and
-	  <filename>/dev/cuaa0</filename>.</para>
-
-	<para>By contrast, network devices such as
-	  <filename>ed0</filename> do not appear in
-	  <filename>/dev</filename>.</para>
-
-	<para>In MS-DOS, the first floppy drive is referred to as
-	  <filename>a:</filename>.  In FreeBSD it is
-	  <filename>/dev/fd0</filename>.</para>
-      </example>
-    </sect2>
-
     <sect2 xml:id="docbook-markup-hosts">
       <title>Hosts, Domains, IP Addresses, User Names, and Other
 	System Items</title>
@@ -1999,7 +1951,7 @@ This is the file called 'foo2'</screen>
 	<para>Appearance:</para>
 
 	<informalexample>
-	  <screen>&prompt.user; <userinput>man command</userinput></screen>
+	  <screen>&prompt.user; <userinput>man <replaceable>command</replaceable></userinput></screen>
 	</informalexample>
 
 	<para><tag>replaceable</tag> can be used in many


More information about the svn-doc-all mailing list