/usr/share/doc/lire/dev-manual/ch08.html is in lire-devel-doc 2:2.1.1-2.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Chapter 8. The Lire Report Configuration Specification Markup Language</title><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><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="prev" href="ch07.html" title="Chapter 7. Common Textual Elements to All XML Formats"><link rel="next" href="ch09.html" title="Chapter 9. The Lire Report Configuration 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 8. The Lire Report Configuration Specification Markup Language</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07.html">Prev</a> </td><th width="60%" align="center">Part III. Developer's Reference</th><td width="20%" align="right"> <a accesskey="n" href="ch09.html">Next</a></td></tr></table><hr></div><div class="chapter" title="Chapter 8. The Lire Report Configuration Specification Markup Language"><div class="titlepage"><div><div><h2 class="title"><a name="chap:lrcsml-doc"></a>Chapter 8. The Lire Report Configuration Specification Markup Language</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="ch08.html#id406131">The Lire Report Configuration Specification Markup Language</a></span></dt><dd><dl><dt><span class="section"><a href="ch08.html#id406254"><code class="sgmltag-element">config-spec</code> element</a></span></dt><dt><span class="section"><a href="ch08.html#id406280"><code class="sgmltag-element">summary</code> element</a></span></dt><dt><span class="section"><a href="ch08.html#id406305">Parameter Specifiations Elements</a></span></dt></dl></dd></dl></div><div class="section" title="The Lire Report Configuration Specification Markup Language"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="id406131"></a>The Lire Report Configuration Specification Markup Language</h2></div></div></div><p>Document Type Definition for the Lire Report Configuration Specification
Markup Language.</p><p>This DTD defines a grammar that is used to specify the
configuration parameters used by the Lire framework. Besides the
framework parameters, this DTD can be used by extensions writers to
register their parameters with the framework. The configuration
specifications are usually stored in
<code class="filename"><em class="replaceable"><code>prefix</code></em>/share/lire/config-spec</code>.
</p><p>Currently, Lire's configuration namespace is flat, which means
that two different specification documents cannot define parameters
of the same names.
</p><p>Elements of this DTD uses the
<span class="type">http://www.logreport.org/LRCSML/</span> namespace that is
usually mapped to the <code class="literal">lrcsml</code> prefix.
</p><p>The latest version of that DTD is
<span class="productnumber">1.1</span> and its public
identifier is <span class="productname">-//LogReport.ORG//DTD Lire Report
Specification Markup Language V1.1//EN</span>™.
Its canonical system identifier is <a class="ulink" href="http://www.logreport.org/LRCSML/1.1/lrcsml.dtd" target="_top">http://www.logreport.org/LRCSML/1.1/lrcsml.dtd</a>.
</p><pre class="programlisting">
<!--
-->
<!-- Namespace prefix for validation using the
DTD -->
<!ENTITY % LRCSML.xmlns.pfx "lrcsml" >
<!ENTITY % LRCSML.pfx "%LRCSML.xmlns.pfx;:" >
<!ENTITY % LRCSML.xmlns.attr.name "xmlns:%LRCSML.xmlns.pfx;" >
<!ENTITY % LRCSML.xmlns.attr
"%LRCSML.xmlns.attr.name; CDATA #FIXED 'http://www.logreport.org/LRCSML/'">
<!ENTITY % LRCML.xmlns.pfx "lrcml" >
<!ENTITY % LRCML.pfx "%LRCML.xmlns.pfx;:" >
<!ENTITY % LRCML.xmlns.attr.name "xmlns:%LRCML.xmlns.pfx;">
<!ENTITY % LRCML.xmlns.attr
"%LRCML.xmlns.attr.name; CDATA #FIXED 'http://www.logreport.org/LRCML/'">
<!-- For the modules which we are including -->
<!ENTITY % LIRE.pfx "%LRCSML.pfx;" >
</pre><p>This DTD uses the common <span class="type">lire-desc.mod</span> module
which is used to include a subset of DocBook in description and
text elements.
</p><pre class="programlisting">
<!ENTITY % lire-desc.mod PUBLIC
"-//LogReport.ORG//ELEMENTS Lire Description Elements V2.0//EN"
"lire-desc.mod">
%lire-desc.mod;
</pre><p>Each configuration specification is a XML document which has one
<code class="sgmltag-element">config-spec</code> as its root element.
</p><pre class="programlisting">
<!ENTITY % LRCSML.config-spec "%LRCSML.pfx;config-spec" >
<!ENTITY % LRCSML.summary "%LRCSML.pfx;summary" >
<!ENTITY % LRCSML.boolean "%LRCSML.pfx;boolean" >
<!ENTITY % LRCSML.integer "%LRCSML.pfx;integer" >
<!ENTITY % LRCSML.string "%LRCSML.pfx;string" >
<!ENTITY % LRCSML.dlf-schema "%LRCSML.pfx;dlf-schema" >
<!ENTITY % LRCSML.dlf-streams "%LRCSML.pfx;dlf-streams" >
<!ENTITY % LRCSML.dlf-converter "%LRCSML.pfx;dlf-converter" >
<!ENTITY % LRCSML.command "%LRCSML.pfx;command" >
<!ENTITY % LRCSML.file "%LRCSML.pfx;file" >
<!ENTITY % LRCSML.executable "%LRCSML.pfx;executable" >
<!ENTITY % LRCSML.directory "%LRCSML.pfx;directory" >
<!ENTITY % LRCSML.select "%LRCSML.pfx;select" >
<!ENTITY % LRCSML.option "%LRCSML.pfx;option" >
<!ENTITY % LRCSML.list "%LRCSML.pfx;list" >
<!ENTITY % LRCSML.object "%LRCSML.pfx;object" >
<!ENTITY % LRCSML.output-format "%LRCSML.pfx;output-format" >
<!ENTITY % LRCSML.plugin "%LRCSML.pfx;plugin" >
<!ENTITY % LRCSML.record "%LRCSML.pfx;record" >
<!ENTITY % LRCSML.reference "%LRCSML.pfx;reference" >
<!ENTITY % LRCSML.report-config "%LRCSML.pfx;report-config" >
<!ENTITY % LRCML.param "%LRCML.pfx;param" >
<!ENTITY % LRCSML.summary "%LRCSML.pfx;summary" >
<!ENTITY % types-spec "%LRCSML.boolean;|%LRCSML.integer;|
%LRCSML.string;|%LRCSML.dlf-schema;|
%LRCSML.dlf-converter;|%LRCSML.dlf-streams;|
%LRCSML.command;|%LRCSML.file;|
%LRCSML.executable;|%LRCSML.directory;|
%LRCSML.select;|%LRCSML.list;|%LRCSML.object;|
%LRCSML.output-format;|
%LRCSML.plugin;|%LRCSML.record;|%LRCSML.reference;
|%LRCSML.report-config;
">
<!ENTITY % common.mix "(%LRCSML.summary;)?,(%LIRE.description;)?">
<!ENTITY % default "(%LRCML.param;)?" >
<!ENTITY % common.mix.default "(%common.mix;, %default;)" >
<!ELEMENT %LRCML.param; (#PCDATA|%LRCML.param;)* >
<!ATTLIST %LRCML.param;
name NMTOKEN #REQUIRED
value CDATA #IMPLIED >
</pre><div class="section" title="config-spec element"><div class="titlepage"><div><div><h3 class="title"><a name="id406254"></a><code class="sgmltag-element">config-spec</code> element</h3></div></div></div><p>Root element of a configuration specification document. It
contains a list of parameter specifications..
</p><p>This element doesn't have any attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.config-spec; ((%types-spec;)+) >
<!ATTLIST %LRCSML.config-spec;
%LRCSML.xmlns.attr;
%LRCML.xmlns.attr; >
</pre></div><div class="section" title="summary element"><div class="titlepage"><div><div><h3 class="title"><a name="id406280"></a><code class="sgmltag-element">summary</code> element</h3></div></div></div><p>This element is used for a short one description of the
parameter's purpose. Use the <code class="sgmltag-element">description</code>
element for longer help text.
</p><p>This element doesn't have any attribute.</p><pre class="programlisting">
<!ELEMENT %LRCSML.summary; (#PCDATA) >
</pre></div><div class="section" title="Parameter Specifiations Elements"><div class="titlepage"><div><div><h3 class="title"><a name="id406305"></a>Parameter Specifiations Elements</h3></div></div></div><div class="section" title="Common Attributes"><div class="titlepage"><div><div><h4 class="title"><a name="id406311"></a>Common Attributes</h4></div></div></div><p>These attributes are common to all parameters specification
elements:</p><div class="variablelist"><dl><dt><span class="term">name</span></dt><dd><p>Contains the name of the parameter to which this
specification apply.
</p></dd><dt><span class="term">required</span></dt><dd><p>Determines if a valid value is required to make the
container validates. Defaults to true.
</p></dd><dt><span class="term">section</span></dt><dd><p>This attribute can be used to set a menu section which
can be used by configuration frontends to group parameters together.
</p></dd><dt><span class="term">summary</span></dt><dd><p>This attribute is equivalent to the <code class="sgmltag-element">summary</code> element.
</p></dd><dt><span class="term">obsolete</span></dt><dd><p>This attribute can be used to mark a parameter as
obsolete. Obsolete parameters will be removed from the
specification in a future Lire release.
</p></dd></dl></div><pre class="programlisting">
<!ENTITY % common.attr "
name NMTOKEN #REQUIRED
required NMTOKEN '1'
section CDATA #IMPLIED
summary CDATA #IMPLIED
obsolete NMTOKEN '0'">
</pre></div><div class="section" title="boolean element"><div class="titlepage"><div><div><h4 class="title"><a name="id406408"></a><code class="sgmltag-element">boolean</code> element</h4></div></div></div><p>This element is used to define a boolean parameter which can
takes a <code class="constant">yes</code> or <code class="constant">no</code>
value.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.boolean; (%common.mix.default;) >
<!ATTLIST %LRCSML.boolean;
%common.attr;
>
</pre></div><div class="section" title="integer element"><div class="titlepage"><div><div><h4 class="title"><a name="id406440"></a><code class="sgmltag-element">integer</code> element</h4></div></div></div><p>This element is used to define an integer parameter.</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.integer; (%common.mix.default;) >
<!ATTLIST %LRCSML.integer;
%common.attr;
>
</pre></div><div class="section" title="string element"><div class="titlepage"><div><div><h4 class="title"><a name="id406464"></a><code class="sgmltag-element">string</code> element</h4></div></div></div><p>This element is used to define an string parameter. These
parameters can contains any value.
</p><p>This can have a <code class="sgmltag-attribute">valid-re</code> attribute which specify a
regular expression that the value must match.</p><pre class="programlisting">
<!ELEMENT %LRCSML.string; (%common.mix.default;) >
<!ATTLIST %LRCSML.string;
%common.attr;
valid-re CDATA #IMPLIED
>
</pre></div><div class="section" title="dlf-converter element"><div class="titlepage"><div><div><h4 class="title"><a name="id406497"></a><code class="sgmltag-element">dlf-converter</code> element</h4></div></div></div><p>This element is used to select a registered
DlfConverter.</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.dlf-converter; (%common.mix.default;) >
<!ATTLIST %LRCSML.dlf-converter;
%common.attr;
>
</pre></div><div class="section" title="dlf-schema element"><div class="titlepage"><div><div><h4 class="title"><a name="id406522"></a><code class="sgmltag-element">dlf-schema</code> element</h4></div></div></div><p>This element is used to select an available DlfSchema.</p><p>If this element has the <code class="sgmltag-attribute">superservices</code> set, only
superservices can be selected.
</p><pre class="programlisting">
<!ELEMENT %LRCSML.dlf-schema; (%common.mix.default;) >
<!ATTLIST %LRCSML.dlf-schema;
%common.attr;
superservices NMTOKEN '0'
>
</pre></div><div class="section" title="dlf-streams element"><div class="titlepage"><div><div><h4 class="title"><a name="id406553"></a><code class="sgmltag-element">dlf-streams</code> element</h4></div></div></div><p>This element is used to configure Lire::DlfStream in
Lire::DlfStore.</p><p>This element has no attribute.</p><pre class="programlisting">
<!ELEMENT %LRCSML.dlf-streams; (%common.mix.default;) >
<!ATTLIST %LRCSML.dlf-streams;
%common.attr;
>
</pre></div><div class="section" title="command element"><div class="titlepage"><div><div><h4 class="title"><a name="id406579"></a><code class="sgmltag-element">command</code> element</h4></div></div></div><p>This element is used to define a command parameter.
To be accepted as valid the parameter's value must point to an
executable file or an executable file with the specified value
must exist in a directory of the PATH environment variable.</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.command; (%common.mix.default;) >
<!ATTLIST %LRCSML.command;
%common.attr;
>
</pre></div><div class="section" title="file element"><div class="titlepage"><div><div><h4 class="title"><a name="id406606"></a><code class="sgmltag-element">file</code> element</h4></div></div></div><p>This element is used to define a file parameter. To be
accepted as valid, the parameter's value must point to an existing
file.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.file; (%common.mix.default;) >
<!ATTLIST %LRCSML.file;
%common.attr;
>
</pre></div><div class="section" title="directory element"><div class="titlepage"><div><div><h4 class="title"><a name="id406631"></a><code class="sgmltag-element">directory</code> element</h4></div></div></div><p>This element is used to define a directory parameter. To be
accepted as valid, the parameter's value must point to an existing
directory.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.directory; (%common.mix.default;) >
<!ATTLIST %LRCSML.directory;
%common.attr;
>
</pre></div><div class="section" title="executable element"><div class="titlepage"><div><div><h4 class="title"><a name="id406657"></a><code class="sgmltag-element">executable</code> element</h4></div></div></div><p>This element is used to define an executable parameter. To be
accepted as valid, the parameter's value must point to an existing
executable file.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.executable; (%common.mix.default;) >
<!ATTLIST %LRCSML.executable;
%common.attr;
>
</pre></div><div class="section" title="select element"><div class="titlepage"><div><div><h4 class="title"><a name="id406684"></a><code class="sgmltag-element">select</code> element</h4></div></div></div><p>This element is used to define a parameter for which the
value is selected among a set of options. The allowed set of
options is specified using <code class="sgmltag-element">option</code> elements.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.select; (%common.mix;,(%LRCSML.option;)+, %default;) >
<!ATTLIST %LRCSML.select;
%common.attr;
>
</pre></div><div class="section" title="option element"><div class="titlepage"><div><div><h4 class="title"><a name="id406713"></a><code class="sgmltag-element">option</code> element</h4></div></div></div><p>This element is used to define the valid values for a
<code class="sgmltag-element">select</code> parameter.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.option; (%common.mix;) >
<!ATTLIST %LRCSML.option;
%common.attr;
>
</pre></div><div class="section" title="list element"><div class="titlepage"><div><div><h4 class="title"><a name="id406742"></a><code class="sgmltag-element">list</code> element</h4></div></div></div><p>This element is used to define a parameter that can contains
an ordered set of values. The type of values which can be
contained is specified using other parameters elements. Any number
of parameters of the type specified by the children elements can
be contained by the defined parameter.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.list; (%common.mix;,(%types-spec;)+,%default;) >
<!ATTLIST %LRCSML.list;
%common.attr;
>
</pre></div><div class="section" title="object element"><div class="titlepage"><div><div><h4 class="title"><a name="id406769"></a><code class="sgmltag-element">object</code> element</h4></div></div></div><p>This element is used to define a parameter that will instantiate an
object. The object will be instantiated by calling the "new_from_config()"
class method defined in the package specified by the element's <code class="sgmltag-attribute">class</code> attribute. The constructor will receive
the hash instantiated from the parameter's components as parameter.
</p><p>The <code class="sgmltag-attribute">label</code> attribute can
be used to specify the contained element that should be used to
represent this object in lists.
</p><pre class="programlisting">
<!ELEMENT %LRCSML.object; (%common.mix;,(%types-spec;)+,%default;) >
<!ATTLIST %LRCSML.object;
%common.attr;
class NMTOKEN #REQUIRED
label NMTOKEN #IMPLIED
>
</pre></div><div class="section" title="output-format element"><div class="titlepage"><div><div><h4 class="title"><a name="id406810"></a><code class="sgmltag-element">output-format</code> element</h4></div></div></div><p>This element is used to select an available
OutputFormat.</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.output-format; (%common.mix.default;) >
<!ATTLIST %LRCSML.output-format;
%common.attr;
>
</pre></div><div class="section" title="record element"><div class="titlepage"><div><div><h4 class="title"><a name="id406836"></a><code class="sgmltag-element">record</code> element</h4></div></div></div><p>This element is used to define a parameter that holds record-like
data.
</p><p>The <code class="sgmltag-attribute">label</code> attribute can
be used to specify the contained element that should be used to
represent this record in lists.
</p><pre class="programlisting">
<!ELEMENT %LRCSML.record; (%common.mix;,(%types-spec;)+, %default;) >
<!ATTLIST %LRCSML.record;
%common.attr;
label NMTOKEN #IMPLIED
>
</pre></div><div class="section" title="record element"><div class="titlepage"><div><div><h4 class="title"><a name="id406869"></a><code class="sgmltag-element">record</code> element</h4></div></div></div><p>This element is used to define a parameter that holds record-like
data.
</p><p>The <code class="sgmltag-attribute">label</code> attribute can
be used to specify the contained element that should be used to
represent this record in lists.
</p><pre class="programlisting">
<!ELEMENT %LRCSML.record; (%common.mix;,(%types-spec;)+,%default;) >
<!ATTLIST %LRCSML.record;
%common.attr;
label NMTOKEN #IMPLIED
>
</pre></div><div class="section" title="reference element"><div class="titlepage"><div><div><h4 class="title"><a name="id406902"></a><code class="sgmltag-element">reference</code> element</h4></div></div></div><p>This element is used to select from an index. The index in
which the available values is taken is specified in the <code class="sgmltag-attribute">index</code> attribute.</p><pre class="programlisting">
<!ELEMENT %LRCSML.reference; (%common.mix.default;) >
<!ATTLIST %LRCSML.reference;
%common.attr;
index CDATA #REQUIRED
>
</pre></div><div class="section" title="report-config element"><div class="titlepage"><div><div><h4 class="title"><a name="id406931"></a><code class="sgmltag-element">report-config</code> element</h4></div></div></div><p>This element is used to configure a report configuration.</p><p>This element doesn't have any attribute. Each superservice
can define a default report configuration using this element with
a name of
<code class="constant"><em class="replaceable"><code>superservice</code></em>_default</code>.
</p><pre class="programlisting">
<!ELEMENT %LRCSML.report-config; (%common.mix.default;) >
<!ATTLIST %LRCSML.report-config;
%common.attr;
>
</pre></div><div class="section" title="plugin element"><div class="titlepage"><div><div><h4 class="title"><a name="id406963"></a><code class="sgmltag-element">plugin</code> element</h4></div></div></div><p>This element is used to define a parameter for which the value is
selected among a set of options. The allowed set of options is specified
using <code class="sgmltag-element">option</code> elements. The element will also contain
additional parameters based on the selected value. The available
paramaters should be defined in a <code class="sgmltag-element">record</code> or similar
specification named
<code class="varname"><em class="replaceable"><code>name</code></em>_properties</code>. For
example, the additional parameters when the <code class="literal">option_1</code>
option is selected will be found in the specification named
<code class="literal">option_1_properties</code>.
</p><p>This element doesn't have any specific attributes.</p><pre class="programlisting">
<!ELEMENT %LRCSML.plugin; (%common.mix;,(%LRCSML.option;)+, %default;) >
<!ATTLIST %LRCSML.plugin;
%common.attr;
>
</pre></div></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07.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="ch09.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 7. Common Textual Elements to All XML Formats </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> Chapter 9. The Lire Report Configuration Markup Language</td></tr></table></div></body></html>
|