hlship 2003/10/15 08:48:44
Modified: hivemind/xdocs configurations.xml rules.xml
Log:
Commit Knut's documentation patch.
Revision Changes Path
1.5 +11 -5 jakarta-commons-sandbox/hivemind/xdocs/configurations.xml
Index: configurations.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/xdocs/configurations.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- configurations.xml 9 Oct 2003 22:58:16 -0000 1.4
+++ configurations.xml 15 Oct 2003 15:48:44 -0000 1.5
@@ -232,7 +232,7 @@
<p>
This example contributes two elements to the <code>com.myco.MyConfig</code>
-configuration point. In the second contribution, the content contains substitution
variables (which use
+configuration point. In the second contribution, the content contains substitution
symbols (which use
a syntax derived from the <a href="http://ant.apache.org/";>Ant</a> build tool).
Symbol
substitution occurs <em>before</em> &schema; rules are executed, so the
<code>config.dir</code>
and <code>config.file</code> symbols will be converted to strings first, then
whatever rules
@@ -244,11 +244,16 @@
<p>
This begs the question: where do symbol values come from? The answser is
application dependent.
HiveMind itself defines a configuration configuration point for this purpose:
-<a
href="&hivemind-hivedoc;#configuration:hivemind.SymbolSource">hivemind.SymbolSource</a>.
Contributions to this configuration point define
-new objects that can provide values for symbols, and identify the order in which
-these objects should be consulted.
+<a
href="&hivemind-hivedoc;#configuration:hivemind.SymbolSource">hivemind.SymbolSource</a>.
+Contributions to this configuration point define new objects that can provide
values for symbols,
+and identify the order in which these objects should be consulted.
</p>
+<p>
+If at runtime none of the configured SymbolSources provides a value for a given
symbol then
+HiveMind will leave the reference to that symbol <em>as is</em>, including the
surrounding
+<code>${</code> and <code>}</code>. Additionally an error will be logged.
+</p>
</subsection>
@@ -271,6 +276,7 @@
<p>
<a
href="&apiroot;/impl/SystemPropertiesSymbolSource.html">SystemPropertiesSymbolSource</a>
is a one-line implementation that allows access to system properties as
substitution symbols.
+ Note that this configuration is <em>not</em> loaded by default.
</p>
<p>
1.13 +3 -3 jakarta-commons-sandbox/hivemind/xdocs/rules.xml
Index: rules.xml
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/hivemind/xdocs/rules.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- rules.xml 14 Oct 2003 15:33:18 -0000 1.12
+++ rules.xml 15 Oct 2003 15:48:44 -0000 1.13
@@ -341,8 +341,8 @@
<subsection name="configuration">
<p>
-The configuration translator converts an input value into an configuration point
id, then obtains
-the elements for that configuration point as the value. The id may be fully
qualified, or a local id within
+The configuration translator converts an input value into a configuration point id,
then obtains
+the elements for that configuration point as a List. The id may be fully
qualified, or a local id within
the contributing module.
</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
