r3212 - trunk/BOOK/template

randy at linuxfromscratch.org randy at linuxfromscratch.org
Thu Jan 6 14:26:25 PST 2005


Author: randy
Date: 2005-01-06 15:26:25 -0700 (Thu, 06 Jan 2005)
New Revision: 3212

Modified:
   trunk/BOOK/template/template.xml
Log:
Updated package template skeleton with index tags

Modified: trunk/BOOK/template/template.xml
===================================================================
--- trunk/BOOK/template/template.xml	2005-01-06 20:49:25 UTC (rev 3211)
+++ trunk/BOOK/template/template.xml	2005-01-06 22:26:25 UTC (rev 3212)
@@ -5,55 +5,57 @@
   %general-entities;
 
   <!-- Place this in the general.ent file
-  <!ENTITY template-version "">
+  <!ENTITY TEMPLATE-version "">
   -->
 
-  <!ENTITY template-download-http "http://">
-  <!ENTITY template-download-ftp  "ftp://">
-  <!ENTITY template-md5sum        "MD5 sum">
-  <!ENTITY template-size          "?? MB">
-  <!ENTITY template-buildsize     "?? MB">
-  <!ENTITY template-time          "?? SBU">
+  <!ENTITY TEMPLATE-download-http "http://">
+  <!ENTITY TEMPLATE-download-ftp  "ftp://">
+  <!ENTITY TEMPLATE-md5sum        "MD5 sum">
+  <!ENTITY TEMPLATE-size          "?? MB">
+  <!ENTITY TEMPLATE-buildsize     "?? MB">
+  <!ENTITY TEMPLATE-time          "?? SBU">
 ]>
 
-<sect1 id="template" xreflabel="template-&template-version;">
+<sect1 id="TEMPLATE-package" xreflabel="TEMPLATE-&TEMPLATE-version;">
 <sect1info>
 <othername>$LastChangedBy$</othername>
 <date>$Date$</date>
 </sect1info>
-<?dbhtml filename="template.html"?>
-<title><application>template</application>-&template-version;</title>
+<?dbhtml filename="TEMPLATE.html"?>
+<title><application>TEMPLATE</application>-&TEMPLATE-version;</title>
+<indexterm zone="TEMPLATE-package">
+<primary sortas="a-TEMPLATE">TEMPLATE</primary></indexterm>
 
 <sect2>
-<title>Introduction to <application>template</application></title>
+<title>Introduction to <application>TEMPLATE</application></title>
 
-<para>The <application>template</application> package contains... 
+<para>The <application>TEMPLATE</application> package contains... 
 This is useful for...</para>
 
 <sect3><title>Package information</title>
 <itemizedlist spacing="compact">
 <listitem><para>Download (HTTP): 
-<ulink url="&template-download-http;"/></para></listitem>
+<ulink url="&TEMPLATE-download-http;"/></para></listitem>
 <listitem><para>Download (FTP): 
-<ulink url="&template-download-ftp;"/></para></listitem>
+<ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
 <listitem><para>Download MD5 sum: 
-&template-md5sum;</para></listitem>
+&TEMPLATE-md5sum;</para></listitem>
 <listitem><para>Download size: 
-&template-size;</para></listitem>
+&TEMPLATE-size;</para></listitem>
 <listitem><para>Estimated disk space required: 
-&template-buildsize;</para></listitem>
+&TEMPLATE-buildsize;</para></listitem>
 <listitem><para>Estimated build time: 
-&template-time;</para></listitem></itemizedlist>
+&TEMPLATE-time;</para></listitem></itemizedlist>
 </sect3>
 
 <sect3><title>Additional downloads</title>
 <itemizedlist spacing="compact">
-<listitem><para>Required Patch: <ulink
-url="&patch-root;/template-&template-version;-patch_name-patch_version.patch"/></para>
+<listitem><para>Required Patch: <ulink 
+url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
 </listitem></itemizedlist>
 </sect3>
 
-<sect3><title><application>template</application> dependencies</title>
+<sect3><title><application>TEMPLATE</application> dependencies</title>
 <sect4><title>Required</title>
 <para><xref linkend="BLFS DEPENDENCY"/></para>
 </sect4>
@@ -66,9 +68,9 @@
 </sect2>
 
 <sect2>
