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 22:50:10 UTC
svn commit: r1495596 [1/2] - in /uima/uimaj/trunk:
uima-docbook-overview-and-setup/src/docbook/
uima-docbook-references/src/docbook/ uima-docbook-tools/src/docbook/
uima-docbook-tutorials-and-users-guides/src/docbook/
Author: burn
Date: Fri Jun 21 20:50:09 2013
New Revision: 1495596
URL: http://svn.apache.org/r1495596
Log:
UIMA-2378 Added book title (as a 2nd link) to each link to a different book
Modified:
uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/conceptual_overview.xml
uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/eclipse_setup.xml
uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.javadocs.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.pear.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xmi.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml
uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.cpe_descriptor.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cde.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cpe.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cvd.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.jcasgen.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.installer.xml
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.packager.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/annotator_analysis_engine_guide.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.cpe.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.fc.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.multi_views.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.type_mapping.xml
uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.xmi_emf.xml
Modified: uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/conceptual_overview.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/conceptual_overview.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/conceptual_overview.xml (original)
+++ uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/conceptual_overview.xml Fri Jun 21 20:50:09 2013
@@ -196,7 +196,8 @@ under the License.
video. The majority of examples we provide are for text. We use the term <emphasis
role="bold">document, </emphasis>therefore, to generally refer to any unit of
content that an AE may process, whether it is a text document or a segment of audio, for
- example. See the section <olink targetdoc="&uima_docs_tutorial_guides;"
+ example. See the <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.mvs"/> for more information on multimodal processing
in UIMA.</para>
@@ -248,8 +249,8 @@ under the License.
<para>In UIMA the person who codes analysis algorithms takes on the role of the
<emphasis role="bold">Annotator Developer</emphasis>. <olink
- targetdoc="&uima_docs_tutorial_guides;"
- targetptr="ugr.tug.aae"/> will take the reader
+ targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/>
+ in <olink targetdoc="&uima_docs_tutorial_guides;"/> will take the reader
through the details involved in creating UIMA annotators and analysis
engines.</para>
@@ -280,6 +281,7 @@ under the License.
<para>The UIMA framework includes an implementation and interfaces to the CAS. For a
more detailed description of the CAS and its interfaces see <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/>.</para>
<para>A CAS that logically contains statement 2 (repeated here for your
@@ -403,6 +405,7 @@ under the License.
document. Each translation may be represented with a different CAS View. Each
translation may be described by a different set of analysis results. For more
details on CAS Views and Sofas see <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.mvs"/> and <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aas"/>. </para>
@@ -420,7 +423,7 @@ under the License.
interfaces. Through these interfaces, the annotator developer interacts with the
document and reads and writes analysis results. The CAS interfaces provide a suite of
access methods that allow the developer to obtain indexed iterators to the different
- objects in the CAS. See <olink targetdoc="&uima_docs_ref;"
+ objects in the CAS. See <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.cas"/>. While many objects may exist in a CAS, the annotator
developer can obtain a specialized iterator to all Person objects associated with a
particular view, for example.</para>
@@ -431,6 +434,7 @@ under the License.
Person class in Java. As the analysis algorithm detects mentions of persons in the
documents, it can create Person objects in the CAS. For more details on how to interact
with the CAS using this interface, refer to <olink targetdoc="&uima_docs_ref;"
+ /> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas"/>.</para>
<para>The component developer, in addition to interacting with the CAS, can access
@@ -440,6 +444,7 @@ under the License.
flow may share the same instance of an external file or remote resource accessed
via its URL, for example. For details on using
the UIMA Context see <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aae"/>.</para>
</section>
@@ -475,9 +480,11 @@ under the License.
reuse, composition and development tooling. The UIMA SDK provides tools for easily
creating and maintaining the component descriptors that relieve the developer from
editing XML directly. This tool is described briefly in <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aae"/>, and more
- thoroughly in <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cde"/>
+ thoroughly in <olink targetdoc="&uima_docs_tools;"/>
+ <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cde"/>
.</para>
<para>Component descriptors contain standard metadata including the
@@ -496,6 +503,7 @@ under the License.
composition based on desired results. UIMA analysis engines provide an interface
for accessing the component metadata represented in their descriptors. For more
details on the structure of UIMA component descriptors refer to <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor"/>.</para>
</section>
@@ -568,7 +576,8 @@ under the License.
The Flow Contoller has access to the CAS and any external resources it may require
for determining the flow. It can do this dynamically at run-time, it can
make multi-step decisions and it can consider any sort of flow specification
- included in the aggregate AE's descriptor. See
+ included in the aggregate AE's descriptor. See
+ <olink targetdoc="&uima_docs_tutorial_guides;"/>
<olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.fc"/>
for details on the UIMA Flow Controller interface.
</para>
@@ -591,18 +600,22 @@ under the License.
adapter layer that automatically creates the necessary infrastructure in response to
a declaration in the component's descriptor. For more details on creating
aggregate analysis engines refer to <olink targetdoc="&uima_docs_ref;"
+ /> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor"/> The component descriptor editor tool
assists in the specification of aggregate AEs from a repository of available engines.
For more details on this tool refer to <olink targetdoc="&uima_docs_tools;"
+ /> <olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.cde"/>.</para>
<para>The UIMA framework implementation has two built-in flow implementations: one
that support a linear flow between components, and one with conditional branching
based on the language of the document. It also supports user-provided flow
controllers, as described in <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.fc"/>. Furthermore, the application developer is
free to create multiple AEs and provide their own logic to combine the AEs in arbitrarily
complex flows. For more details on this the reader may refer to <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.using_aes"/>.</para>
@@ -660,6 +673,7 @@ under the License.
<para>The UIMA framework provides methods to support the application developer in
creating and managing CASes and instantiating, running and managing AEs. Details
may be found in <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application"/>.</para>
</section>
@@ -734,6 +748,7 @@ under the License.
site</ulink> which will allow the developer to experiment with indexing analysis
results and querying for documents based on all the annotations in the CAS. See the
section on integrating text analysis and search in <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application"/>.</para>
@@ -747,6 +762,7 @@ under the License.
analysis engines and CAS Consumers) and indicate a flow among them. The flow
specification allows for filtering capabilities to, for example, skip over AEs
based on CAS contents. Details about the format of CPE Descriptors may be found in
+ <olink targetdoc="&uima_docs_ref;"/>
<olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>.
</para>
@@ -783,6 +799,7 @@ under the License.
<para>This deployment option requires that the CPM run in a separate process or a
machine distinct from the CPE components. A CPE may be configured to run with a variety
of deployment options that control the features provided by the CPM. For details see
+ <olink targetdoc="&uima_docs_ref;"/>
<olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>
.</para>
@@ -790,10 +807,12 @@ under the License.
the developer with a user interface that simplifies the process of connecting up all
the components in a CPE and running the result. For details on using the CPE
Configurator see <olink targetdoc="&uima_docs_tools;"
+ /> <olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.cpe"/>. This tool currently does not provide
access to the full set of CPE deployment options supported by the CPM; however, you can
configure other parts of the CPE descriptor by editing it directly. For details on how
to create and run CPEs refer to <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe"/>.</para>
</section>
@@ -869,6 +888,7 @@ under the License.
<para>For more details about using UIMA and Semantic Search see the section on
integrating text analysis and search in <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application"/>.</para>
</section>
@@ -943,6 +963,7 @@ under the License.
single-view mode components, it is up to the person assembling the component to supply
the needed information to insure a particular view is passed to the component at run
time. This is done using XML descriptors for Sofa mapping (see <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.mvs.sofa_name_mapping"/>).</para>
Modified: uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/eclipse_setup.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/eclipse_setup.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/eclipse_setup.xml (original)
+++ uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/eclipse_setup.xml Fri Jun 21 20:50:09 2013
@@ -35,7 +35,8 @@ under the License.
form that's easy to import into your Eclipse environment.</para>
<para>If you are not planning on using the UIMA SDK with Eclipse, you may skip this chapter and
- read <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/>
+ read <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/>
next.</para>
<para>This chapter provides instructions for
@@ -360,7 +361,8 @@ under the License.
<para>Eclipse also has a Javadoc "view" which you can show, using the Window →
Show View → Javadoc.</para>
- <para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs.libraries"/>
+ <para>See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs.libraries"/>
for information on how to set up a UIMA "library" with the Javadocs attached, which
can be reused for other projects in your Eclipse workspace.</para>
@@ -413,7 +415,8 @@ under the License.
the tools by clicking the <quote>X</quote> in the upper right corner on the GUI.
</para></listitem></itemizedlist>
- <para>For instructions on using the Document Analyzer and CPE Configurator, see <olink
+ <para>For instructions on using the Document Analyzer and CPE Configurator,
+ in the <olink targetdoc="&uima_docs_tools;"/> book see <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.doc_analyzer"/>, and
<olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/> For
instructions on using the CAS Visual Debugger and JCasGen, see <olink
Modified: uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml (original)
+++ uima/uimaj/trunk/uima-docbook-overview-and-setup/src/docbook/project_overview.xml Fri Jun 21 20:50:09 2013
@@ -408,6 +408,7 @@ under the License.
</listitem>
<listitem>
<para> Develop sample UIMA annotators, run them and explore the results. Read <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/> and follow it like a tutorial
to learn how to develop your first UIMA annotator and set up and run your first UIMA analysis engines.
<itemizedlist>
@@ -416,10 +417,12 @@ under the License.
<itemizedlist>
<listitem>
<para> The UIMA Component Descriptor Editor, described in more detail in <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cde"/> and </para>
</listitem>
<listitem>
<para> The Document Analyzer, described in more detail in <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.doc_analyzer"/>. </para>
</listitem>
@@ -427,16 +430,18 @@ under the License.
</listitem>
<listitem>
- <para>While following along in <olink targetdoc="&uima_docs_tutorial_guides;"
+ <para>While following along in <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aae"/>, reference documents that may help are:
<itemizedlist>
<listitem>
- <para> <olink targetdoc="&uima_docs_ref;"
+ <para> <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor"/> for understanding the analysis
engine descriptors </para>
</listitem>
<listitem>
- <para> <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas"/> for
+ <para> <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas"/> for
understanding the JCas </para>
</listitem>
</itemizedlist> </para>
@@ -447,13 +452,16 @@ under the License.
<para> Learn how to create, run and manage a UIMA analysis engine as part of an application.
Connect your analysis engine to the provided semantic search engine to learn how a
complete analysis and search application may be built with Apache UIMA. <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.application"/> will guide you
through this process.
<itemizedlist>
<listitem>
<para> As part of this you will use the document analyzer (described in more detail in <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.doc_analyzer"/> and semantic search
- GUI tools (see <olink targetdoc="&uima_docs_tutorial_guides;"
+ GUI tools (see <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.search.query_tool"/>. </para>
</listitem>
</itemizedlist> </para>
@@ -467,22 +475,27 @@ under the License.
</listitem>
<listitem>
<para> Develop and run a Collection Processing Engine (CPE) to analyze and gather the results of an entire
- collection of documents. <olink targetdoc="&uima_docs_tutorial_guides;"
+ collection of documents. <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe"/> will guide you through this process.
<itemizedlist>
<listitem>
<para> As part of this you will use the CPE Configurator tool. For details see <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>. </para>
</listitem>
<listitem>
<para> You will also learn about CPE Descriptors. The detailed format for these may be found in <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>. </para>
</listitem>
</itemizedlist> </para>
</listitem>
<listitem>
<para> Learn how to package up an analysis engine for easy installation into another UIMA environment.
+ <olink targetdoc="&uima_docs_tools;"/>
<olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.pear.packager"/> and <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.pear.installer"/> will teach you how to
create UIMA analysis engine archives so that you can easily share your components with a broader
community. </para>
@@ -610,6 +623,7 @@ under the License.
multiple new CASes, in addition to returning the original CAS that is passed in.
This allows components to have Collection Reader-like capabilities, but be
placed anywhere in the flow. See <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.cm"/>
.</para>
</formalpara>
@@ -618,6 +632,7 @@ under the License.
<para>A new component, the Flow Controller, can be supplied by the user to implement
arbitrary flow control for CASes within an Aggregate. This is in addition to the two
built-in flow control choices of linear and language-capability flow. See <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.fc"/>
.</para>
</formalpara>
@@ -790,7 +805,8 @@ under the License.
<literal>uima-document-annotation.jar</literal> file that is included in Apache UIMA. If you
<emphasis>have</emphasis> made custom changes, then you should not delete the file but instead move it to
the correct package <literal>org.apache.uima.jcas.tcas</literal>. For more information about JCas
- and DocumentAnnotation please see <olink targetdoc="&uima_docs_ref;"
+ and DocumentAnnotation please see <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas.documentannotation_issues"/> </para>
</section>
<section id="ugr.project_overview_running_the_migration_utility.manual_migration_needed.getdocumentannotation">
@@ -799,7 +815,8 @@ under the License.
must be replaced with <literal>JCas.getDocumentAnnotationFs</literal>. The method
<literal>JCas.getDocumentAnnotationFs()</literal> returns type <literal>TOP</literal>, so your
code must cast this to type <literal>DocumentAnnotation</literal>. The reasons for this are described
- in <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas.documentannotation_issues"/>.
+ in <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas.documentannotation_issues"/>.
</para>
</section>
@@ -818,6 +835,7 @@ under the License.
<para>The use of <xi:include> in UIMA component descriptors has been discouraged for some time, and in
Apache UIMA support for it has been removed. If you have descriptors that use that, you must change them to
use UIMA's <import> syntax instead. The proper syntax is described in <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor.imports"/>.
</para>
</section>
@@ -912,6 +930,7 @@ under the License.
<title>Multi-Modal Support</title>
<para>The UIMA architecture supports the development, discovery, composition and deployment of
multi-modal analytics, including text, audio and video. <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aas"/> discuss this is more
detail.</para>
</section>
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.cas.xml Fri Jun 21 20:50:09 2013
@@ -68,6 +68,7 @@ under the License.
<para>There are three<footnote><para>A fourth part, the Subject of Analysis,
is discussed in <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aas"/>.</para></footnote> main parts to the CAS: the type system, data creation and
manipulation, and indexing. We will start with a brief
description of these components.</para>
@@ -165,6 +166,7 @@ under the License.
<para>Indexes are named and are associated with a CAS Type; they are used to index
instances of that CAS type (including instances of that type's subtypes). If
you are using multiple views (see <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.mvs"/>),
each view contains a separate instantiation of all of the indexes.
To access an index, you
@@ -305,6 +307,7 @@ under the License.
to.</para>
<para>Annotations are always with respect to some Sofa (Subject of Analysis – see
+ <olink targetdoc="&uima_docs_tutorial_guides;"/>
<olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aas"/>
.</para>
<note><para>Artifacts which are not text strings may have a different interpretation of
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.javadocs.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.javadocs.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.javadocs.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.javadocs.xml Fri Jun 21 20:50:09 2013
@@ -32,6 +32,7 @@ under the License.
<para>Eclipse supports the ability to attach the Javadocs to your project. The Javadoc should already be attached
to the <literal>uimaj-examples</literal> project, if you followed the setup instructions in <olink
+ targetdoc="&uima_docs_overview;"/> <olink
targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.eclipse_setup.example_code"/>. To attach
Javadocs to your own Eclipse project, use the following instructions.</para>
@@ -39,6 +40,7 @@ under the License.
do this you not only will have the Javadocs automatically available (you can skip the following
setup), you will have the ability to step through the UIMA framework code while debugging.
To add the source, follow the instructions as described in the setup chapter:
+ <olink targetdoc="&uima_docs_overview;"/>
<olink targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.eclipse_setup.adding_source"/>.</para></note>
<para>To add the Javadocs, open a project which is referring to the UIMA APIs in its class path, and open the project properties. Then pick
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.jcas.xml Fri Jun 21 20:50:09 2013
@@ -178,6 +178,7 @@ uima.cas.String → String</programl
Structure reference), a new JCas cover object instance may be created. If you need these values, you can (a)
make them CAS values if possible, or (b) hold a reference to the the particular JCas cover object instance in
your Java code. For some simple cases, setting the the performance tuning option JCAS_CACHE_ENABLE (see
+ <olink targetdoc="&uima_docs_tutorial_guides;"/>
<olink targetdoc="&uima_docs_tutorial_guides;" targetptr="tug.application.pto"/>)
to true
will cause the same JCas cover object that was previously used for a particular CAS Feature Structure to be
@@ -316,6 +317,7 @@ uima.cas.String → String</programl
can be re-run on the merged type system, to create one set of JCas Class definitions for the merged types,
which can then be shared by all the components.
Directions for running JCasGen can be found in <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.jcasgen"/>. This is typically done by the person who
is assembling the Aggregate Analysis Engine or Collection Processing Engine. The resulting merged Java
Class Model will then contain get and set methods for the complete set of features. These Java classes must
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.pear.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.pear.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.pear.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.pear.xml Fri Jun 21 20:50:09 2013
@@ -43,6 +43,7 @@
Currently, there is an Eclipse plugin and a command line tool
available to create PEAR packages for standard UIMA components.
Please refer to
+ <olink targetdoc="&uima_docs_tools;"/>
<olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.pear.packager" />
for more information about these tools.
@@ -51,6 +52,7 @@
<para>
PEARs distributed to new targets can be installed at those targets.
UIMA includes a tool for installing PEARs; see
+ <olink targetdoc="&uima_docs_tools;"/>
<olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.pear.installer"/> for
more information about installing PEARs.
@@ -341,12 +343,14 @@
deployment, but must contain the network AE
descriptor (see
<olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aae.creating_xml_descriptor" />
) and the <DESC> tag in the installation
descriptor must point to the network AE descriptor.
For more information about Network Analysis Engines,
please refer to
<olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.remote_services" />
.
</para>
@@ -786,6 +790,7 @@ local_root_directory_for_1st_delegate_co
including the root folder itself</emphasis>) to a PEAR file with the extension <quote>.pear</quote>.</para>
<para>To do this you can either use the PEAR packaging tools that are described in <quote><olink targetdoc="&uima_docs_tools;"
+ /> <olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.pear.packager"/></quote> or you can use the PEAR packaging API that is shown below.</para>
<para>
@@ -824,6 +829,7 @@ local_root_directory_for_1st_delegate_co
<para>The installation of a PEAR package can be done using
the PEAR installer tool (see <olink targetdoc="&uima_docs_tools;"
+ /> <olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.pear.installer"/>, or by an application using
the PEAR APIs, directly. </para>
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xmi.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xmi.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xmi.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xmi.xml Fri Jun 21 20:50:09 2013
@@ -68,6 +68,7 @@ under the License.
the http scheme is a common convention, and does not imply any HTTP communication. The
.ecore suffix is due to the fact that the recommended type system definition for a
namespace is an ECore model, see <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.xmi_emf"/>.</para>
<para>Consider the CAS type name <quote>org.myproj.Foo</quote>. The CAS namespace
@@ -327,6 +328,7 @@ myFeature = "bar"</programlisting>
<titleabbrev>Linking XMI docs to Ecore Type System</titleabbrev>
<para>If the CAS Type System has been saved to an Ecore file (as described in <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.xmi_emf"/>), it is possible to store a
link from an XMI document to that Ecore type system. This is done using an xsi:schemaLocation attribute
on the root XMI element.</para>
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.component_descriptor.xml Fri Jun 21 20:50:09 2013
@@ -403,6 +403,7 @@ uima.tcas.Annotation.</programlisting>
Engine is a container for a single <emphasis>annotator</emphasis>, where as an
<emphasis>Aggregate</emphasis> Analysis Engine is composed of a collection of other
Analysis Engines. (For more information on this and other terminology, see <olink
+ targetdoc="&uima_docs_overview;"/> <olink
targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.conceptual"/>).</para>
<para>Both Primitive and Aggregate Analysis Engines have descriptors, and the two types
@@ -928,6 +929,7 @@ uima.tcas.Annotation.</programlisting>
<para><literal>outputsNewCASes</literal>, if true, allows the component to
create new CASes during processing, for example to break a large artifact into
smaller pieces. See <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cm"/> for details.</para>
</section>
@@ -2251,6 +2253,7 @@ key\= : key ends with \ and value start
actual Analysis Engine or CAS Consumer Descriptor. The UIMA SDK will handle the details
of calling the remote service. (For details on <emphasis>deploying</emphasis> an
Analysis Engine or CAS Consumer as a service, see <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.remote_services"/>.</para>
<para>The UIMA SDK is extensible to support different types of remote services. In future
@@ -2316,6 +2319,7 @@ key\= : key ends with \ and value start
<para>For details on how to deploy and call Analysis Engine and CAS Consumer services, see
<olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.remote_services"/>.</para>
</section>
Modified: uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.cpe_descriptor.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.cpe_descriptor.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.cpe_descriptor.xml (original)
+++ uima/uimaj/trunk/uima-docbook-references/src/docbook/ref.xml.cpe_descriptor.xml Fri Jun 21 20:50:09 2013
@@ -42,6 +42,7 @@ under the License.
<para>Details about the CPE, including its function, sub-components, APIs, and related
tools, can be found in <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe"/>. Here we briefly summarize the CPE to define terms and
provide context for the later sections that describe the CPE Descriptor.</para>
@@ -375,6 +376,7 @@ under the License.
happens with the CAS when an exception happens during processing. If the value of this
attribute is set to true and an exception happens, the CPM will notify all registered
listeners of the exception (see <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe.using_listeners"/>), clear the CAS and check the CAS
back into the CAS Pool so that it can be re-used. The presumption is that an exception
may leave the CAS in an inconsistent state and therefore that CAS should not be allowed
@@ -445,6 +447,7 @@ under the License.
in the <literal><descriptor></literal> element must be a Vinci
<emphasis>Service Client Descriptor</emphasis>, which identifies a
remotely deployed CAS Processor service (see <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.remote_services"/>). The CPM
assumes that the CAS Processor is already running as a remote service and
@@ -462,6 +465,7 @@ under the License.
<literal><descriptor></literal> element must be a Vinci
<emphasis>Service Deployment Descriptor</emphasis>, which configures
a CAS Processor for deployment as a Vinci service (see <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.remote_services"/>). The CPM
deploys the CAS Processor in a separate process and manages the life cycle
@@ -501,6 +505,7 @@ under the License.
(primitive or aggregate). </para></listitem></itemizedlist> </para>
<para>See <olink targetdoc="&uima_docs_tutorial_guides;"
+ /> <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.remote_services"/> for more
information on creating these descriptors and deploying services.</para>
@@ -1151,6 +1156,7 @@ vinci.VinciAnalysisEngineService_impl</a
metadata to a local cache of invalid documents. </para>
<para>If the time out occurs, the CPM notifies all registered listeners (see <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe.using_listeners"/>) by calling
entityProcessComplete(). As part of this call, the SequencedQueue will pass null
@@ -1250,6 +1256,7 @@ vinci.VinciAnalysisEngineService_impl</a
<programlisting><resourceManagerConfiguration href="..."/></programlisting></para>
<para>For an introduction to external resources, refer to <olink
+ targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aae.accessing_external_resource_files"/>.</para>
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=1495596&r1=1495595&r2=1495596&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 Fri Jun 21 20:50:09 2013
@@ -3,6 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"[
<!ENTITY imgroot "images/tools/tools.cde/" >
<!ENTITY % uimaents SYSTEM "../../target/docbook-shared/entities.ent" >
+<!ENTITY uima_docs_overview_title "UIMA Overview & SDK Setup" >
%uimaents;
]>
<!--
@@ -47,9 +48,10 @@ under the License.
<listitem><para>Right-click on this file and select Open With → Component
Descriptor Editor. (If this option is not present, check to make sure you installed
- the plug-ins as described <olink targetdoc="&uima_docs_overview;"
- targetptr="ugr.ovv.eclipse_setup.installation"/>. The EMF plugin is also
- required.).</para></listitem>
+ the plug-ins as described in <olink targetdoc="&uima_docs_overview;"
+ targetptr="ugr.ovv.eclipse_setup.installation"/> of the <olink targetdoc="&uima_docs_overview;"/> book.
+ The EMF plugin is also
+ required.)</para></listitem>
<listitem><para>This should open a graphical editor and display the contents of the
RoomNumberAnnotator descriptor. </para></listitem></itemizedlist>
@@ -204,7 +206,8 @@ under the License.
defaults to unchecked for new CAS Consumer descriptors).</para>
<para>Analysis engines are written using the CAS Multiplier APIs
- (see <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.cm"/>)
+ (see <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.cm"/>)
can create additional CASes for analysis. To specify that they
do this, check the <quote>returns new artifacts</quote>.</para>
@@ -333,10 +336,10 @@ under the License.
information needed to create a remote service descriptor for a remote AE - one that
runs on a different computer connected over the network. There are 3 kinds of
these: two are variants of the Service Client
- descriptor, described in <olink targetdoc="&uima_docs_ref;"
+ descriptor, described in <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.service_client"/>;
the other is the UIMA-AS JMS Service descriptor, described in
- <olink targetdoc="&uima_docs_as;"
+ <olink targetdoc="&uima_docs_as;"/> <olink targetdoc="&uima_docs_as;"
targetptr="ugr.async.ov.concepts.jms_descriptor"/>. The Add
Remote button creates an instance of one of these descriptors,
saves it as a file in the workspace, and
@@ -424,9 +427,10 @@ under the License.
<title>Component Engine Flow</title>
<para>The UIMA SDK currently supports three kinds of sequencing flows: Fixed,
- CapabilityLanguageFlow (see <olink targetdoc="&uima_docs_ref;"
- targetptr="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints.capability_language_flow"/>
- ), and user-defined. The first two require specification of a linear flow sequence;
+ CapabilityLanguageFlow, and user-defined
+ (see <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xml.component_descriptor.aes.aggregate.flow_constraints"/>).
+ The first two require specification of a linear flow sequence;
this linear flow sequence can also be read by a user-defined flow controller (what use
is made of it is up to the user-defined flow controller). The Component Engine Flow
section allows specification of these items.</para>
@@ -487,7 +491,8 @@ under the License.
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). If an external override name has been specified
- an attribute of "XO" is included. See <olink targetdoc="&uima_docs_ref;"
+ an attribute of "XO" is included. See <olink targetdoc="&uima_docs_ref;"/>
+ <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>
@@ -544,8 +549,8 @@ under the License.
<para>The Search strategy specifies what to do when a parameter is not available for the
group requested. It can have the values of None, language_fallback, or
- default_fallback. These are more fully described in the section <olink
- targetdoc="&uima_docs_ref;"
+ default_fallback. These are more fully described in the section
+ <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.aes.configuration_parameter_declaration"/>
.</para>
@@ -567,7 +572,7 @@ under the License.
<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
+ specified. The Description and External Override fields are optional. The defaults for the two
checkboxs indicate a single-valued optional parameter in the example below:
<screenshot>
<mediaobject>
@@ -725,7 +730,8 @@ under the License.
on the Source tab and look in the list box under the text that reads: <quote>Source folder
on build path.</quote> If no source folders are defined, you will get a warning that you
have no source folders defined and JCasGen will not be run. (For information on JCasGen
- see <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.jcasgen"/>).
+ see <olink targetdoc="&uima_docs_tools;"/>
+ <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.jcasgen"/>).
When JCasGen is run, you can monitor the progress of the generation by observing the
status on the Eclipse status line (normally at the bottom of the Eclipse window).
JCasGen runs on the fully-merged type system, consisting of the type specification
@@ -739,8 +745,8 @@ under the License.
type definition that contains all of the features defined on that type by all of your
components). However, it is not recommended to use this feature
(of having different definitions for the same type name) since it can make it
- difficult to combine/package your annotator with others. See <olink
- targetdoc="&uima_docs_ref;"
+ difficult to combine/package your annotator with others. See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas.merging_types_from_other_specs"/> for more information.
</para></warning>
@@ -1268,7 +1274,7 @@ under the License.
<para>The Name must be unique within this Analysis Engine. The URL identifies a file
resource. If both the URL and URL suffix are used, the file resource is formed by
combining the first URL part with the language-identifier, followed by the URL suffix;
- see <olink targetdoc="&uima_docs_ref;"
+ see <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.aes.primitive.resource_manager_configuration"/>
. URLs may be written as <quote>relative</quote> URLs; in this case they are resolved by
looking them up relative to the classpath and/or datapath. A relative URL has the path
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cpe.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cpe.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cpe.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cpe.xml Fri Jun 21 20:50:09 2013
@@ -39,8 +39,8 @@ under the License.
CPEs.</para>
<para>For an introduction to Collection Processing Engine concepts, including
- developing the components that make up a CPE, read <olink
- targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.cpe"/>. This
+ developing the components that make up a CPE, read <olink targetdoc="&uima_docs_tutorial_guides;"/>
+ <olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.cpe"/>. This
chapter is a user's guide for using the CPE Configurator tool, and does not describe
UIMA's Collection Processing Architecture itself.</para>
@@ -57,8 +57,8 @@ under the License.
mapped. It sets up a fixed-sized CAS Pool.</para>
<para>To set these additional options, you must edit the CPE Descriptor XML file
- directly. See <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for the syntax.
+ directly. See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for the syntax.
You may then open the CPE Descriptor in the CPE Configurator and run it. The changes
you applied to the CPE Descriptor <emphasis>will</emphasis> be respected, although you
will not be able to see them or edit them from the GUI.
@@ -70,8 +70,8 @@ under the License.
<para>The CPE Configurator tool can be run using the <literal>cpeGui</literal> shell
script, which is located in the <literal>bin</literal> directory of the UIMA SDK. If
- you've installed the example Eclipse project (see <olink
- targetdoc="&uima_docs_overview;"
+ you've installed the example Eclipse project (see <olink targetdoc="&uima_docs_overview;"/>
+ <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup.example_code"/>, you can also run it using the
<quote>UIMA CPE GUI</quote> run configuration provided in that project.</para>
<note><para>If you are planning to build a CPE using components other than the examples
@@ -169,16 +169,18 @@ examples/descriptors/cas_consumer/XmiWri
identify the components that constitute the CPE, as well as the configuration settings
you have specified for each of these components. Later, you can use <quote>Open CPE
Descriptor</quote> to restore the CPE Configurator to the state. Also, CPE
- Descriptors can be used to easily run a CPE from a Java program – see <olink
+ Descriptors can be used to easily run a CPE from a Java program – see
+ <olink targetdoc="&uima_docs_tutorial_guides;"/> <olink
targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.application.running_a_cpe_from_a_descriptor"/>
.</para>
<para>CPE Descriptors also allow specifying operational parameters, such as error
handling options that are not currently available for configuration through the CPE
- Configurator. For more information on manually creating a CPE Descriptor, see <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>
- .</para>
+ Configurator. For more information on manually creating a CPE Descriptor, see
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>.
+ </para>
<para>The <emphasis role="bold">Save Options</emphasis> submenu has one item,
"Use <import>". If this item is checked (the default), saved CPE descriptors
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cvd.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cvd.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cvd.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.cvd.xml Fri Jun 21 20:50:09 2013
@@ -72,7 +72,7 @@
</para>
<para>
In Eclipse, you have a ready to use launch configuration available when you have installed the
- UIMA sample project (see <olink targetdoc="&uima_docs_overview;"
+ UIMA sample project (see <olink targetdoc="&uima_docs_overview;"/> <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup.example_code"/>). Below is a screenshot of the the Eclipse Run
dialog with the CVD
run configuration selected.
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.doc_analyzer.xml Fri Jun 21 20:50:09 2013
@@ -34,7 +34,7 @@ Document Analyzer is designed to work wi
Analysis Engines that process other types of data.</para>
<para>For an introduction to developing annotators and Analysis
-Engines, read
+Engines, read <olink targetdoc="&uima_docs_tutorial_guides;"/>
<olink targetdoc="&uima_docs_tutorial_guides;" targetptr="ugr.tug.aae"/>.
This chapter is a user's guide for using the Document Analyzer tool, and
does not describe the process of developing annotators and Analysis Engines.</para>
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.jcasgen.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.jcasgen.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.jcasgen.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.jcasgen.xml Fri Jun 21 20:50:09 2013
@@ -43,15 +43,15 @@ under the License.
type definition containing all of the features defined on that type by all of the
components). It is recommended that you do not use this capability (of having
two different definitions for the same type name, with different feature sets) since it can make it
- difficult to combine/package your annotator with others. See <olink
- targetdoc="&uima_docs_ref;"
+ difficult to combine/package your annotator with others. See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas.merging_types_from_other_specs"/> for more information.
</para>
<para>Also note that if your type system declares a custom version of the
<literal>uima.tcas.DocumentAnnotation</literal>
built-in type, then JCasGen will generate a Java source file for it. If you do this, you need to be
- aware of the issues discussed in
+ aware of the issues discussed in <olink targetdoc="&uima_docs_ref;"/>
<olink
targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas.documentannotation_issues"/>.</para></warning>
@@ -60,7 +60,7 @@ under the License.
which contains a type system descriptor, and generates the corresponding Java Class
Models for those types. Variants exist for the Eclipse environment that allow merging the
newly generated Java source code with previously augmented versions; see <olink
- targetdoc="&uima_docs_ref;"
+ targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas.augmenting_generated_code"/> for a discussion of how the
Java Class Models can be augmented by adding additional methods and fields.</para>
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.installer.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.installer.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.installer.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.installer.xml Fri Jun 21 20:50:09 2013
@@ -89,8 +89,8 @@ under the License.
<para>PEAR Installer creates a file named <literal>setenv.txt</literal> in the
<literal><component_root>/metadata</literal> directory. This file contains
environment variables required to run your component in any UIMA application.
- It also creates a PEAR descriptor (see also <olink targetdoc="&uima_docs_ref;"
- targetptr="ugr.ref.pear.specifier"/>)
+ It also creates a PEAR descriptor (see also <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.pear.specifier"/>)
file named <literal><componentID>_pear.xml</literal>
in the <literal><component_root></literal> directory that can be used to directly run
the installed pear file in your application.
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.packager.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.packager.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.packager.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.pear.packager.xml Fri Jun 21 20:50:09 2013
@@ -30,7 +30,8 @@ under the License.
Information Management Architecture) components. The PEAR package can be used for
distribution and reuse by other components or applications. It also allows applications
and tools to manage UIMA components automatically for verification, deployment,
- invocation, testing, etc. Please refer to <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.pear"/>
+ invocation, testing, etc. Please refer to <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.pear"/>
for more information about the internal structure of a PEAR file.</para>
<para>This chapter describes how to use the PEAR Eclipse plugin or the PEAR command line packager
@@ -40,6 +41,7 @@ under the License.
<title>Using the PEAR Eclipse Plugin</title>
<para>The PEAR Eclipse plugin is automatically installed if you followed the directions in
+ <olink targetdoc="&uima_docs_overview;"/>
<olink targetdoc="&uima_docs_overview;" targetptr="ugr.ovv.eclipse_setup"/>. The use of the
plugin involves the following two steps:</para>
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=1495596&r1=1495595&r2=1495596&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 Fri Jun 21 20:50:09 2013
@@ -72,7 +72,8 @@ under the License.
structure from the previous paragraph would be an instance of a Java class Person with
getFullName() and setFullName() methods. Though the examples in this guide all use the
JCas, it is also possible to directly access the underlying CAS system; for more
- information see <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/>
+ information see <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/>
.</para>
<para>The remainder of this chapter will refer to the analysis of text documents and the
@@ -142,11 +143,11 @@ under the License.
<para>This section is a step-by-step tutorial that will get you started developing UIMA
annotators. All of the files referred to by the examples in this chapter are in the
<literal>examples</literal> directory of the UIMA SDK. This directory is designed to
- be imported into your Eclipse workspace; see <olink
- targetdoc="&uima_docs_overview;"
+ be imported into your Eclipse workspace; see <olink targetdoc="&uima_docs_overview;"/>
+ <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup.example_code"/> for instructions on how to do
this.
- See <olink targetdoc="&uima_docs_overview;"
+ See <olink targetdoc="&uima_docs_overview;"/> <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup.linking_uima_javadocs"/> for how to attach the UIMA
Javadocs to the jar files.
Also you may wish to refer to the UIMA SDK Javadocs located in the <ulink
@@ -157,6 +158,7 @@ under the License.
class or method in a browser, by pressing Shift + F2.</para></note>
<note><para>If you downloaded the source distribution for UIMA, you can attach that as
well to the library Jar files; for information on how to do this, see
+ <olink targetdoc="&uima_docs_ref;"/>
<olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs"/>.</para></note>
<para>The example annotator that we are going to walk through will detect room numbers for
@@ -205,7 +207,7 @@ under the License.
<para>UIMA includes an Eclipse plug-in that will help you edit Type System
Descriptors, so if you are using Eclipse you will not need to worry about the details of
- the XML syntax. See <olink targetdoc="&uima_docs_overview;"
+ the XML syntax. See <olink targetdoc="&uima_docs_overview;"/> <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup"/> for instructions on setting up Eclipse and
installing the plugin.</para>
@@ -213,7 +215,8 @@ under the License.
<literal>descriptors/tutorial/ex1/TutorialTypeSystem.xml.</literal> (This
and all other examples are located in the <literal>examples</literal> directory of
the installation of the UIMA SDK, which can be imported into an Eclipse project for
- your convenience, as described in <olink targetdoc="&uima_docs_overview;"
+ your convenience, as described in <olink targetdoc="&uima_docs_overview;"/>
+ <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup.example_code"/>.)</para>
<para>In Eclipse, expand the <literal>uimaj-examples</literal> project in the
@@ -344,7 +347,7 @@ under the License.
generated under the specified output directory.</para>
<para>There are some additional options to choose from when running JCasGen; please
- refer to the <olink targetdoc="&uima_docs_tools;"
+ refer to the <olink targetdoc="&uima_docs_tools;"/> <olink targetdoc="&uima_docs_tools;"
targetptr="ugr.tools.jcasgen"/> for details.</para>
</section>
@@ -500,7 +503,8 @@ annotation.setBuilding("Yorktown");</pro
<note>
<para>You can also call <literal>addToIndexes()</literal> on Feature Structures that are not subtypes of
<literal>uima.tcas.Annotation</literal>, but these will not be sorted in any particular way. If you want
- to specify a sort order, you can define your own custom indexes in the CAS: see <olink
+ to specify a sort order, you can define your own custom indexes in the CAS: see
+ <olink targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/> and <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.aes.index"/> for details.</para></note>
@@ -889,7 +893,8 @@ public void initialize(UimaContext aCont
settings for the different languages.</para>
<para>The syntax for defining parameter groups in your descriptor is fairly
- straightforward – see <olink targetdoc="&uima_docs_ref;"
+ straightforward – see <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor"/> for details. Values of
parameters defined within groups are accessed through the two-argument version
of <literal>UimaContext.getConfigParameterValue</literal>, which takes
@@ -910,6 +915,7 @@ public void initialize(UimaContext aCont
names in an external properties file.</para>
<para>For details see
+ <olink targetdoc="&uima_docs_ref;"/>
<olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.aes.aggregate.configuration_parameter_overrides"/>
</para>
@@ -1226,6 +1232,7 @@ public void initialize(UimaContext aCont
type definition that contains all of the features defined on that type by all of your
components. However, it is not recommended to use this feature in conjunction with JCAS,
since the JCAS Java Class definitions cannot be so easily merged. See
+ <olink targetdoc="&uima_docs_ref;"/>
<olink
targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.jcas.merging_types_from_other_specs"/> for more information.
@@ -1325,7 +1332,8 @@ while (timeIter.hasNext()) {
<para>All types which are subtypes of the built-in Annotation type have a sorted index, and so all instances of those
types are guaranteed to be found (at least once) by this iterator.</para>
- <para>Also, if you've defined your own custom index as described in <olink targetdoc="&uima_docs_ref;"
+ <para>Also, if you've defined your own custom index as described in <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.aes.index"/>, you can get an iterator over that
specific index by calling <literal>aJCas.getJFSIndexRepository().getIndex(label)</literal>.
The <literal>getIndex(...)</literal> method has also a 2 argument form; the second argument,
@@ -2213,8 +2221,9 @@ catch (PatternSyntaxException e) {
<para>For more details on issues around setting up this class path, including
deployment issues where class loaders are being used to isolate multiple UIMA
- applications inside a single running Java Virtual Machine, please see <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas.class_loaders"/>
+ applications inside a single running Java Virtual Machine, please see
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas.class_loaders"/>
.</para>
</section>
@@ -2271,7 +2280,8 @@ documentAnalyzer</programlisting>
<row>
<entry>UIMA_DATAPATH</entry>
<entry>(Optional) if specified, a path specification to use as the default
- DataPath (see <olink targetdoc="&uima_docs_ref;"
+ DataPath (see <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.datapath"/>)</entry>
</row>
<row>
@@ -2400,8 +2410,9 @@ documentAnalyzer</programlisting>
example introduced in section <xref linkend="ugr.tug.aae.getting_started"/>. The
discussion is divided into several logical sections of the descriptor.</para>
- <para>The full specification for Analysis Engine Descriptors is defined in <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor"/>
+ <para>The full specification for Analysis Engine Descriptors is defined in
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor"/>
.</para>
<section id="ugr.tug.aae.header_annotator_class_identification">
Modified: uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.application.xml Fri Jun 21 20:50:09 2013
@@ -147,9 +147,11 @@ AnalysisEngine ae =
<title>Analyzing Text Documents</title>
<para>There are two ways to use the AE interface to analyze documents. You can either use the
- <emphasis>JCas</emphasis> interface, which is described in detail by <olink
+ <emphasis>JCas</emphasis> interface, which is described in detail in <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas"/> or you can directly use the
<emphasis>CAS</emphasis> interface, which is described in detail in <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/>. Besides text documents, other kinds of
artifacts can also be analyzed; see <olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.aas"/> for more information.</para>
@@ -252,7 +254,8 @@ ae.destroy();</programlisting></para>
</listitem>
<listitem>
- <para> <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas"/></para>
+ <para> <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.jcas"/></para>
</listitem>
<listitem>
@@ -269,7 +272,8 @@ ae.destroy();</programlisting></para>
<itemizedlist>
<listitem>
- <para> <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/></para>
+ <para> <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/></para>
</listitem>
<listitem>
@@ -789,6 +793,7 @@ consumerParamSettings.setParameterValue(
<para>The index build specification is a series of index build items, each of which identifies a CAS
annotation type (a subtype of <literal>uima.tcas.Annotation</literal> – see <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.cas"/>) and a style.</para>
<para>The first item in this example specifies that the annotation type
@@ -842,7 +847,8 @@ consumerParamSettings.setParameterValue(
url="http://www.alphaworks.ibm.com/tech/uima"/>. For more information on the Index Build
Specification format, see the UIMA Javadocs for class
<literal>org.apache.uima.search.IndexBuildSpecification</literal>. Accessing the Javadocs is
- described <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs"/>.</para>
+ described in <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.javadocs"/>.</para>
</section>
@@ -858,6 +864,7 @@ consumerParamSettings.setParameterValue(
<para>Run the CPE Configurator tool by executing the <literal>cpeGui</literal> shell script in the
<literal>bin</literal> directory of the UIMA SDK. (For instructions on using this tool, see the <olink
+ targetdoc="&uima_docs_tools;"/> <olink
targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>.)</para>
<para>In the CPE Configurator tool, select the following components by browsing to their
@@ -1542,7 +1549,9 @@ Exception: Connection refused: connect</
See <xref linkend="ugr.tug.applications.multi_threaded"/>.</para></listitem>
<listitem><para><emphasis role="bold">Reassembling chunks of a large document</emphasis>
- See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor.descriptor.operational_parameters"/></para>
+ See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xml.cpe_descriptor.descriptor.operational_parameters"/></para>
</listitem>
</itemizedlist></para>
@@ -1586,7 +1595,8 @@ Exception: Connection refused: connect</
<para>If the service does not respond within this amount of time, processing of the current CAS will abort. If
you called the <literal>AnalysisEngine.process</literal> method directly from your application, an
Exception will be thrown. If you are running a CPE, what happens next is dependent on the error handling
- settings in your CPE descriptor (see <olink targetdoc="&uima_docs_ref;"
+ settings in your CPE descriptor (see <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual.error_handling"/>
). The default action is for the CPE to terminate, but you can override this. </para>
@@ -1609,6 +1619,7 @@ Exception: Connection refused: connect</
<literal>errorRateThreshold</literal>. These settings support such things as restarting the process
(for <quote>managed</quote> deployment mode), dropping and reestablishing the connection (for
<quote>non-managed</quote> deployment mode), and removing the offending service from the pipeline. See
+ <olink targetdoc="&uima_docs_ref;"/>
<olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual.error_handling"/>
) for details. </para>
@@ -1617,7 +1628,7 @@ Exception: Connection refused: connect</
request that is made when the client first connects to the service. This call is typically
very fast and does not need a large timeout (the default is 60 seconds). However, if many
clients are competing for a small number of services, it may be necessary to increase this
- value. See <olink targetdoc="&uima_docs_ref;"
+ value. See <olink targetdoc="&uima_docs_ref;"/> <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.service_client"/></para>
</section>
@@ -1675,6 +1686,7 @@ Exception: Connection refused: connect</
replicated processing pipelines, to a value greater than 1, and insure that the size of the CAS pool is equal to or
greater than this number (the attribute of <literal><casProcessors></literal> to set is
<literal>casPoolSize</literal>). For more details on these settings, see <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.cpe_descriptor.descriptor.cas_processors"/> .</para>
@@ -1706,6 +1718,7 @@ Exception: Connection refused: connect</
single Java Virtual Machine – which can take advantage of multi-processor and hyper-threaded
architectures).</para> <note>
<para>When using Vinci in <quote>exclusive</quote> mode (see service access under <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.cpe_descriptor.descriptor.cas_processors.individual.deployment_parameters"/>
), only one thread is used. To achieve multi-processing on a server in this case, use multiple instances of the
Modified: uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.cpe.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.cpe.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.cpe.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.cpe.xml Fri Jun 21 20:50:09 2013
@@ -78,11 +78,13 @@ under the License.
<para>A user creates a CPE by assembling the components mentioned above. The UIMA SDK
provides a graphical tool, called the CPE Configurator, for assisting in the assembly of
CPEs. Use of this tool is summarized in <xref
- linkend="ugr.tug.cpe.cpe_configurator"/>, and more details can be found in <olink
- targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>.
+ linkend="ugr.tug.cpe.cpe_configurator"/>, and more details can be found in
+ <olink targetdoc="&uima_docs_tools;"/>
+ <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>.
Alternatively, a CPE can be assembled by writing an XML CPE descriptor. Details on the CPE
- descriptor, including its syntax and content, can be found in the <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>. The individual
+ descriptor, including its syntax and content, can be found in the
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>. The individual
components have associated XML descriptors, each of which can be created and / or edited
using the <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cde">
Component Description Editor</olink>.</para>
@@ -153,11 +155,13 @@ under the License.
<title>Using the CPE Configurator</title>
<para>A CPE can be assembled by writing an XML CPE descriptor. Details on the CPE
- descriptor, including its syntax and content, can be found in <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>. Rather than
+ descriptor, including its syntax and content, can be found in
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>. Rather than
edit raw XML, you may develop a CPE Descriptor using the CPE Configurator tool. The CPE
- Configurator tool is described briefly in this section, and in more detail in <olink
- targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>.</para>
+ Configurator tool is described briefly in this section, and in more detail in
+ <olink targetdoc="&uima_docs_tools;"/>
+ <olink targetdoc="&uima_docs_tools;" targetptr="ugr.tools.cpe"/>.</para>
<para>The CPE Configurator tool can be run from Eclipse (see <xref
linkend="ugr.tug.cpe.running_cpe_configurator_from_eclipse"/>, or using
@@ -235,8 +239,9 @@ CAS Consumer:
linkend="ugr.tug.cpe.running_cpe_from_application"/>. CPE Descriptors
allow specifying operational parameters, such as error handling options, that are
not currently available for configuration through the CPE Configurator. For more
- information on manually creating a CPE Descriptor, see the <olink
- targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>.</para>
+ information on manually creating a CPE Descriptor, see the
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>.</para>
<para>The CPE configured above runs a simple name and title annotator on the sample data
provided with the UIMA SDK and stores the results using the XMI Writer CAS Consumer. To
@@ -305,8 +310,8 @@ CAS Consumer:
<section id="ugr.tug.cpe.running_cpe_configurator_from_eclipse">
<title>Running the CPE Configurator from Eclipse</title>
- <para>If you have followed the instructions in <olink
- targetdoc="&uima_docs_overview;"
+ <para>If you have followed the instructions in <olink targetdoc="&uima_docs_overview;"/>
+ <olink targetdoc="&uima_docs_overview;"
targetptr="ugr.ovv.eclipse_setup"/> and imported the example Eclipse
project, then you should already have a Run configuration for the CPE Configurator
tool (called <literal>UIMA CPE GUI</literal>) configured to run in the example
@@ -550,8 +555,9 @@ mCPE.process();</programlisting></para>
<para>The File System Collection Reader also stores additional metadata about
the document in the CAS. In particular, it sets the document's language in
the special built-in feature structure
- <literal>uima.tcas.DocumentAnnotation </literal>(see <olink
- targetdoc="&uima_docs_ref;"
+ <literal>uima.tcas.DocumentAnnotation </literal>(see
+ <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.cas.document_annotation"/> for details about this
built-in type) and creates an instance of
<literal>org.apache.uima.examples.SourceDocumentInformation</literal>
@@ -999,7 +1005,8 @@ mCPE.process();</programlisting></para>
<para>Eventually the CPE Configurator tool will support configuring these options and a
detailed tutorial for these settings will be provided. In the meantime, we provide only
a high-level, conceptual overview of these advanced features in the rest of this
- chapter, and refer the advanced user to <olink targetdoc="&uima_docs_ref;"
+ chapter, and refer the advanced user to <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.cpe_descriptor"/> for details on setting these options in the CPE
Descriptor.</para>
@@ -1061,7 +1068,8 @@ mCPE.process();</programlisting></para>
CAS Processors in integrated mode. To deploy CAS Processors in any other mode, the CPE
descriptor must be edited by hand (better tooling may be provided later). Details on the
CPE descriptor and the required settings for various CAS Processor deployment modes
- can be found in <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>
+ can be found in <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/>
. In the following sections we merely summarize the various CAS Processor deployment
options.</para>
@@ -1132,7 +1140,8 @@ mCPE.process();</programlisting></para>
<checkpoint batch="10000"/>
</casProcessor></programlisting>
- <para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
+ <para>See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
details and required settings.</para>
</section>
@@ -1194,7 +1203,8 @@ mCPE.process();</programlisting></para>
<checkpoint batch="10000"/>
</casProcessor></programlisting>
- <para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
+ <para>See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
details and required settings.</para>
</section>
@@ -1242,7 +1252,8 @@ mCPE.process();</programlisting></para>
<checkpoint batch="10000"/>
</casProcessor></programlisting>
- <para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
+ <para>See <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
details and required settings.</para>
</section>
Modified: uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.fc.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.fc.xml?rev=1495596&r1=1495595&r2=1495596&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.fc.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tutorials-and-users-guides/src/docbook/tug.fc.xml Fri Jun 21 20:50:09 2013
@@ -269,7 +269,8 @@ under the License.
<para>Flow Controller Descriptors are very similar to Primitive Analysis Engine Descriptors – for
example you can specify configuration parameters and external resources if you wish.</para>
- <para>If you wish to edit a Flow Controller Descriptor by hand, see section <olink targetdoc="&uima_docs_ref;"
+ <para>If you wish to edit a Flow Controller Descriptor by hand, see <olink targetdoc="&uima_docs_ref;"/>
+ <olink targetdoc="&uima_docs_ref;"
targetptr="ugr.ref.xml.component_descriptor.flow_controller"/> for the syntax.</para>
</section>
@@ -308,6 +309,7 @@ under the License.
</flowController></emphasis></programlisting></para>
<para>As usual, you can use either in import by location or import by name – see <olink
+ targetdoc="&uima_docs_ref;"/> <olink
targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.component_descriptor.imports"/>.</para>
<para>The key that you assign to the FlowController can be used elsewhere in the Aggregate Analysis Engine