source: template/template-perl-module.xml@ e305bb90

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../../general.ent">
  %general-entities;

 <!-- for modules referenced outside of perl, put them in general/prog/perl-modules/
   and use a link to &perl_authors;/id/X/XY/XYZZY/Fu-Bar-$Fu-Bar-version; -->
  <!ENTITY my-download-http "&perl_authors;/id/X/XY/XYZZY/Fu-Bar-&Fu-Bar-version;.tar.gz">
 <!-- but for modules which are only dependencies of other modules, put them in
   general/pprog/perl-deps with a link to &metacpan_authors; that includes the /id part -->
  <!ENTITY my-download-http "&metacpan_authors;/X/XY/XYZZY/Fu-Bar-&Fu-Bar-version;.tar.gz">
 <!-- only one of the above choices -->
  <!ENTITY my-md5sum "eff0352d6de29a8d4d61efcc7774186c">

]>

  <!-- Begin Fu::Bar -->
  <sect2 id="new-perl-fu-bar" xreflabel="Fu-Bar-&Fu-Bar-version;">

    <title>Fu::Bar-&Fu-Bar-version;</title>

    <indexterm zone="new-perl-fu-bar">
      <primary sortas="a-Fu-Bar">Fu::Bar</primary>
    </indexterm>

    <sect3 role="package">
      <title>Introduction to Fu::Bar</title>

      <para>
        Fu::Bar does something.
      </para>

<!--  &lfs8x_checked; -->

      <bridgehead renderas="sect4">Package Information</bridgehead>
      <itemizedlist spacing="compact">
        <listitem>
          <para>
            Download (HTTP): <ulink url="&my-download-http;"/>
          </para>
        </listitem>
        <listitem>
          <para>
            Download MD5 sum: &my-md5sum;
          </para>
        </listitem>
      </itemizedlist>

      <!-- omit dependencies if not needed, but unlike the rest of the book,
       show ALL perl module dependencies, avoid thinking "b will bring in a",
       their deps might change when one is next updated. -->
      <bridgehead renderas="sect4">Fu::Bar Dependencies</bridgehead>

      <bridgehead renderas="sect5">Required</bridgehead>
      <para role="required">
        <xref linkend="perl-bar-baz"/>,
        <xref linkend="perl-wibble"/> and
        <xref linkend="new-perl-wobble"/>
      </para>

    </sect3>

    <sect3 role="installation">
      <title>Installation of Fu::Bar</title>

      <para>
        This module uses the <xref linkend="new-perl-standard-install"/>.
      </para>

    </sect3>

    <!-- omit content unless prog(s) or lib is installed in /usr -->
    <sect3 role="content">
      <title>Contents</title>

      <segmentedlist>
        <segtitle>Installed Programs</segtitle>
        <!-- omit libraries entirely unless present in /usr, there are often
         perl libraries in site-perl so 'none' can be misleading -->
        <segtitle>Installed Libraries</segtitle>

        <seglistitem>
          <seg>
            dibbler
          </seg>
        </seglistitem>
      </segmentedlist>

      <variablelist>
        <bridgehead renderas="sect3">Short Descriptions</bridgehead>
        <?dbfo list-presentation="list"?>
        <?dbhtml list-presentation="table"?>

        <varlistentry id="dibbler-prog">
          <term><command>dibbler</command></term>
          <listitem>
            <para>sells sausage inna bun.</para>
            <!-- the -prog is for while (old) and new- perl module pages
             are both in the book, without it the link to the package is
             correct, but the link to the prog goes to the progs in old
             perl-modules.xml -->
            <indexterm zone="new-perl-fu-bar dibbler-prog">
              <primary sortas="b-dibbler">dibbler</primary>
            </indexterm>
          </listitem>
        </varlistentry>

      </variablelist>

    </sect3>

  </sect2>