You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by bu...@apache.org on 2013/06/21 01:03:56 UTC
svn commit: r1495228 [3/3] - in /uima/uimaj/trunk:
uima-docbook-references/src/docbook/ uima-docbook-tools/src/docbook/
uima-docbook-tools/src/docbook/images/tools/tools.cde/
uima-docbook-tutorials-and-users-guides/src/docbook/
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image020.jpg
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image020.jpg?rev=1495228&r1=1495227&r2=1495228&view=diff
==============================================================================
Binary files - no diff available.
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image022.jpg
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image022.jpg?rev=1495228&r1=1495227&r2=1495228&view=diff
==============================================================================
Binary files - no diff available.
Added: uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image025.jpg
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image025.jpg?rev=1495228&view=auto
==============================================================================
Binary file - no diff available.
Propchange: uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.cde/image025.jpg
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cde.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cde.xml?rev=1495228&r1=1495227&r2=1495228&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cde.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cde.xml Thu Jun 20 23:03:55 2013
@@ -483,10 +483,13 @@ under the License.
<para>The first checkbox at the top simplifies things if you are not using Parameter
Groups (see the following section for a discussion of groups). In this case, leave the
check box unchecked. The main area shows a list of parameter definitions. Each
- parameter has a name, which must be unique for this Analysis Engine. The other three
+ parameter has a name, which must be unique for this Analysis Engine. The first three
attributes specify whether the parameter can have a single or multiple values (an array
of values), whether it is Optional or Mandatory, and what the value type it can hold
- (String, Integer, Float, and Boolean).</para>
+ (String, Integer, Float, and Boolean). If an external override name has been specified
+ an attribute of "XO" is included. See <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xml.component_descriptor.aes.external_configuration_parameter_overrides"/>
+ for a discussion of external configuration parameter overrides.</para>
<para>In addition to using the buttons on the right to edit this information, you can
double-click a parameter to edit it, or remove (delete) a selected parameter by
@@ -494,7 +497,8 @@ under the License.
<para>Parameters have an additional description field, which you can specify when you
add or edit a parameter. To see the value of the description, hover the mouse over the
- item, as shown in the picture below:
+ item, as shown in the picture below. If the parameter has an external override name its value
+ is included in the hover.
<screenshot>
@@ -559,6 +563,24 @@ under the License.
</section>
+ <section id="ugr.tools.cde.parm_definition.adding">
+ <title>Adding or Editing a Parameter</title>
+
+ <para>When creating or modifying a parameter both a unique name and a valid type must be
+ specified. The Description and External Name fields are optional. The defaults for the two
+ checkboxs indicate a single-valued optional parameter in the example below:
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="4.7in" format="JPG" fileref="&imgroot;image025.jpg"/>
+ </imageobject>
+ <textobject><phrase>Aggregate parameters</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot></para>
+
+ </section>
+
<section id="ugr.tools.cde.parm_definition.aggregates">
<title>Parameter declarations for Aggregates</title>
@@ -1420,4 +1442,4 @@ under the License.
press the Enter key to confirm. The last successful context file is remembered and will
be suggested as the context file to use at the next edit session</para>
</section>
-</chapter>
\ No newline at end of file
+</chapter>
Modified: uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml?rev=1495228&r1=1495227&r2=1495228&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml Thu Jun 20 23:03:55 2013
@@ -895,6 +895,25 @@ public void initialize(UimaContext aCont
of <literal>UimaContext.getConfigParameterValue</literal>, which takes
both the group name and the parameter name as its arguments.</para>
</section>
+
+ <section id="ugr.tug.aae.configuration_parameter_overrides">
+ <title>Overriding Configuration Parameter Settings</title>
+
+ <para>There are two ways that the value assigned to a configuration parameter can be
+ overridden. An aggregate may declare a parameter that overrides one or more of the
+ parameters in one or more of its delegates. The aggregate must also define a value for the
+ parameter, unless the parameter is itself overridden by a setting in the parent
+ aggregate.</para>
+
+ <para>An alternative method that avoids these strict hierarchical override constraints is to
+ associate an external global name with a parameter and to assign values to these external
+ names in an external properties file.</para>
+
+ <para>For details see
+ <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xml.component_descriptor.aes.aggregate.configuration_parameter_overrides"/>
+ </para>
+ </section>
</section>
<section id="ugr.tug.aae.logging">
Modified: uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tutorials_and_users_guides.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tutorials_and_users_guides.xml?rev=1495228&r1=1495227&r2=1495228&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tutorials_and_users_guides.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tutorials_and_users_guides.xml Thu Jun 20 23:03:55 2013
@@ -33,6 +33,5 @@ under the License.
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tug.multi_views.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tug.cas_multiplier.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tug.xmi_emf.xml"/>
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tug.configuration.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="tug.type_mapping.xml"/>
</book>