← Back to branch summary

~ubuntu-branches/ubuntu/maverick/lire/maverick

« back to all changes in this revision

Viewing changes to doc/dev-manual/ch09.html

  • Committer: Bazaar Package Importer
  • Author(s): Joost van Baal
  • Date: 2006-11-02 15:30:00 UTC
  • mto: This revision was merged to the branch mainline in revision 4.
  • Revision ID: james.westby@ubuntu.com-20061102153000-343pa15n0rp58m1b
Tags: upstream-2.0.2
Import upstream version 2.0.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/dev-manual/ch09.html
1
 
<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
 
1
<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.68.1"><link rel="start" href="index.html" title="Lire Developer's Manual"><link rel="up" href="pt03.html" title="Part�III.�Developer's Reference"><link rel="prev" 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 class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch09.html#id2524715">The Lire Report Configuration Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch09.html#id2524795"><code class="sgmltag-element">config</code> element</a></span></dt><dt><span class="section"><a href="ch09.html#id2524832"><code class="sgmltag-element">global</code> element</a></span></dt><dt><span class="section"><a href="ch09.html#id2524859"><code class="sgmltag-element">param</code> 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="id2524715"></a>The Lire Report Configuration Markup Language</h2></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
2
2
   configuration. The configuration is stored in one or more XML
3
3
   files. Parameters set in later configuration files override the
4
4
   ones set in the formers. The valid parameter names as well as their
6
6
   specification documents.
7
7
  </p><p>Elements of this DTD use the
8
8
   <span class="type">http://www.logreport.org/LRCML/</span> namespace, which is
9
 
   usually mapped to the <tt class="literal">lrcml</tt> prefix.
 
9
   usually mapped to the <code class="literal">lrcml</code> prefix.
10
10
  </p><p>The latest version of the DTD is
11
11
   <span class="productnumber">1.0</span> and its public
12
12
   identifier is <span class="productname">-//LogReport.ORG//DTD Lire Report
30
30
&lt;!ENTITY % LIRE.pfx           "%LRCML.pfx;"                          &gt;
31
31
 
32
32
  </pre><p>Each configuration specification is an XML document which has one
33
 
   <tt class="sgmltag-element">config</tt> as its root element.
 
33
   <code class="sgmltag-element">config</code> as its root element.
34
34
  </p><pre class="programlisting">
35
35
 
36
36
&lt;!ENTITY % LRCML.config          "%LRCML.pfx;config"                   &gt;
38
38
&lt;!ENTITY % LRCML.param           "%LRCML.pfx;param"                    &gt;
39
39
                                  
40
40
 
41
 
  </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
42
 
    presently only one <tt class="sgmltag-element">global</tt> element which is used
 
41
  </pre><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2524795"></a><code class="sgmltag-element">config</code> element</h3></div></div></div><p>Root element of a configuration document. It contains
 
42
    presently only one <code class="sgmltag-element">global</code> element which is used
43
43
    to hold the global configuration parameters.
44
44
   </p><p>This element doesn't have any attributes.</p><pre class="programlisting">
45
45
 
47
47
&lt;!ATTLIST %LRCML.config;
48
48
             %LRCML.xmlns.attr;                                       &gt;
49
49
 
50
 
   </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
 
50
   </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2524832"></a><code class="sgmltag-element">global</code> element</h3></div></div></div><p>This element starts the global configuration data. (This is
51
51
    the only scope currently defined). It contains a list of
52
 
    <tt class="sgmltag-element">param</tt> elements.
 
52
    <code class="sgmltag-element">param</code> elements.
53
53
   </p><pre class="programlisting">
54
54
 
55
55
&lt;!ELEMENT %LRCML.global; (%LRCML.param;)+                              &gt;
56
56
 
57
 
   </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
58
 
    name is defined in the <tt class="sgmltag-attribute">name</tt>
 
57
   </pre></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="id2524859"></a><code class="sgmltag-element">param</code> element</h3></div></div></div><p>This element contains the parameter's value. The parameter's
 
58
    name is defined in the <code class="sgmltag-attribute">name</code>
59
59
    attribute.
60
 
   </p><p>The <tt class="sgmltag-attribute">value</tt> attribute can be
 
60
   </p><p>The <code class="sgmltag-attribute">value</code> attribute can be
61
61
        used to store scalar's value.
62
62
   </p><p>When the parameter's type is a list, the values are stored in
63
 
    children <tt class="sgmltag-element">param</tt> elements.
 
63
    children <code class="sgmltag-element">param</code> elements.
64
64
   </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
65
 
     use a <tt class="sgmltag-attribute">value</tt> attribute to
 
65
     use a <code class="sgmltag-attribute">value</code> attribute to
66
66
     hold scalar values.
67
67
    </p></div><pre class="programlisting">
68
68