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

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

perl modules branch: If a module requires a variation of the install for scripting, such as using yes, hardcode the installation instructions and provide a command explanation.

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

  • Property mode set to 100644
File size: 4.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 "fix-me-please-editor-0cc7774186c">
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.
51 If module A currently brings in the required dep of B, add a comment that
52 B is pulled in by A. This is to keep it maintainable as deps change. -->
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 <!-- perl-bar-baz pulls in perl-mojotasticity for the testsuite -->
59 <xref linkend="perl-wibble"/> and
60 <xref linkend="new-perl-wobble"/>
61 </para>
62
63 </sect3>
64
65 <sect3 role="installation">
66 <title>Installation of Fu::Bar</title>
67
68<!-- Any specific action for the module (patches, etc) should come first -->
69<!-- If the module uses standard installation instructions: -->
70 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
71 href="../../../xincludes/perl-standard-install.xml"/>
72
73<!-- If the module uses installation instructions using Build.PL: -->
74 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
75 href="../../../xincludes/perl-build-install.xml"/>
76
77<!-- Exceptionally, if a scripted build requires a value to be passed to 'yes',
78 copy the xinclude inline and add the command explanation -->
79 </sect3>
80
81 <!-- only include a command explanation if yes or similar is needed in
82 scripting -->
83 <sect3 role="commands">
84 <title>Command Explanations</title>
85
86 <para>
87 <command>yes 'n'</command>: Perl will ask if you wish to do ...
88 and will wait for a response. Using 'yes' allows you to script this.
89 </para>
90
91 </sect3>
92
93 <!-- omit content unless prog(s) or lib is installed in /usr -->
94 <sect3 role="content">
95 <title>Contents</title>
96
97 <segmentedlist>
98 <segtitle>Installed Programs</segtitle>
99 <!-- omit libraries entirely unless present in /usr, there are often
100 perl libraries in site-perl so 'none' can be misleading -->
101 <segtitle>Installed Libraries</segtitle>
102
103 <seglistitem>
104 <seg>
105 dibbler
106 </seg>
107 </seglistitem>
108 </segmentedlist>
109
110 <variablelist>
111 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
112 <?dbfo list-presentation="list"?>
113 <?dbhtml list-presentation="table"?>
114
115 <varlistentry id="dibbler-prog">
116 <term><command>dibbler</command></term>
117 <listitem>
118 <para>sells sausage inna bun.</para>
119 <!-- the -prog is for while (old) and new- perl module pages
120 are both in the book, without it the link to the package is
121 correct, but the link to the prog goes to the progs in old
122 perl-modules.xml -->
123 <indexterm zone="new-perl-fu-bar dibbler-prog">
124 <primary sortas="b-dibbler">dibbler</primary>
125 </indexterm>
126 </listitem>
127 </varlistentry>
128
129 </variablelist>
130
131 </sect3>
132
133 </sect2>
Note: See TracBrowser for help on using the repository browser.