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

perl-modules
Last change on this file since e305bb90 was e305bb90, checked in by Ken Moffat <ken@…>, 3 years ago

New branch for testing changes to perl modules.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/perl-modules@20472 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 3.6 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../../general.ent">
5 %general-entities;
6
7 <!-- for modules referenced outside of perl, put them in general/prog/perl-modules/
8 and use a link to &perl_authors;/id/X/XY/XYZZY/Fu-Bar-$Fu-Bar-version; -->
9 <!ENTITY my-download-http "&perl_authors;/id/X/XY/XYZZY/Fu-Bar-&Fu-Bar-version;.tar.gz">
10 <!-- but for modules which are only dependencies of other modules, put them in
11 general/pprog/perl-deps with a link to &metacpan_authors; that includes the /id part -->
12 <!ENTITY my-download-http "&metacpan_authors;/X/XY/XYZZY/Fu-Bar-&Fu-Bar-version;.tar.gz">
13 <!-- only one of the above choices -->
14 <!ENTITY my-md5sum "eff0352d6de29a8d4d61efcc7774186c">
15
16]>
17
18 <!-- Begin Fu::Bar -->
19 <sect2 id="new-perl-fu-bar" xreflabel="Fu-Bar-&Fu-Bar-version;">
20
21 <title>Fu::Bar-&Fu-Bar-version;</title>
22
23 <indexterm zone="new-perl-fu-bar">
24 <primary sortas="a-Fu-Bar">Fu::Bar</primary>
25 </indexterm>
26
27 <sect3 role="package">
28 <title>Introduction to Fu::Bar</title>
29
30 <para>
31 Fu::Bar does something.
32 </para>
33
34<!-- &lfs8x_checked; -->
35
36 <bridgehead renderas="sect4">Package Information</bridgehead>
37 <itemizedlist spacing="compact">
38 <listitem>
39 <para>
40 Download (HTTP): <ulink url="&my-download-http;"/>
41 </para>
42 </listitem>
43 <listitem>
44 <para>
45 Download MD5 sum: &my-md5sum;
46 </para>
47 </listitem>
48 </itemizedlist>
49
50 <!-- omit dependencies if not needed, but unlike the rest of the book,
51 show ALL perl module dependencies, avoid thinking "b will bring in a",
52 their deps might change when one is next updated. -->
53 <bridgehead renderas="sect4">Fu::Bar Dependencies</bridgehead>
54
55 <bridgehead renderas="sect5">Required</bridgehead>
56 <para role="required">
57 <xref linkend="perl-bar-baz"/>,
58 <xref linkend="perl-wibble"/> and
59 <xref linkend="new-perl-wobble"/>
60 </para>
61
62 </sect3>
63
64 <sect3 role="installation">
65 <title>Installation of Fu::Bar</title>
66
67 <para>
68 This module uses the <xref linkend="new-perl-standard-install"/>.
69 </para>
70
71 </sect3>
72
73 <!-- omit content unless prog(s) or lib is installed in /usr -->
74 <sect3 role="content">
75 <title>Contents</title>
76
77 <segmentedlist>
78 <segtitle>Installed Programs</segtitle>
79 <!-- omit libraries entirely unless present in /usr, there are often
80 perl libraries in site-perl so 'none' can be misleading -->
81 <segtitle>Installed Libraries</segtitle>
82
83 <seglistitem>
84 <seg>
85 dibbler
86 </seg>
87 </seglistitem>
88 </segmentedlist>
89
90 <variablelist>
91 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
92 <?dbfo list-presentation="list"?>
93 <?dbhtml list-presentation="table"?>
94
95 <varlistentry id="dibbler-prog">
96 <term><command>dibbler</command></term>
97 <listitem>
98 <para>sells sausage inna bun.</para>
99 <!-- the -prog is for while (old) and new- perl module pages
100 are both in the book, without it the link to the package is
101 correct, but the link to the prog goes to the progs in old
102 perl-modules.xml -->
103 <indexterm zone="new-perl-fu-bar dibbler-prog">
104 <primary sortas="b-dibbler">dibbler</primary>
105 </indexterm>
106 </listitem>
107 </varlistentry>
108
109 </variablelist>
110
111 </sect3>
112
113 </sect2>
Note: See TracBrowser for help on using the repository browser.