Start work of multi target search
[metaproxy-moved-to-github.git] / doc / template.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % idcommon SYSTEM "common/common.ent">
5      %idcommon;
6 ]>
7 <refentry id="ref-template">
8  <refentryinfo>
9   <productname>Metaproxy</productname>
10   <info><orgname>Index Data</orgname></info>
11  </refentryinfo>
12
13  <refmeta>
14   <refentrytitle>template</refentrytitle>
15   <manvolnum>3mp</manvolnum>
16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
17  </refmeta>
18
19  <refnamediv>
20   <refname>template</refname>
21   <refpurpose>Metaproxy Template Module That Does Nothing</refpurpose>
22  </refnamediv>
23
24  <refsect1><title>DESCRIPTION</title>
25   <para>
26    This module does nothing at all, simply passing packages through
27    untouched.  It exists not to be instantiated, but to be copied by
28    programmers creating new filters.
29   </para>
30  </refsect1>
31
32  <refsect1><title>EXAMPLES</title>
33   <para>
34    A typical configuration looks like this:
35    <screen><![CDATA[
36     <filter type="template"/>
37 ]]>
38    </screen>
39   </para>
40  </refsect1>
41
42   <refsect1><title>SEE ALSO</title>
43   <para>
44    <citerefentry>
45     <refentrytitle>metaproxy</refentrytitle>
46     <manvolnum>1</manvolnum>
47    </citerefentry>
48   </para>
49  </refsect1>
50
51  &copyright;
52 </refentry>
53
54 <!-- Keep this comment at the end of the file
55 Local variables:
56 mode: nxml
57 nxml-child-indent: 1
58 End:
59 -->