From 3c69dd961acd0e1d6bd9d3f28729b7e21caf8e80 Mon Sep 17 00:00:00 2001
From: emmajane <>
Date: Thu, 22 Jul 2004 01:12:08 +0000
Subject: [PATCH] added document conventions

---
 LDP/howto/docbook/ACPI-HOWTO.xml | 104 +++++++++++++++++++++++++------
 1 file changed, 84 insertions(+), 20 deletions(-)

diff --git a/LDP/howto/docbook/ACPI-HOWTO.xml b/LDP/howto/docbook/ACPI-HOWTO.xml
index c57bab63..672daa7a 100644
--- a/LDP/howto/docbook/ACPI-HOWTO.xml
+++ b/LDP/howto/docbook/ACPI-HOWTO.xml
@@ -15,16 +15,6 @@ custom kernels with Debian&apos;s kernel-package system</ulink></para>
 </note>
 ">
 
-<!ENTITY resources-software "
-<tip>
-	<title>Software downloads</title>
-	<para>
-	  For more information about software for ACPI, please use the
-	  <xref linkend='software' />.
-	</para>
-</tip>
-">
-
 <!ENTITY kernel-version "<replaceable>&lt;version&gt;</replaceable>">
 <!ENTITY kernel-name "<replaceable>&lt;date&gt;</replaceable>">
 
@@ -121,10 +111,9 @@ custom kernels with Debian&apos;s kernel-package system</ulink></para>
 </revhistory>
 </articleinfo>
 
-<sect1 id="about">
+<preface id="about">
 <title>About this document</title>
 
-
 <sect2 id="copyright">
 <title>Copyright and License</title>
 <para>
@@ -203,7 +192,79 @@ it all down</para></listitem>
 </itemizedlist>
 </sect2>
 
-</sect1>
+<sect2 id="feedback">
+<title>Feedback</title>
+	<para>Find something wrong with this document? (Or perhaps something right?) I would love to hear from you. Please email me at <email>emmajane@xtrinsic.com</email>.</para>
+</sect2>
+
+<sect2 id="conventions">
+<title>Conventions used in this document</title>
+
+<para>The following typographic and usage conventions occur in this text:
+</para>
+
+<table id="table-conventions" frame="all">
+<title>Typographic and usage conventions</title>
+<tgroup cols="2" align="left" colsep="1" rowsep="1">
+
+<thead>
+<row><entry>Text type</entry><entry>Meaning</entry></row>
+</thead>
+
+<tbody>
+<row>
+<entry><quote>Quoted text</quote></entry>
+<entry>Quotes from people, quoted computer output.</entry>
+</row>
+<row>
+<entry><screen>terminal view</screen></entry>
+<entry>Literal computer input and output captured from the terminal, 
+usually rendered with a light grey background.</entry>
+</row>
+<row>
+<entry><command>command</command></entry>
+<entry>Name of a command that can be entered on the command line.</entry>
+</row>
+<row>
+<entry><option>option</option></entry>
+<entry>Option to a command, as in <quote>the <option>-a</option> option to the 
+<command>ls</command> command</quote>.</entry>
+</row>
+<row>
+<entry><parameter>parameter</parameter></entry>
+<entry>Parameter to a command, as in <quote>read 
+<command>man <parameter>ls</parameter></command></quote>.</entry>
+</row>
+<row>
+<entry><cmdsynopsis><command>command <option>options</option> 
+<parameter>arguments</parameter></command></cmdsynopsis></entry>
+<entry>Command synopsis or general usage, on a separated line.</entry>
+</row>
+<row>
+<entry><filename>filename</filename></entry>
+<entry>Name of a file or directory, for example <quote>Change to the 
+<filename class="directory">/usr/bin</filename> directory.</quote></entry>
+</row>
+<row>
+<entry><menuchoice><guimenu>Menu</guimenu><guimenuitem>Choice</guimenuitem>
+</menuchoice></entry>
+<entry>Choice to select from a graphical menu, for instance: <quote>Select 
+<menuchoice><guimenu>Help</guimenu><guimenuitem>About Mozilla</guimenuitem>
+</menuchoice> in your browser.</quote></entry>
+</row>
+<row>
+<entry><ulink url="http://www.xtrinsic.com">The author</ulink></entry>
+<entry>Clickable link to an external web resource.</entry>
+</row>
+</tbody>
+
+</tgroup>
+</table>
+
+<para>Thanks to Machtelt <quote>Tille</quote> Garrels for this list of conventions.</para>
+</sect2>
+
+</preface>
 
 <sect1 id="aboutacpi">
 <title>About ACPI</title>
@@ -599,10 +660,7 @@ I now use names, in alphabetical order, starting with the kernel build
 <quote>alien</quote>. I'm going to leave the date option in though as I
 still think it's a good way to do things.</para> 
 
-<para>My current kernel, 2.6.6,
-is <quote>Elrond.</quote> The machine itself is <quote>Smeagol.</quote>
-</para>
-</note>
+<para>My current kernel, 2.6.7, is <quote>Ulairi.</quote> The machine itself is <quote>Smeagol.</quote></para></note>
 
 &kernel-compile;
 </sect2>
@@ -1021,7 +1079,13 @@ that difficult. Most software packages include a README file when you
 gunzip them which will explain what you need to do to get things working on
 your system.</para>
 
-&resources-software;
+<tip>
+	<title>Software downloads</title>
+	<para>
+	  For more information about software for ACPI, please use the
+	  <xref linkend='software' />.
+	</para>
+</tip>
 </sect1>
 </appendix>
 
@@ -1082,9 +1146,9 @@ two things:</para>
 <screen>
 <parameter>append="<option>nolapic</option> <option>noapic</option>"</parameter>
 
-default="elrond"
+default="ulairi"
 image=/vmlinuz
-label=elrond
+label=ulairi
 read-only
 </screen>