Changeset 8bf11809 for template


Ignore:
Timestamp:
01/25/2013 01:52:33 PM (9 years ago)
Author:
Randy McMurchy <randy@…>
Branches:
10.0, 10.1, 11.0, 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, krejzi/svn, nosym, perl-modules, qt5new, systemd-11177, systemd-13485, trunk, xry111/git-date, xry111/git-date-for-trunk, xry111/git-date-test
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:
1 edited

Legend:

Unmodified
Added
Removed
  • template/template.xml

    r8f1699f2 r8bf11809  
    9797    <bridgehead renderas="sect4">Required</bridgehead>
    9898    <para role="required">
    99       <xref linkend="BLFS DEPENDENCY"/>
     99      <xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence
     100      If there are more than two, they must be separated by commas with the last
     101      member having "and" in front of it. The use of a serial comma is preferred
     102      (a comma after the next to last member before the "and"). -->
    100103    </para>
    101104
     
    104107    <para role="recommended">
    105108      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink> and
    106       <xref linkend="BLFS DEPENDENCY"/>.
     109      <xref linkend="BLFS DEPENDENCY"/> <!-- notice no period as this is not a sentence-->
    107110    </para>
    108111
     
    110113    <bridgehead renderas="sect4">Optional</bridgehead>
    111114    <para role="optional">
    112       <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>.
     115      <ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>
     116      <!-- notice no period as this is not a sentence-->
    113117    </para>
    114118
     
    192196
    193197    <para>
    194       <parameter>--SWITCH=PARAMETER</parameter>: This parameter does something
    195       mandatory for BLFS purposes.
     198      <parameter>--PARAMETER</parameter>: This parameter does something
     199      mandatory for BLFS purposes. It will be in the instructions above. It is
     200      not optional and is why it is listed as a parameter and not an option.
    196201    </para>
    197202
    198203    <para>
    199204      <option>--OPTION</option>: This option does something optionally per the
    200       user's desires.
     205      user's desires. It is not listed in the instructions above, but instead,
     206      is listed here because many (some) readers may want to include it.
    201207    </para>
    202208  </sect2>
     
    206212
    207213    <para>
    208       Stuff about how to use TEMPLATE to do something.
     214      Stuff about how to use TEMPLATE to do something. This section is rarely
     215      used.
    209216    </para>
    210217  </sect2>
     
    218225      <para>
    219226        <filename>~/.Configfilename1</filename> and
    220         <filename>/etc/path/Configfilename2</filename>.
     227        <filename>/etc/path/Configfilename2</filename> <!-- notice no period as this is not a sentence-->
    221228      </para>
    222229
     
    262269        system is rebooted, install the
    263270        <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
    264         <xref linkend="bootscripts"/> package.
     271        <xref linkend="bootscripts"/> package as the
     272        <systemitem class="username">root</systemitem> user:
    265273      </para>
    266274
     
    282290      <segtitle>Installed Director(y,ies)</segtitle>
    283291
     292      <!-- If there were no programs, libraries, or directories created, then
     293           we would list the section as "None". However, a decision must have
     294           been made to change the "None" to just removing the whole section
     295           because I've noticed that many packages have had the "None"
     296           removed and the section completely removed as well. The reasoning
     297           was that by putting "None", it appears as we know there are none.
     298           Without anything it appears as we are not sure. -->
     299           
    284300      <seglistitem>
    285301        <seg>
     
    311327        <listitem>
    312328          <para>
    313             does this .....
     329            does this ..... (end the sentence with a period).
    314330          </para>
    315331          <indexterm zone="TEMPLATE PROGRAM1">
     
    323339        <listitem>
    324340          <para>
    325             does this .....
     341            does this ..... (end the sentence with a period).
    326342          </para>
    327343          <indexterm zone="TEMPLATE PROGRAM2">
     
    335351        <listitem>
    336352          <para>
    337             contains functions that .....
     353            contains functions that ..... (end the sentence with a period).
    338354          </para>
    339355          <indexterm zone="TEMPLATE libLIBRARY1">
Note: See TracChangeset for help on using the changeset viewer.