You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by al...@apache.org on 2007/03/20 23:21:10 UTC
svn commit: r520626 - in /incubator/uima/uimaj/trunk/uima-docbooks/src:
docbook/references/ docbook/tools/ olink/overview_and_setup/
olink/tutorials_and_users_guides/
Author: alally
Date: Tue Mar 20 15:21:08 2007
New Revision: 520626
URL: http://svn.apache.org/viewvc?view=rev&rev=520626
Log:
Documentation updates for <import> in CPE descriptor.
UIMA-345: https://issues.apache.org/jira/browse/UIMA-345
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cpe.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db
incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml?view=diff&rev=520626&r1=520625&r2=520626
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml Tue Mar 20 15:21:08 2007
@@ -178,9 +178,13 @@
<section id="&tp;imports">
<title>Imports</title>
- <para>A CPE Descriptor uses the following notation to reference descriptors for other
- components that are incorporated into the defined CPE:
-
+ <para>As of version 2.2, a CPE Descriptor can use the same <literal>import</literal> mecanism
+ as other component descriptors. This allows referring to component
+ descriptors using either relative paths (resolved relative to the location of the CPE descriptor)
+ or the classpath/datapath. For details see <olink targetdoc="&uima_docs_ref;"
+ targetptr="ugr.ref.xml.component_descriptor"/>.</para>
+
+ <para>The follwing older syntax is still supported, but not recommended:
<programlisting><![CDATA[<descriptor>
<include href="[URL or File]"/>
@@ -190,8 +194,9 @@
incorporated component. The argument is first attempted to be resolved as a URL.</para>
<para>
- A fully qualified filename may be provided, or the filename
- may be relative to a directory specified using the <literal>CPM_HOME</literal>
+ Relative paths in an <literal>include</literal> are resolved relative to the current working directory
+ (NOT the CPE descriptor location as is the case for <literal>import</literal>).
+ A filename relative to another directory can be specified using the <literal>CPM_HOME</literal>
variable, e.g.,
<programlisting><descriptor>
<include href="${CPM_HOME}/desc_dir/descriptor.xml"/>
@@ -199,14 +204,10 @@
In this case, the value for the <literal>CPM_HOME</literal> variable must be
provided to the CPE by specifying it on the Java command line, e.g.,
-
-
+
<programlisting>java -DCPM_HOME="C:/Program Files/apache/uima/cpm" ...</programlisting>
- Note that this mechanism for referencing other component descriptor files is
- different from and in no way related to either of the two import mechanisms described in
- <olink targetdoc="&uima_docs_ref;"
- targetptr="ugr.ref.xml.component_descriptor"/>.</para>
+ </para>
</section>
@@ -277,14 +278,14 @@
<programlisting><![CDATA[<collectionReader>
<collectionIterator>
<descriptor>
- <include href="[File]"/>
+ <import ...> | <include .../>
</descriptor>
<configurationParameterSettings>...</configurationParameterSettings>
<sofaNameMappings>...</sofaNameMappings>
</collectionIterator>
<casInitializer>
<descriptor>
- <include href="[File]"/>
+ <import ...> | <include .../>
</descriptor>
<configurationParameterSettings>...</configurationParameterSettings>
<sofaNameMappings>...</sofaNameMappings>
@@ -402,7 +403,7 @@
<programlisting><![CDATA[<casProcessor deployment="local|remote|integrated" name="[String]" >
<descriptor>
- <include href=[File]/>
+ <import ...> | <include .../>
</descriptor>
<configurationParameterSettings>...</configurationParameterSettings>
<sofaNameMappings>...</sofaNameMappings>
@@ -1317,8 +1318,7 @@
<collectionReader>
<collectionIterator>
<descriptor>
- <include href="C:/Program Files/apache-uima/examples/descriptors/
- collection_reader/FileSystemCollectionReader.xml"/>
+ <import location="../collection_reader/FileSystemCollectionReader.xml"/>
</descriptor>
</collectionIterator>
</collectionReader>
@@ -1327,8 +1327,7 @@
<casProcessor deployment="integrated"
name="Aggregate TAE - Name Recognizer and Person Title Annotator">
<descriptor>
- <include href="C:/Program Files/apache-uima/examples/descriptors/
- analysis_engine/NamesAndPersonTitles_TAE.xml"/>
+ <import location="../analysis_engine/NamesAndPersonTitles_TAE.xml"/>
</descriptor>
<deploymentParameters/>
<filter/>
@@ -1341,8 +1340,7 @@
</casProcessor>
<casProcessor deployment="integrated" name="Annotation Printer">
<descriptor>
- <include href="C:/Program Files/apache-uima/examples/descriptors/
- cas_consumer/AnnotationPrinter.xml"/>
+ <import location="../cas_consumer/AnnotationPrinter.xml"/>
</descriptor>
<deploymentParameters/>
<filter/>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cpe.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cpe.xml?view=diff&rev=520626&r1=520625&r2=520626
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cpe.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cpe.xml Tue Mar 20 15:21:08 2007
@@ -146,11 +146,13 @@
<section id="ugr.tools.cpe.file_menu">
<title>The File Menu</title>
- <para>The CPE Configurator's File Menu has six options:</para>
+ <para>The CPE Configurator's File Menu has the following options:</para>
<itemizedlist><listitem><para>Open CPE Descriptor</para></listitem>
<listitem><para>Save CPE Descriptor</para></listitem>
+
+ <listitem><para>Save Options</para> (submenu)</listitem>
<listitem><para>Refresh Descriptors from File System</para></listitem>
@@ -177,6 +179,14 @@
Configurator. For more information on manually creating a CPE Descriptor, see <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
+ will use the <literal><import></literal> syntax to refer to their component
+ descriptors. If unchecked, the older <literal><include></literal> syntax will
+ be used for new components that you add to your CPE using the GUI. (However, if you
+ open a CPE descriptor that used <import>, these imports will not be replaced.)
+ </para>
<para><emphasis role="bold">Refresh Descriptors from File System</emphasis> will
reload all descriptors from disk. This is useful if you have made a change to the
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db?view=diff&rev=520626&r1=520625&r2=520626
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/htmlsingle-target.db Tue Mar 20 15:21:08 2007
@@ -401,7 +401,7 @@
<div element="section" href="#ugr.ovv.eclipse_setup.install_emf" number="3.1.2" targetptr="ugr.ovv.eclipse_setup.install_emf">
<ttl>Install additional Eclipse component: EMF</ttl>
<xreftext>Section 3.1.2, âInstall additional Eclipse component: EMFâ</xreftext>
- <div element="section" href="#d0e2016" number="3.1.2.1">
+ <div element="section" href="#ugr.ovv.eclipse_setup.install_emf_shortcut" number="3.1.2.1" targetptr="ugr.ovv.eclipse_setup.install_emf_shortcut">
<ttl>EMF Installation Shortcut for Eclipse 3.2</ttl>
<xreftext>Section 3.1.2.1, âEMF Installation Shortcut for Eclipse 3.2â</xreftext>
</div>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db?view=diff&rev=520626&r1=520625&r2=520626
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/overview_and_setup/pdf-target.db Tue Mar 20 15:21:08 2007
@@ -401,7 +401,7 @@
<div element="section" href="#ugr.ovv.eclipse_setup.install_emf" number="3.1.2" targetptr="ugr.ovv.eclipse_setup.install_emf">
<ttl>Install additional Eclipse component: EMF</ttl>
<xreftext>Section 3.1.2, âInstall additional Eclipse component: EMFâ</xreftext>
- <div element="section" href="#d0e2016" number="3.1.2.1">
+ <div element="section" href="#ugr.ovv.eclipse_setup.install_emf_shortcut" number="3.1.2.1" targetptr="ugr.ovv.eclipse_setup.install_emf_shortcut">
<ttl>EMF Installation Shortcut for Eclipse 3.2</ttl>
<xreftext>Section 3.1.2.1, âEMF Installation Shortcut for Eclipse 3.2â</xreftext>
</div>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db?view=diff&rev=520626&r1=520625&r2=520626
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/htmlsingle-target.db Tue Mar 20 15:21:08 2007
@@ -582,6 +582,10 @@
<ttl>Using Flow Controllers with CAS Multipliers</ttl>
<xreftext>Section 4.5, âUsing Flow Controllers with CAS Multipliersâ</xreftext>
</div>
+ <div element="section" href="#ugr.tug.fc.continuing_when_exceptions_occur" number="4.6" targetptr="ugr.tug.fc.continuing_when_exceptions_occur">
+ <ttl>Continuing the Flow When Exceptions Occur</ttl>
+ <xreftext>Section 4.6, âContinuing the Flow When Exceptions Occurâ</xreftext>
+ </div>
</div>
<div element="chapter" href="#ugr.tug.aas" number="5" targetptr="ugr.tug.aas">
<ttl>Annotations, Artifacts, and Sofas</ttl>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db?view=diff&rev=520626&r1=520625&r2=520626
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/olink/tutorials_and_users_guides/pdf-target.db Tue Mar 20 15:21:08 2007
@@ -582,6 +582,10 @@
<ttl>Using Flow Controllers with CAS Multipliers</ttl>
<xreftext>Section 4.5, âUsing Flow Controllers with CAS Multipliersâ</xreftext>
</div>
+ <div element="section" href="#ugr.tug.fc.continuing_when_exceptions_occur" number="4.6" targetptr="ugr.tug.fc.continuing_when_exceptions_occur">
+ <ttl>Continuing the Flow When Exceptions Occur</ttl>
+ <xreftext>Section 4.6, âContinuing the Flow When Exceptions Occurâ</xreftext>
+ </div>
</div>
<div element="chapter" href="#ugr.tug.aas" number="5" targetptr="ugr.tug.aas">
<ttl>Annotations, Artifacts, and Sofas</ttl>