You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2006/12/09 20:46:05 UTC
svn commit: r485052 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook: references/
tutorials_and_users_guides/
Author: schor
Date: Sat Dec 9 11:46:02 2006
New Revision: 485052
URL: http://svn.apache.org/viewvc?view=rev&rev=485052
Log:
UIMA-5 replace <quote>...</quote> with "..." when used
inside <programlisting> element
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.jcas.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xmi.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.cpe_descriptor.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.jcas.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.jcas.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.jcas.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.jcas.xml Sat Dec 9 11:46:02 2006
@@ -430,12 +430,11 @@
<programlisting>FSIndexRepository ir = jcas.getFSIndexRepository();
-FSIndex myIndex = ir.getIndex(<quote>myIndexName</quote>);
-FSIterator myIterator = myIndex.iterator();</programlisting>
-
-
- <programlisting>JFSIndexRepository ir = jcas.getJFSIndexRepository();
-FSIndex myIndex = ir.getIndex(<quote>myIndexName</quote>, Foo.type); // filtered
+FSIndex myIndex = ir.getIndex("myIndexName");
+FSIterator myIterator = myIndex.iterator();
+
+JFSIndexRepository ir = jcas.getJFSIndexRepository();
+FSIndex myIndex = ir.getIndex("myIndexName", Foo.type); // filtered
FSIterator myIterator = myIndex.iterator();</programlisting>
<para>Iterators work like normal Java iterators, but are augmented to support
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.pear.xml Sat Dec 9 11:46:02 2006
@@ -489,7 +489,7 @@
<programlisting><![CDATA[<DEPLOYMENT>network</DEPLOYMENT>
<NETWORK_PARAMETERS>
- <VNS_SPECS VNS_HOST=<quote>vns_host_IP</quote> VNS_PORT=<quote>vns_port_No</quote> />
+ <VNS_SPECS VNS_HOST="vns_host_IP" VNS_PORT="vns_port_No" />
</NETWORK_PARAMETERS>]]></programlisting></para>
</section>
</section>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xmi.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xmi.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xmi.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xmi.xml Sat Dec 9 11:46:02 2006
@@ -274,10 +274,10 @@
and 6 would be serialized as the four objects:
- <programlisting><cas:NonEmptyIntegerList xmi:id=<quote>10</quote> head=<quote>2</quote> tail=<quote>11</quote>/>
-<cas:NonEmptyIntegerList xmi:id=<quote>11</quote> head=<quote>4</quote> tail=<quote>12</quote>/>
-<cas:NonEmptyIntegerList xmi:id=<quote>12</quote> head=<quote>6</quote> tail=<quote>13</quote>/>
-<cas:EmptyIntegerList xmi:id<quote>13</quote>/></programlisting></para>
+ <programlisting><cas:NonEmptyIntegerList xmi:id="10" head="2" tail="11"/>
+<cas:NonEmptyIntegerList xmi:id="11" head="4" tail="12"/>
+<cas:NonEmptyIntegerList xmi:id="12" head="6" tail="13"/>
+<cas:EmptyIntegerList xmi:id"13"/></programlisting></para>
<para>This representation of arrays allows multiple references to an array of list. It
also allows a feature with range type TOP to refer to an array or list. However, it is a
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/references/ref.xml.component_descriptor.xml Sat Dec 9 11:46:02 2006
@@ -108,8 +108,8 @@
from other XML files. When one of the following appears in an XML descriptor:
- <programlisting><import location=<quote>[URL]</quote> /> or
-<import name=<quote>[Name]</quote> /></programlisting>
+ <programlisting><import location="[URL]" /> or
+<import name="[Name]" /></programlisting>
it indicates that information from a separate XML file is being imported. Note that
imports are allowed only in certain places in the descriptor. In the remainder of this
chapter, it will be indicated at which points imports are allowed.</para>
@@ -176,7 +176,7 @@
<para>To use XInclude, you first must include the XInclude
namespace in your document's root element, e.g.:</para>
- <programlisting><analysisEngineDescription xmlns=<quote>http://uima.apache.org/resourceSpecifier</quote> xmlns:xi=<quote>http://www.w3.org/2001/XInclude</quote>></programlisting>
+ <programlisting><analysisEngineDescription xmlns="http://uima.apache.org/resourceSpecifier" xmlns:xi="http://www.w3.org/2001/XInclude"></programlisting>
<para>Then, you can include a file using the syntax <literal><xi:include
href="[URL]"/></literal></para>
@@ -2004,7 +2004,7 @@
<programlisting><![CDATA[<capabilities>
<capability>
<outputs>
- <type allAnnotatorFeatures=<quote>true|false</quote>>[String]</type>
+ <type allAnnotatorFeatures="true|false">[String]</type>
<type>[TypeName]</type>
...
<feature>[TypeName]:[Name]</feature>
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=485052&r1=485051&r2=485052
==============================================================================
--- 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 Sat Dec 9 11:46:02 2006
@@ -193,7 +193,7 @@
<programlisting><descriptor>
- <include href=<quote>${CPM_HOME}/desc_dir/descriptor.xml</quote>/>
+ <include href="${CPM_HOME}/desc_dir/descriptor.xml"/>
</descriptor></programlisting>
<para>In this case, the value for the <literal>CPM_HOME</literal> variable must be
@@ -555,8 +555,8 @@
<programlisting><sofaNameMappings>
- <sofaNameMapping cpeSofaName=<quote>a_CPE_name</quote>
- componentSofaName=<quote>a_component_Name</quote>/>
+ <sofaNameMapping cpeSofaName="a_CPE_name"
+ componentSofaName="a_component_Name"/>
...
</sofaNameMappings></programlisting></para>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/annotator_analysis_engine_guide.xml Sat Dec 9 11:46:02 2006
@@ -2262,7 +2262,7 @@
<programlisting><![CDATA[<typeSystemDescription>
<imports>
- <import location=<quote>TutorialTypeSystem.xml</quote>/>
+ <import location="TutorialTypeSystem.xml"/>
</imports>
</typeSystemDescription>
]]>
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.application.xml Sat Dec 9 11:46:02 2006
@@ -508,7 +508,7 @@
<section id="ugr.tug.application.running_a_cpe_from_a_descriptor">
<title>Running a Collection Processing Engine from a Descriptor</title>
- <titleabbrev>Running a CPE from a Descriptor</titleabbrev>>
+ <titleabbrev>Running a CPE from a Descriptor</titleabbrev>
<para><olink targetdoc="&uima_docs_tutorial_guides;"
targetptr="ugr.tug.cpe.running_cpe_from_application"/> describes how to
@@ -519,7 +519,7 @@
<section
id="ugr.tug.application.configuring_a_cpe_descriptor_programmatically">
<title>Configuring a Collection Processing Engine Descriptor Programmatically</title>
- <titleabbrev>Configuring a CPE Descriptor Programmatically</titleabbrev>>
+ <titleabbrev>Configuring a CPE Descriptor Programmatically</titleabbrev>
<para>For the finest level of control over the CPE descriptor settings, the CPE offers
programmatic access to the descriptor via an API. With this API, a developer can
@@ -1127,26 +1127,26 @@
looks like this (important parts are in bold italics):
- <programlisting><deployment name=<quote><emphasis role="bold"><emphasis role="italic">PersonTitleAnnotator</emphasis></emphasis></quote>
- xmlns=<quote>http://xml.apache.org/axis/wsdd/</quote>
- xmlns:java=<quote>http://xml.apache.org/axis/wsdd/providers/java</quote>>
-
- <service name=<quote><emphasis role="bold"><emphasis role="italic">urn:PersonTitleAnnotator</emphasis></emphasis></quote> provider=<quote>java:RPC</quote>>
-
- <parameter name=<quote>scope</quote> value=<quote>Request</quote>/>
-
- <parameter name=<quote>className</quote>
- value=<quote>org.apache.uima.reference_impl.analysis_engine
- .service.soap.AxisAnalysisEngineService_impl</quote>/>
-
- <parameter name=<quote>allowedMethods</quote> value=<quote>getMetaData process</quote>/>
- <parameter name=<quote>allowedRoles</quote> value=<quote>*</quote>/>
- <parameter name=<quote>resourceSpecifierPath</quote>
- value=<quote><emphasis role="bold"><emphasis role="italic">C:/Program Files/apache/uima/examples/
- descriptors/analysis_engine/PersonTitleAnnotator.xml</emphasis></emphasis></quote>/>
+ <programlisting><deployment name="<emphasis role="bold"><emphasis role="italic">PersonTitleAnnotator</emphasis></emphasis>"
+ xmlns="http://xml.apache.org/axis/wsdd/"
+ xmlns:java="http://xml.apache.org/axis/wsdd/providers/java">
+
+ <service name="<emphasis role="bold"><emphasis role="italic">urn:PersonTitleAnnotator</emphasis></emphasis>" provider="java:RPC">
+
+ <parameter name="scope" value="Request"/>
+
+ <parameter name="className"
+ value="org.apache.uima.reference_impl.analysis_engine
+ .service.soap.AxisAnalysisEngineService_impl"/>
+
+ <parameter name="allowedMethods" value="getMetaData process"/>
+ <parameter name="allowedRoles" value="*"/>
+ <parameter name="resourceSpecifierPath"
+ value="<emphasis role="bold"><emphasis role="italic">C:/Program Files/apache/uima/examples/
+ descriptors/analysis_engine/PersonTitleAnnotator.xml</emphasis></emphasis>"/>
- <parameter name=<quote>numInstances</quote> value=<quote>3</quote>/>
- <parameter name=<quote>timeoutPeriod</quote> value=<quote>30000</quote>/>
+ <parameter name="numInstances" value="3"/>
+ <parameter name="timeoutPeriod" value="30000"/>
<!-- Type Mappings omitted from this document;
you will not need to edit them. -->
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.cpe.xml Sat Dec 9 11:46:02 2006
@@ -1293,19 +1293,19 @@
configuration for the non-managed CAS Processor.</para>
- <programlisting><casProcessor <emphasis role="bold"><emphasis role="italic">deployment=<quote>remote</quote></emphasis></emphasis> name=<quote>Meeting Detector TAE</quote>>
+ <programlisting><casProcessor <emphasis role="bold"><emphasis role="italic">deployment="remote"</emphasis></emphasis> name="Meeting Detector TAE">
<descriptor>
<include href=
- <quote>descriptors/vinciService/MeetingDetectorVinciService.xml</quote>/>
+ "descriptors/vinciService/MeetingDetectorVinciService.xml"/>
</descriptor>
<deploymentParameters/>
<filter/>
<errorHandling>
- <errorRateThreshold action=<quote>terminate</quote> value=<quote>1/100</quote>/>
- <maxConsecutiveRestarts action=<quote>terminate</quote> value=<quote>3</quote>/>
- <timeout max=<quote>100000</quote>/>
+ <errorRateThreshold action="terminate" value="1/100"/>
+ <maxConsecutiveRestarts action="terminate" value="3"/>
+ <timeout max="100000"/>
</errorHandling>
- <checkpoint batch=<quote>10000</quote>/>
+ <checkpoint batch="10000"/>
</casProcessor></programlisting>
<para>See <olink targetdoc="&uima_docs_ref;" targetptr="ugr.ref.xml.cpe_descriptor"/> for
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml?view=diff&rev=485052&r1=485051&r2=485052
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.multi_views.xml Sat Dec 9 11:46:02 2006
@@ -214,11 +214,11 @@
<para>Consider annotator code to create a new CAS view:</para>
- <programlisting>CAS viewX = cas.createView(<quote>X</quote>);</programlisting>
+ <programlisting>CAS viewX = cas.createView("X");</programlisting>
<para>Or code to get an existing CAS view:</para>
- <programlisting>CAS viewX = cas.getView(<quote>X</quote>);</programlisting>
+ <programlisting>CAS viewX = cas.getView("X");</programlisting>
<para>Without Sofa name mapping the SofaID for the new Sofa will be <quote>X</quote>.
However, if a name mapping for <quote>X</quote> has been specified by the aggregate or