Added the 'User Notes' wiki link to each package page; changed all instances of .[so,a] to .{so,a} (brackets changed to braces); changed all replaceable tags to use angle brackets instead of square brackets to encapsulate the text - commit #12

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@5840 af4574ff-66df-0310-9fd7-8a98e5e911e0

general.ent

@@ -1,4 +1,4 @@
-<!ENTITY day          "09">                   <!-- Always 2 digits -->
+<!ENTITY day          "10">                   <!-- Always 2 digits -->
 <!ENTITY month        "04">                   <!-- Always 2 digits -->
 <!ENTITY year         "2006">
 <!ENTITY version      "svn-&year;&month;&day;">

introduction/important/bootscripts.xml

@@ -43,7 +43,7 @@
   directory around until completion of your BLFS system. When a script is
   requested from BLFS Bootscripts, simply change to the directory and as the
   <systemitem class="username">root</systemitem> user, execute the given
-  <command>make install-<replaceable>[init-script]</replaceable></command>
+  <command>make install-<replaceable>&lt;init-script&gt;</replaceable></command>
   command. This command installs the init script to its proper location (along
   with any auxiliary configuration scripts) and also creates the appropriate
   symlinks to start and stop the service at the appropriate run-level.</para>

introduction/important/building-notes.xml

@@ -110,7 +110,7 @@ bunzip2 -v patchname.bz2</userinput></screen>
     Alternately, simply run the command shown below and compare the output
     to the md5sum data shown in the BLFS book.</para>
 
-<screen><userinput>md5sum <replaceable>[name_of_downloaded_file]</replaceable></userinput></screen>
+<screen><userinput>md5sum <replaceable>&lt;name_of_downloaded_file&gt;</replaceable></userinput></screen>
 
   </sect2>
 
@@ -121,16 +121,16 @@ bunzip2 -v patchname.bz2</userinput></screen>
     staring at the screen hoping to catch a particular error or warning. Log
     files are also useful for debugging and keeping records. The following
     command allows you to create an installation log. Replace
-    <replaceable>[command]</replaceable> with the command you intend to execute.</para>
+    <replaceable>&lt;command&gt;</replaceable> with the command you intend to execute.</para>
 
-<screen><userinput>( <replaceable>[command]</replaceable> 2&gt;&amp;1 | tee compile.log &amp;&amp; exit $PIPESTATUS )</userinput></screen>
+<screen><userinput>( <replaceable>&lt;command&gt;</replaceable> 2&gt;&amp;1 | tee compile.log &amp;&amp; exit $PIPESTATUS )</userinput></screen>
 
     <para><option>2&gt;&amp;1</option> redirects error messages to the same
     location as standard output. The <command>tee</command> command allows
     viewing of the output while logging the results to a file. The parentheses
     around the command run the entire command in a subshell and finally the
     <command>exit $PIPESTATUS</command> command ensures the result of the
-    <replaceable>[command]</replaceable> is returned as the result and not the
+    <replaceable>&lt;command&gt;</replaceable> is returned as the result and not the
     result of the <command>tee</command> command.</para>
 
   </sect2>

introduction/important/locale-issues.xml

@@ -112,12 +112,12 @@
         <command>unzip</command>:</para>
 
 <screen><userinput>convmv -f iso-8859-1 -t cp850 -r --nosmart --notest \
-    <replaceable>[/path/to/unzipped/files]</replaceable></userinput></screen>
+    <replaceable>&lt;/path/to/unzipped/files&gt;</replaceable></userinput></screen>
 
         <para>Step 2. Do the correct conversion instead:</para>
 
 <screen><userinput>convmv -f cp866 -t koi8-r -r --nosmart --notest \
-    <replaceable>[/path/to/unzipped/files]</replaceable></userinput></screen>
+    <replaceable>&lt;/path/to/unzipped/files&gt;</replaceable></userinput></screen>
       </blockquote>
 
       <para>3) Apply this patch to unzip:

introduction/welcome/askhelp.xml

@@ -36,7 +36,7 @@
         been loaded?  You should use <command>lsmod</command> as the
         <systemitem class='username'>root</systemitem> user to see if it's
         loaded. Check the <filename>sys.log</filename> file or run
-        <command>modprobe <replaceable>[driver]</replaceable></command> to
+        <command>modprobe <replaceable>&lt;driver&gt;</replaceable></command> to
         review any error message. If it loads properly, you may need to add
         the <command>modprobe</command> command to your boot scripts.</para>
       </listitem>
@@ -44,14 +44,14 @@
         <para>Are your permissions properly set, especially for devices? LFS
         uses groups to make these settings easier, but it also adds the step of
         adding users to groups to allow access. A simple <command>moduser
-        -G audio <replaceable>[user]</replaceable></command> may be all that's
+        -G audio <replaceable>&lt;user&gt;</replaceable></command> may be all that's
         necessary for that user to have access to the sound system. Any question
         that starts out with <quote>It works as root, but not as ...</quote>
         requires a thorough review of permissions prior to asking.</para>
       </listitem>
       <listitem>
         <para>BLFS liberally uses <filename
-        class='directory'>/opt/<replaceable>[package]</replaceable></filename>.
+        class='directory'>/opt/<replaceable>&lt;package&gt;</replaceable></filename>.
         The main objection to this centers around the need to expand your
         environment variables for each package placed there (e.g.,
         PATH=$PATH:/opt/kde/bin). In most cases, the package instructions will

introduction/welcome/changelog.xml

@@ -41,6 +41,25 @@
 
 -->
 
+    <listitem>
+      <para>April 10th, 2006</para>
+      <itemizedlist>
+        <listitem>
+          <para>[randy] - Added the 'User Notes' wiki link to each package
+          page.</para>
+        </listitem>
+        <listitem>
+          <para>[randy] - Changed all instances of .[so,a] to .{so,a}
+          (brackets changed to braces).</para>
+        </listitem>
+        <listitem>
+          <para>[randy] - Changed all <replaceable>[some_text]</replaceable>
+          instances to <replaceable>&lt;some_text&gt;</replaceable> (square
+          brackets changed to angle brackets).</para>
+        </listitem>
+      </itemizedlist>
+    </listitem>
+
     <listitem>
       <para>April 9th, 2006</para>
       <itemizedlist>

introduction/welcome/conventions.xml

@@ -71,7 +71,7 @@ EOF</userinput></screen>
     Therefore, this whole section is generally typed as seen.</para>
   </blockquote>
 
-  <para><replaceable>[REPLACED TEXT]</replaceable></para>
+  <para><replaceable>&lt;REPLACED TEXT&gt;</replaceable></para>
 
   <blockquote>
     <para>This form of text is used to encapsulate text that should be

template/template.xml

@@ -100,6 +100,9 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional"><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
 
+    <para condition="html" role="usernotes">User Notes:
+    <ulink url="&blfs-wiki;/template"/></para>
+
   </sect2>
 
   <!-- Optional section for packages that need a specific kernel configuration-->
@@ -270,11 +273,11 @@ EOF</userinput></screen>
       </varlistentry>
 
       <varlistentry id="libLIBRARY1">
-        <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
+        <term><filename class='libraryfile'>libLIBRARY1.{so,a}</filename></term>
         <listitem>
           <para>contains functions that .....</para>
           <indexterm zone="TEMPLATE libLIBRARY1">
-            <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
+            <primary sortas="c-libLIBRARY1">libLIBRARY1.{so,a}</primary>
           </indexterm>
         </listitem>
       </varlistentry>