source: template/template-perl-module.xml@ 2d6354a7

perl-modules
Last change on this file since 2d6354a7 was 2d6354a7, checked in by Pierre Labastie <pieere@…>, 3 years ago

Modify the template for perl modules, for new layout of instructions

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

  • Property mode set to 100644
File size: 4.0 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<!-- Any specific action for the module (patches, etc) should come first -->
68<!-- If the module uses standard installation instructions: -->
69 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
70 href="../../../xincludes/perl-standard-install.xml"/>
71
72<!-- If the module uses installation instructions using Build.PL: -->
73 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
74 href="../../../xincludes/perl-build-install.xml"/>
75
76 </sect3>
77
78 <!-- omit content unless prog(s) or lib is installed in /usr -->
79 <sect3 role="content">
80 <title>Contents</title>
81
82 <segmentedlist>
83 <segtitle>Installed Programs</segtitle>
84 <!-- omit libraries entirely unless present in /usr, there are often
85 perl libraries in site-perl so 'none' can be misleading -->
86 <segtitle>Installed Libraries</segtitle>
87
88 <seglistitem>
89 <seg>
90 dibbler
91 </seg>
92 </seglistitem>
93 </segmentedlist>
94
95 <variablelist>
96 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
97 <?dbfo list-presentation="list"?>
98 <?dbhtml list-presentation="table"?>
99
100 <varlistentry id="dibbler-prog">
101 <term><command>dibbler</command></term>
102 <listitem>
103 <para>sells sausage inna bun.</para>
104 <!-- the -prog is for while (old) and new- perl module pages
105 are both in the book, without it the link to the package is
106 correct, but the link to the prog goes to the progs in old
107 perl-modules.xml -->
108 <indexterm zone="new-perl-fu-bar dibbler-prog">
109 <primary sortas="b-dibbler">dibbler</primary>
110 </indexterm>
111 </listitem>
112 </varlistentry>
113
114 </variablelist>
115
116 </sect3>
117
118 </sect2>
Note: See TracBrowser for help on using the repository browser.