-<title>Installation of <application>template</application></title>
+<title>Installation of <application>TEMPLATE</application></title>
 
-<para>Install <application>template</application> by running the following 
+<para>Install <application>TEMPLATE</application> by running the following 
 commands:</para>
 
 <screen><userinput><command>./configure --prefix=/usr &&
@@ -91,16 +93,30 @@
 </sect2>
 
 <sect2>
-<title>Configuring <application>template</application></title>
+<title>Configuring <application>TEMPLATE</application></title>
 
 <sect3><title>Config files</title>
-<para><filename>List of config files</filename></para>
+<para><filename id="SomeUniqueName1">Configfilename1</filename>, 
+<indexterm zone="TEMPLATE-package SomeUniqueName1">
+<primary sortas="e-SomeUniqueName1">Configfilename1</primary></indexterm>
+<filename id="SomeUniqueName2">Configfilename2</filename></para>
+<indexterm zone="TEMPLATE-package SomeUniqueName2">
+<primary sortas="e-SomeUniqueName2">Configfilename2</primary></indexterm>
 </sect3>
 
 <sect3><title>Configuration Information</title>
 
 <para><userinput>USERINPUT GOES HERE</userinput> Blah blah blah about config.
 </para>
+
+<para id="TEMPLATE.init">To automatically start the 
+<command>TEMPLATE</command> daemon when the system is rebooted, install the 
+<filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the 
+<xref linkend="intro-important-bootscripts"/> package.</para> 
+<indexterm zone="TEMPLATE-package TEMPLATE.init"> 
+<primary sortas="f-TEMPLATE.init">TEMPLATE</primary></indexterm> 
+
+<screen><userinput><command>make install-TEMPLATE</command></userinput></screen>
 </sect3>
 
 </sect2>
@@ -108,18 +124,49 @@
 <sect2>
 <title>Contents</title>
 
-<para>The <application>template</application> package contains 
-<command>LISTOFEXEC</command>, <filename>LISTOFFILES</filename>.</para>
+<segmentedlist>
+<segtitle>Installed Program(s)</segtitle>
+<segtitle>Installed Script(s)</segtitle>
+<segtitle>Installed Librar(y,ies)</segtitle>
+<segtitle>Installed Director(y,ies)</segtitle>
+<seglistitem>
+<seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
+<seg>SCRIPT1, SCRIPT2 and SCRIPT3</seg>
+<seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
+<seg>/etc/TEMPLATE, /var/lib/TEMPLATE, /usr/lib/TEMPLATE, 
+/usr/share/TEMPLATE-&TEMPLATE-version; and 
+and /usr/share/doc/TEMPLATE-&TEMPLATE-version;</seg>
+</seglistitem>
+</segmentedlist>
 
-</sect2>
+<variablelist>
+<bridgehead renderas="sect3">Short Descriptions</bridgehead>
+<?dbfo list-presentation="list"?>
 
-<sect2><title>Description</title>
+<varlistentry id="PROGRAM1">
+<term><command>PROGRAM1</command></term>
+<listitem><para>does this .....</para>
+<indexterm zone="TEMPLATE-package PROGRAM1">
+<primary sortas="b-PROGRAM1">PROGRAM1</primary></indexterm>
+</listitem>
+</varlistentry>
 
-<sect3><title>item1</title>
-<para><command>item1</command> does this</para></sect3>
+<varlistentry id="SCRIPT1">
+<term><command>SCRIPT1</command></term>
+<listitem><para>does this .....</para>
+<indexterm zone="TEMPLATE-package SCRIPT1">
+<primary sortas="d-SCRIPT1">SCRIPT1</primary></indexterm>
+</listitem>
+</varlistentry>
 
-<sect3><title>item2</title>
-<para><filename>item2</filename> does that</para></sect3>
+<varlistentry id="libLIBRARY1">
+<term><filename class='libraryfile'>libLIBRARY1</filename></term>
+<listitem><para> contains functions that .....</para>
+<indexterm zone="TEMPLATE-package libLIBRARY1">
+<primary sortas="c-libLIBRARY1">libLIBRARY1</primary></indexterm>
+</listitem>
+</varlistentry>
+</variablelist>
 
 </sect2>
 




More information about the blfs-book mailing list