Ignore:
Timestamp:
01/06/2005 10:26:25 PM (17 years ago)
Author:
Randy McMurchy <randy@…>
Branches:
10.0, 10.1, 11.0, 6.0, 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/refactor-virt, krejzi/svn, lazarus, nosym, perl-modules, qt5new, systemd-11177, systemd-13485, trunk, xry111/git-date, xry111/git-date-for-trunk, xry111/git-date-test
Children:
856ef22
Parents:
9f6698c
Message:

Updated package template skeleton with index tags

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • template/template.xml

    r9f6698c r43fd8be  
    66
    77  <!-- Place this in the general.ent file
    8   <!ENTITY template-version "">
     8  <!ENTITY TEMPLATE-version "">
    99  -->
    1010
    11   <!ENTITY template-download-http "http://">
    12   <!ENTITY template-download-ftp  "ftp://">
    13   <!ENTITY template-md5sum        "MD5 sum">
    14   <!ENTITY template-size          "?? MB">
    15   <!ENTITY template-buildsize     "?? MB">
    16   <!ENTITY template-time          "?? SBU">
     11  <!ENTITY TEMPLATE-download-http "http://">
     12  <!ENTITY TEMPLATE-download-ftp  "ftp://">
     13  <!ENTITY TEMPLATE-md5sum        "MD5 sum">
     14  <!ENTITY TEMPLATE-size          "?? MB">
     15  <!ENTITY TEMPLATE-buildsize     "?? MB">
     16  <!ENTITY TEMPLATE-time          "?? SBU">
    1717]>
    1818
    19 <sect1 id="template" xreflabel="template-&template-version;">
     19<sect1 id="TEMPLATE-package" xreflabel="TEMPLATE-&TEMPLATE-version;">
    2020<sect1info>
    2121<othername>$LastChangedBy$</othername>
    2222<date>$Date$</date>
    2323</sect1info>
    24 <?dbhtml filename="template.html"?>
    25 <title><application>template</application>-&template-version;</title>
     24<?dbhtml filename="TEMPLATE.html"?>
     25<title><application>TEMPLATE</application>-&TEMPLATE-version;</title>
     26<indexterm zone="TEMPLATE-package">
     27<primary sortas="a-TEMPLATE">TEMPLATE</primary></indexterm>
    2628
    2729<sect2>
    28 <title>Introduction to <application>template</application></title>
     30<title>Introduction to <application>TEMPLATE</application></title>
    2931
    30 <para>The <application>template</application> package contains...
     32<para>The <application>TEMPLATE</application> package contains...
    3133This is useful for...</para>
    3234
     
    3436<itemizedlist spacing="compact">
    3537<listitem><para>Download (HTTP):
    36 <ulink url="&template-download-http;"/></para></listitem>
     38<ulink url="&TEMPLATE-download-http;"/></para></listitem>
    3739<listitem><para>Download (FTP):
    38 <ulink url="&template-download-ftp;"/></para></listitem>
     40<ulink url="&TEMPLATE-download-ftp;"/></para></listitem>
    3941<listitem><para>Download MD5 sum:
    40 &template-md5sum;</para></listitem>
     42&TEMPLATE-md5sum;</para></listitem>
    4143<listitem><para>Download size:
    42 &template-size;</para></listitem>
     44&TEMPLATE-size;</para></listitem>
    4345<listitem><para>Estimated disk space required:
    44 &template-buildsize;</para></listitem>
     46&TEMPLATE-buildsize;</para></listitem>
    4547<listitem><para>Estimated build time:
    46 &template-time;</para></listitem></itemizedlist>
     48&TEMPLATE-time;</para></listitem></itemizedlist>
    4749</sect3>
    4850
    4951<sect3><title>Additional downloads</title>
    5052<itemizedlist spacing="compact">
    51 <listitem><para>Required Patch: <ulink
    52 url="&patch-root;/template-&template-version;-patch_name-patch_version.patch"/></para>
     53<listitem><para>Required Patch: <ulink 
     54url="&patch-root;/TEMPLATE-&TEMPLATE-version;-patch_name-patch_version.patch"/></para>
    5355</listitem></itemizedlist>
    5456</sect3>
    5557
    56 <sect3><title><application>template</application> dependencies</title>
     58<sect3><title><application>TEMPLATE</application> dependencies</title>
    5759<sect4><title>Required</title>
    5860<para><xref linkend="BLFS DEPENDENCY"/></para>
     
    6769
    6870<sect2>
    69 <title>Installation of <application>template</application></title>
     71<title>Installation of <application>TEMPLATE</application></title>
    7072
    71 <para>Install <application>template</application> by running the following
     73<para>Install <application>TEMPLATE</application> by running the following
    7274commands:</para>
    7375
     
    9294
    9395<sect2>
    94 <title>Configuring <application>template</application></title>
     96<title>Configuring <application>TEMPLATE</application></title>
    9597
    9698<sect3><title>Config files</title>
    97 <para><filename>List of config files</filename></para>
     99<para><filename id="SomeUniqueName1">Configfilename1</filename>,
     100<indexterm zone="TEMPLATE-package SomeUniqueName1">
     101<primary sortas="e-SomeUniqueName1">Configfilename1</primary></indexterm>
     102<filename id="SomeUniqueName2">Configfilename2</filename></para>
     103<indexterm zone="TEMPLATE-package SomeUniqueName2">
     104<primary sortas="e-SomeUniqueName2">Configfilename2</primary></indexterm>
    98105</sect3>
    99106
     
    102109<para><userinput>USERINPUT GOES HERE</userinput> Blah blah blah about config.
    103110</para>
     111
     112<para id="TEMPLATE.init">To automatically start the
     113<command>TEMPLATE</command> daemon when the system is rebooted, install the
     114<filename>/etc/rc.d/init.d/TEMPLATE</filename> bootscript from the
     115<xref linkend="intro-important-bootscripts"/> package.</para>
     116<indexterm zone="TEMPLATE-package TEMPLATE.init">
     117<primary sortas="f-TEMPLATE.init">TEMPLATE</primary></indexterm>
     118
     119<screen><userinput><command>make install-TEMPLATE</command></userinput></screen>
    104120</sect3>
    105121
     
    109125<title>Contents</title>
    110126
    111 <para>The <application>template</application> package contains
    112 <command>LISTOFEXEC</command>, <filename>LISTOFFILES</filename>.</para>
     127<segmentedlist>
     128<segtitle>Installed Program(s)</segtitle>
     129<segtitle>Installed Script(s)</segtitle>
     130<segtitle>Installed Librar(y,ies)</segtitle>
     131<segtitle>Installed Director(y,ies)</segtitle>
     132<seglistitem>
     133<seg>PROGRAM1, PROGRAM2 and PROGRAM3</seg>
     134<seg>SCRIPT1, SCRIPT2 and SCRIPT3</seg>
     135<seg>libLIBRARY1, libLIBRARY2 and libLIBRARY3</seg>
     136<seg>/etc/TEMPLATE, /var/lib/TEMPLATE, /usr/lib/TEMPLATE,
     137/usr/share/TEMPLATE-&TEMPLATE-version; and
     138and /usr/share/doc/TEMPLATE-&TEMPLATE-version;</seg>
     139</seglistitem>
     140</segmentedlist>
    113141
    114 </sect2>
     142<variablelist>
     143<bridgehead renderas="sect3">Short Descriptions</bridgehead>
     144<?dbfo list-presentation="list"?>
    115145
    116 <sect2><title>Description</title>
     146<varlistentry id="PROGRAM1">
     147<term><command>PROGRAM1</command></term>
     148<listitem><para>does this .....</para>
     149<indexterm zone="TEMPLATE-package PROGRAM1">
     150<primary sortas="b-PROGRAM1">PROGRAM1</primary></indexterm>
     151</listitem>
     152</varlistentry>
    117153
    118 <sect3><title>item1</title>
    119 <para><command>item1</command> does this</para></sect3>
     154<varlistentry id="SCRIPT1">
     155<term><command>SCRIPT1</command></term>
     156<listitem><para>does this .....</para>
     157<indexterm zone="TEMPLATE-package SCRIPT1">
     158<primary sortas="d-SCRIPT1">SCRIPT1</primary></indexterm>
     159</listitem>
     160</varlistentry>
    120161
    121 <sect3><title>item2</title>
    122 <para><filename>item2</filename> does that</para></sect3>
     162<varlistentry id="libLIBRARY1">
     163<term><filename class='libraryfile'>libLIBRARY1</filename></term>
     164<listitem><para> contains functions that .....</para>
     165<indexterm zone="TEMPLATE-package libLIBRARY1">
     166<primary sortas="c-libLIBRARY1">libLIBRARY1</primary></indexterm>
     167</listitem>
     168</varlistentry>
     169</variablelist>
    123170
    124171</sect2>
Note: See TracChangeset for help on using the changeset viewer.