Ignore:
Timestamp:
04/28/2005 06:31:48 PM (18 years ago)
Author:
Bruce Dubbs <bdubbs@…>
Branches:
10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 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:
9d798aee
Parents:
97e4364
Message:

Updating the template for the current formatting standard.

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

File:
1 edited

Legend:

Unmodified
Added
Removed

  • template/template.xml

    r97e4364 r4705fa4  
    1717]>
    1818
     19<!-- Try to keep the indentation used in this file-->
    1920<sect1 id="TEMPLATE" xreflabel="TEMPLATE-&TEMPLATE-version;">
    20 
    21 <sect1info>
    22   <othername>$LastChangedBy$</othername>
    23   <date>$Date$</date>
    24 </sect1info>
    25 
    26 <?dbhtml filename="TEMPLATE.html"?>
    27 <!-- No <application> tags in any title-->
    28 <title>TEMPLATE-&TEMPLATE-version;</title>
    29 <indexterm zone="TEMPLATE">
    30   <primary sortas="a-TEMPLATE">TEMPLATE</primary>
    31 </indexterm>
    32 
    33 <!-- Added role attibutes to <sect2> tags to allow to have a different look
    34 for each section, if needed-->
    35 <sect2 role="package">
    36 <title>Introduction to TEMPLATE</title>
    37 
    38 <para>The <application>TEMPLATE</application> package contains...
    39 This is useful for...</para>
    40 
    41 <!-- Replaced <sect3> and <sect4> tags by <bridgehead> in this section
    42 to reduce the number of <sectX> to be processed if numbered sections is
    43 wanted in the future.-->
    44 <bridgehead renderas="sect3">Package information</bridgehead>
    45 <itemizedlist spacing="compact">
    46   <listitem><para>Download (HTTP):
    47     <ulink url="&TEMPLATE-download-http;"/></para></listitem>
    48   <listitem><para>Download (FTP):
    49     <ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
    50   <listitem><para>Download MD5 sum:
    51     &TEMPLATE-md5sum;</para></listitem>
    52   <listitem><para>Download size:
    53     &TEMPLATE-size;</para></listitem>
    54   <listitem><para>Estimated disk space required:
    55     &TEMPLATE-buildsize;</para></listitem>
    56   <listitem><para>Estimated build time:
    57     &TEMPLATE-time;</para></listitem>
    58 </itemizedlist>
    59 
    60 <bridgehead renderas="sect3">Additional downloads</bridgehead>
    61 <itemizedlist spacing="compact">
    62   <listitem><para>Required patch: <ulink
     21  <?dbhtml filename="TEMPLATE.html"?>
     22 
     23  <sect1info>
     24    <othername>$LastChangedBy$</othername>
     25    <date>$Date$</date>
     26  </sect1info>
     27 
     28  <!-- No other tags inside any title-->
     29  <!-- Use Title Case in All Titles
     30  The "The Chicago Manual of Style":
     31  "-Always capitalize the first and the last word.
     32   -Capitalize all nouns, pronouns, adjectives, verbs, adverbs, and
     33    subordinate conjunctions ("as", "because", "although").
     34   -Lowercase all articles, coordinate conjunctions ("and", "or", "nor"),
     35    and prepositions regardless of length, when they are other than the
     36    first or last word.
     37   -Lowercase the "to" in an infinitive."-->
     38  <title>TEMPLATE-&TEMPLATE-version;</title>
     39 
     40  <indexterm zone="TEMPLATE">
     41    <primary sortas="a-TEMPLATE">TEMPLATE</primary>
     42  </indexterm>
     43 
     44  <!--Required section-->
     45  <sect2 role="package">
     46    <title>Introduction to TEMPLATE</title>
     47   
     48    <para>The <application>TEMPLATE</application> package contains...
     49    This is useful for...</para>
     50   
     51    <bridgehead renderas="sect3">Package Information</bridgehead>
     52    <itemizedlist spacing="compact">
     53      <listitem>
     54        <para>Download (HTTP): <ulink url="&TEMPLATE-download-http;"/></para>
     55      </listitem>
     56      <listitem>
     57        <para>Download (FTP): <ulink url="&TEMPLATE-download-ftp;"/></para>
     58      </listitem>
     59      <listitem>
     60        <para>Download MD5 sum: &TEMPLATE-md5sum;</para>
     61      </listitem>
     62      <listitem>
     63        <para>Download size: &TEMPLATE-size;</para>
     64      </listitem>
     65      <listitem>
     66        <para>Estimated disk space required: &TEMPLATE-buildsize;</para>
     67      </listitem>
     68      <listitem>
     69      <para>Estimated build time: &TEMPLATE-time;</para></listitem>
     70    </itemizedlist>
     71   
     72    <!-- As required -->
     73    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
     74    <itemizedlist spacing="compact">
     75      <listitem>
     76        <para>Required patch: <ulink
    6377    url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
    64   </listitem>
    65 </itemizedlist>
    66 
    67 <bridgehead renderas="sect3">TEMPLATE dependencies</bridgehead>
    68 
    69 <bridgehead renderas="sect4">Required</bridgehead>
    70 <para><xref linkend="BLFS DEPENDENCY"/></para>
    71 
    72 <bridgehead renderas="sect4">Optional</bridgehead>
    73 <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
    74 
    75 </sect2>
    76 
    77 <sect2 role="installation">
    78 <title>Installation of TEMPLATE</title>
    79 
    80 <para>Install <application>TEMPLATE</application> by running the following
    81 commands:</para>
    82 
    83 <!-- Removed <command> tags. For file creation commands <literal> tags must be added
    84 enclosing the actual text-->
     78      </listitem>
     79    </itemizedlist>
     80   
     81    <bridgehead renderas="sect3">TEMPLATE Dependencies</bridgehead>
     82   
     83    <bridgehead renderas="sect4">Required</bridgehead>
     84    <para><xref linkend="BLFS DEPENDENCY"/></para>
     85   
     86    <!-- As required -->
     87    <bridgehead renderas="sect4">Recommended</bridgehead>
     88    <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink>,
     89          <xref linkend="BLFS DEPENDENCY"/></para>
     90    </para>
     91   
     92    <!-- As required -->
     93    <bridgehead renderas="sect4">Optional</bridgehead>
     94    <para><ulink url="http://www.some.url/">EXTERNAL DEPENDENCY</ulink></para>
     95   
     96  </sect2>
     97 
     98  <!-- Optional section for packages that need a specific kernel configuration-->
     99  <sect2 role="kernel" id='TEMPLATE-kernel'>
     100    <title>Kernel Configuration</title>
     101   
     102    <para>Enable the following options in the kernel configuration
     103    and recompile the kernel if neccessary:</para>
     104   
     105<!-- Spaces are significant in <screen> sections -->   
     106<screen><literal>Master section:
     107  Subsection:
     108    Required Option: M or Y
     109    Incompatible option: N</literal></screen>
     110   
     111    <para>Select the appropriate sub-options that appear when the above options
     112    are selected.</para>
     113   
     114    <indexterm zone="TEMPLATE TEMPLATE-kernel">
     115      <primary sortas="d-TEMPLATE">TEMPLATE</primary>
     116    </indexterm>
     117   
     118  </sect2>
     119 
     120  <!--Required section-->
     121  <sect2 role="installation">
     122    <title>Installation of TEMPLATE</title>
     123   
     124    <para>Install <application>TEMPLATE</application> by running the following
     125    commands:</para>
     126   
     127<!-- Spaces are significant in <screen> sections -->   
    85128<screen><userinput>./configure --prefix=/usr &amp;&amp;
    86129make</userinput></screen>
    87 
    88 <!--Added the test sute execution-->
    89 <para>To test the results, issue: <command>make check</command>.</para>
    90 
    91 <!--Added <systemitem> tag-->
    92 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
    93 
    94 <!--Changed where the role attribute is placed-->
     130   
     131    <para>To test the results, issue: <command>make check</command>.</para>
     132   
     133    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
     134   
    95135<screen role="root"><userinput>make install</userinput></screen>
    96 
    97 </sect2>
    98 
    99 <sect2 role="commands">
    100 <title>Command explanations</title>
    101 
    102 <para><command>COMMAND</command>: This command does something.</para>
    103 
    104 <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
    105 something mandatory for BLFS purposes.</para>
    106 
    107 <para><option>--OPTION</option>: This option does something optionally
    108 per the user's desires.</para>
    109 
    110 </sect2>
    111 
    112 <sect2 role="configuration">
    113 <title>Configuring TEMPLATE</title>
    114 
    115 <sect3 id="TEMPLATE-config">
    116   <title>Config files</title>
    117   <para><filename>~/.Configfilename1</filename> and
    118     <filename>/etc/path/Configfilename2</filename></para>
    119 
    120   <indexterm zone="TEMPLATE TEMPLATE-config">
    121     <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
    122   </indexterm>
    123  
    124   <indexterm zone="TEMPLATE TEMPLATE-config">
    125     <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
    126   </indexterm>
    127 </sect3>
    128 
    129 <sect3><title>Configuration information</title>
    130  
    131   <!--Making this part more proper-->
    132   <para>Blah blah blah about config.</para>
    133 
     136   
     137  </sect2>
     138 
     139  <!--Optional section-->
     140  <sect2 role="commands">
     141    <title>Command Explanations</title>
     142   
     143    <para><command>COMMAND</command>: This command does something.</para>
     144   
     145    <para><parameter>--SWITCH=PARAMETER</parameter>: This parameter does
     146    something mandatory for BLFS purposes.</para>
     147   
     148    <para><option>--OPTION</option>: This option does something optionally
     149    per the user's desires.</para>
     150   
     151  </sect2>
     152 
     153  <!--Optional section-->
     154  <sect2 role="configuration">
     155    <title>Configuring TEMPLATE</title>
     156   
     157    <sect3 id="TEMPLATE-config">
     158      <title>Config Files</title>
     159      <para><filename>~/.Configfilename1</filename> and
     160      <filename>/etc/path/Configfilename2</filename></para>
     161     
     162      <indexterm zone="TEMPLATE TEMPLATE-config">
     163        <primary sortas="e-AA.Configfilename1">~/.Configfilename1</primary>
     164      </indexterm>
     165     
     166      <indexterm zone="TEMPLATE TEMPLATE-config">
     167        <primary sortas="e-etc-path-Configfilename2">/etc/path/Configfilename2</primary>
     168      </indexterm>
     169    </sect3>
     170   
     171    <sect3><title>Configuration Information</title>
     172     
     173      <para>Blah blah blah about config.</para>
     174     
    134175<screen><userinput>USER CONFIG COMMANDS</userinput></screen>
    135176 
    136177<screen role="root"><userinput>ROOT CONFIG COMMANDS</userinput></screen>
    137 
    138   <!-- File creation-->
    139   <para>Create the file .... for ...</para>
    140  
     178     
     179      <!-- File creation. Add the appropiate <indexterm> block if needed.-->
     180      <para>Create the file .... for ...</para>
     181     
    141182<screen role="root"><userinput>cat &gt;&gt; /PATH/FILENAME &lt;&lt; "EOF"
    142183<literal># Begin FILENAME
    143 
     184           
    144185TEXT
    145    
     186           
    146187# End FILENAME</literal>
    147188EOF</userinput></screen>
    148     <!-- -->
    149    
    150   <sect3  id="TEMPLATE-init">
    151   <title>Boot Scripts</title>
    152  
    153     <para>To automatically start the <command>TEMPLATE</command> daemon
    154     when the system is rebooted, install the
    155     <filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
    156     <xref linkend="intro-important-bootscripts"/> package.</para>
    157 
    158   <indexterm zone="TEMPLATE TEMPLATE-init">
    159     <primary sortas="f-TEMPLATE">TEMPLATE</primary>
    160   </indexterm>
    161 
     189     
     190    </sect3>
     191   
     192    <sect3  id="TEMPLATE-init">
     193      <title>Boot Script</title>
     194     
     195      <para>To automatically start the <command>TEMPLATE</command> daemon
     196        when the system is rebooted, install the     <filename>/etc/rc.d/init.d/TEMPLATE</filename>
     197      bootscript from the <xref linkend="intro-important-bootscripts"/> package.</para>
     198     
     199      <indexterm zone="TEMPLATE TEMPLATE-init">
     200        <primary sortas="f-TEMPLATE">TEMPLATE</primary>
     201      </indexterm>
     202     
    162203<screen role="root"><userinput>make install-TEMPLATE</userinput></screen>
    163 
    164 </sect3>
    165 
    166 </sect2>
    167 
    168 <sect2 role="content">
    169 <title>Contents</title>
    170 
    171 <segmentedlist>
    172   <segtitle>Installed Program(s)</segtitle>
    173   <segtitle>Installed Librar(y,ies)</segtitle>
    174   <segtitle>Installed Director(y,ies)</segtitle>
    175 
    176   <seglistitem>
    177     <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
    178     <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
    179     <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
    180          /usr/share/TEMPLATE-&TEMPLATE-version;,
    181          /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
    182          /var/lib/TEMPLATE</seg>
    183   </seglistitem>
    184 </segmentedlist>
    185 
    186 <variablelist>
    187   <bridgehead renderas="sect3">Short Descriptions</bridgehead>
    188   <?dbfo list-presentation="list"?>
    189   <!--Render this as a table for HTML output-->
    190   <?dbhtml list-presentation="table"?>
    191 
    192 <!-- If the program or library name conflicts (is the same) as the
    193 package name, add -prog or -lib to the varlistentry entity id
    194 and the 2nd entry of the indexterm zone entity -->
    195 
    196 <varlistentry id="PROGRAM1">
    197   <term><command>PROGRAM1</command></term>
    198   <listitem>
    199     <para>does this .....</para>
    200     <indexterm zone="TEMPLATE PROGRAM1">
    201       <primary sortas="b-PROGRAM1">PROGRAM1</primary>
    202     </indexterm>
    203   </listitem>
    204 </varlistentry>
    205 
    206 <varlistentry id="PROGRAM2">
    207   <term><command>PROGRAM2</command></term>
    208   <listitem>
    209     <para>does this .....</para>
    210     <indexterm zone="TEMPLATE PROGRAM2">
    211       <primary sortas="b-PROGRAM2">PROGRAM2</primary>
    212     </indexterm>
    213   </listitem>
    214 </varlistentry>
    215 
    216 <varlistentry id="libLIBRARY1">
    217   <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
    218   <listitem>
    219     <para>contains functions that .....</para>
    220     <indexterm zone="TEMPLATE libLIBRARY1">
    221       <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
    222     </indexterm>
    223   </listitem>
    224 </varlistentry>
    225 
    226 </variablelist>
    227 
    228 </sect2>
    229 
     204     
     205    </sect3>
     206   
     207  </sect2>
     208 
     209  <sect2 role="content">
     210    <title>Contents</title>
     211   
     212    <segmentedlist>
     213      <segtitle>Installed Program(s)</segtitle>
     214      <segtitle>Installed Librar(y,ies)</segtitle>
     215      <segtitle>Installed Director(y,ies)</segtitle>
     216     
     217      <seglistitem>
     218        <seg>PROGRAM1, PROGRAM2, and PROGRAM3</seg>
     219        <seg>libLIBRARY1, libLIBRARY2, and libLIBRARY3</seg>
     220        <seg>/etc/TEMPLATE, /usr/include/TEMPLATE, /usr/lib/TEMPLATE,
     221          /usr/share/TEMPLATE-&TEMPLATE-version;,
     222          /usr/share/doc/TEMPLATE-&TEMPLATE-version;, and
     223        /var/lib/TEMPLATE</seg>
     224      </seglistitem>
     225    </segmentedlist>
     226   
     227    <variablelist>
     228      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
     229      <?dbfo list-presentation="list"?>
     230      <?dbhtml list-presentation="table"?>
     231     
     232      <!-- If the program or library name conflicts (is the same) as the
     233      package name, add -prog or -lib to the varlistentry entity id
     234      and the 2nd entry of the indexterm zone entity -->
     235     
     236      <varlistentry id="PROGRAM1">
     237        <term><command>PROGRAM1</command></term>
     238        <listitem>
     239          <para>does this .....</para>
     240          <indexterm zone="TEMPLATE PROGRAM1">
     241            <primary sortas="b-PROGRAM1">PROGRAM1</primary>
     242          </indexterm>
     243        </listitem>
     244      </varlistentry>
     245     
     246      <varlistentry id="PROGRAM2">
     247        <term><command>PROGRAM2</command></term>
     248        <listitem>
     249          <para>does this .....</para>
     250          <indexterm zone="TEMPLATE PROGRAM2">
     251            <primary sortas="b-PROGRAM2">PROGRAM2</primary>
     252          </indexterm>
     253        </listitem>
     254      </varlistentry>
     255     
     256      <varlistentry id="libLIBRARY1">
     257        <term><filename class='libraryfile'>libLIBRARY1.[so,a]</filename></term>
     258        <listitem>
     259          <para>contains functions that .....</para>
     260          <indexterm zone="TEMPLATE libLIBRARY1">
     261            <primary sortas="c-libLIBRARY1">libLIBRARY1.[so,a]</primary>
     262          </indexterm>
     263        </listitem>
     264      </varlistentry>
     265     
     266    </variablelist>
     267   
     268  </sect2>
     269 
    230270</sect1>
    231271
Note: See TracChangeset for help on using the changeset viewer.