~ubuntu-branches/ubuntu/karmic/lire/karmic

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 9. The Lire Report Configuration Markup Language</title><meta name="generator" content="DocBook XSL Stylesheets V1.64.1"><link rel="home" href="index.html" title="Lire Developer's Manual"><link rel="up" href="pt03.html" title="Part III. Developer's Reference"><link rel="previous" href="ch08.html" title="Chapter 8. The Lire Report Configuration Specification Markup Language"><link rel="next" href="ch10.html" title="Chapter 10. The Lire DLF Schema Markup Language"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 9. The Lire Report Configuration Markup Language</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch08.html">Prev</a> </td><th width="60%" align="center">Part III. Developer's Reference</th><td width="20%" align="right"> <a accesskey="n" href="ch10.html">Next</a></td></tr></table><hr></div><div class="chapter" lang="en"><div class="titlepage"><div><div><h2 class="title"><a name="chap:lrcml-doc"></a>Chapter 9. The Lire Report Configuration Markup Language</h2></div></div><div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch09.html#id2510428">The Lire Report Configuration Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#id2510510">config element</a></span></dt><dt><span class="section"><a href="ch09.html#id2510547">global element</a></span></dt><dt><span class="section"><a href="ch09.html#id2510573">param element</a></span></dt></dl></dd></dl></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id2510428"></a>The Lire Report Configuration Markup Language</h2></div></div><div></div></div><p>Document Type Definition for the Lire Report Configuration Markup Language.</p><p>This DTD defines a grammar that is used to store the Lire
   configuration. The configuration is stored in one or more XML
   files. Parameters set in later configuration files override the
   ones set in the formers. The valid parameter names as well as their
   description and type are specified using configuration
   specification documents.
  </p><p>Elements of this DTD use the
   <span class="type">http://www.logreport.org/LRCML/</span> namespace, which is
   usually mapped to the <tt class="literal">lrcml</tt> prefix.
  </p><p>The latest version of the DTD is
   <span class="productnumber">1.0</span> and its public
   identifier is <span class="productname">-//LogReport.ORG//DTD Lire Report
   Specification Markup Language V1.0//EN</span>&#8482;.
   Its canonical system identifier is <a href="http://www.logreport.org/LRCML/1.0/lrcml.dtd" target="_top">http://www.logreport.org/LRCML/1.0/lrcml.dtd</a>.
  </p><pre class="programlisting">

&lt;!--                    
                                                                   --&gt;

&lt;!--                    Namespace prefix for validation using the
                        DTD                                        --&gt;
&lt;!ENTITY % LRCML.xmlns.pfx    "lrcml"                                 &gt;
&lt;!ENTITY % xmlns.colon       ":"                                     &gt;
&lt;!ENTITY % LRCML.pfx          "%LRCML.xmlns.pfx;%xmlns.colon;"         &gt;
&lt;!ENTITY % LRCML.xmlns.attr.name "xmlns%xmlns.colon;%LRCML.xmlns.pfx;" &gt;
&lt;!ENTITY % LRCML.xmlns.attr
  "%LRCML.xmlns.attr.name; CDATA #FIXED 'http://www.logreport.org/LRCML/'"&gt;

&lt;!-- For the module which we are including                          --&gt;
&lt;!ENTITY % LIRE.pfx           "%LRCML.pfx;"                          &gt;

  </pre><p>Each configuration specification is an XML document which has one
   <tt class="sgmltag-element">config</tt> as its root element.
  </p><pre class="programlisting">

&lt;!ENTITY % LRCML.config          "%LRCML.pfx;config"                   &gt;
&lt;!ENTITY % LRCML.global          "%LRCML.pfx;global"                   &gt;
&lt;!ENTITY % LRCML.param           "%LRCML.pfx;param"                    &gt;
                                  

  </pre><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2510510"></a><tt class="sgmltag-element">config</tt> element</h3></div></div><div></div></div><p>Root element of a configuration document. It contains
    presently only one <tt class="sgmltag-element">global</tt> element which is used
    to hold the global configuration parameters.
   </p><p>This element doesn't have any attributes.</p><pre class="programlisting">

&lt;!ELEMENT %LRCML.config; (%LRCML.global;)                              &gt;
&lt;!ATTLIST %LRCML.config;
             %LRCML.xmlns.attr;                                       &gt;

   </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2510547"></a><tt class="sgmltag-element">global</tt> element</h3></div></div><div></div></div><p>This element starts the global configuration data. (This is
    the only scope currently defined). It contains a list of
    <tt class="sgmltag-element">param</tt> elements.
   </p><pre class="programlisting">

&lt;!ELEMENT %LRCML.global; (%LRCML.param;)+                              &gt;

   </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2510573"></a><tt class="sgmltag-element">param</tt> element</h3></div></div><div></div></div><p>This element contains the parameter's value. The parameter's
    name is defined in the <tt class="sgmltag-attribute">name</tt>
    attribute.
   </p><p>The <tt class="sgmltag-attribute">value</tt> attribute can be
        used to store scalar's value.
   </p><p>When the parameter's type is a list, the values are stored in
    children <tt class="sgmltag-element">param</tt> elements.
   </p><div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Warning</h3><p>This element has a mixed content type. We should probably
     use a <tt class="sgmltag-attribute">value</tt> attribute to
     hold scalar values.
    </p></div><pre class="programlisting">

&lt;!ELEMENT %LRCML.param; (#PCDATA|%LRCML.param;)*                       &gt;
&lt;!ATTLIST %LRCML.param;
             name      NMTOKEN                             #REQUIRED
             value     CDATA                               #IMPLIED &gt;

   </pre></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch08.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="pt03.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch10.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 8. The Lire Report Configuration Specification Markup Language </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 10. The Lire DLF Schema Markup Language</td></tr></table></div></body></html>