Changeset 8bf11809 for template/template.xml

Timestamp:

01/25/2013 01:52:33 PM (10 years ago)

Author:

Randy McMurchy <randy@…>

Branches:

10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gnome, kde5-13430, kde5-14269, kde5-14686, ken/inkscape-core-mods, krejzi/svn, lazarus, nosym, perl-modules, plabs/python-mods, qt5new, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/soup3, xry111/test-20220226

Children:

c3c56b2

Parents:

8f1699f2

Message:

Clarification updates to the template file

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

File:

• template/template.xml (modified) (11 diffs)

template/template.xml

@@ -97 +97 @@
     <bridgehead renderas="sect4">Required</bridgehead>
     <para role="required">
-      <xref linkend="BLFS DEPENDENCY"/>
+      <xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence
+      If there are more than two, they must be separated by commas with the last
+      member having "and" in front of it. The use of a serial comma is preferred
+      (a comma after the next to last member before the "and"). -->
     </para>
 
@@ -104 +107 @@
     <para role="recommended">
       <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
-      <xref linkend="BLFS DEPENDENCY"/>.
+      <xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence-->
     </para>
 
@@ -110 +113 @@
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional">
-      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>.
+      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
+      <!-- notice no period as this is not a sentence-->
     </para>
 
@@ -192 +196 @@
 
     <para>
-      <parameter>--SWITCH=PARAMETER</parameter>: This parameter does something
-      mandatory for BLFS purposes.
+      <parameter>--PARAMETER</parameter>: This parameter does something
+      mandatory for BLFS purposes. It will be in the instructions above. It is
+      not optional and is why it is listed as a parameter and not an option.
     </para>
 
     <para>
       <option>--OPTION</option>: This option does something optionally per the
-      user's desires.
+      user's desires. It is not listed in the instructions above, but instead,
+      is listed here because many (some) readers may want to include it.
     </para>
   </sect2>
@@ -206 +212 @@
 
     <para>
-      Stuff about how to use TEMPLATE to do something.
+      Stuff about how to use TEMPLATE to do something. This section is rarely
+      used.
     </para>
   </sect2>
@@ -218 +225 @@
       <para>
         <filename>~/.Configfilename1</filename> and
-        <filename>/etc/path/Configfilename2</filename>.
+        <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
       </para>
 
@@ -262 +269 @@
         system is rebooted, install the
         <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
-        <xref linkend="bootscripts"/> package.
+        <xref linkend="bootscripts"/> package as the
+        <systemitem class="username">root</systemitem> user:
       </para>
 
@@ -282 +290 @@
       <segtitle>Installed Director(y,ies)</segtitle>
 
+      <!-- If there were no programs, libraries, or directories created, then
+           we would list the section as "None". However, a decision must have
+           been made to change the "None" to just removing the whole section
+           because I've noticed that many packages have had the "None"
+           removed and the section completely removed as well. The reasoning
+           was that by putting "None", it appears as we know there are none.
+           Without anything it appears as we are not sure. -->
+           
       <seglistitem>
         <seg>
@@ -311 +327 @@
         <listitem>
           <para>
-            does this .....
+            does this ..... (end the sentence with a period).
           </para>
           <indexterm zone="TEMPLATE PROGRAM1">
@@ -323 +339 @@
         <listitem>
           <para>
-            does this .....
+            does this ..... (end the sentence with a period).
           </para>
           <indexterm zone="TEMPLATE PROGRAM2">
@@ -335 +351 @@
         <listitem>
           <para>
-            contains functions that .....
+            contains functions that ..... (end the sentence with a period).
           </para>
           <indexterm zone="TEMPLATE libLIBRARY1">