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/01/25 22:48:31 UTC
svn commit: r500007 - in
/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook: overview_and_setup/
tools/ tutorials_and_users_guides/
Author: alally
Date: Thu Jan 25 13:48:30 2007
New Revision: 500007
URL: http://svn.apache.org/viewvc?view=rev&rev=500007
Log:
Fixed name of example eclipse project, should be "uimaj-examples
Modified:
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml
incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.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.xmi_emf.xml
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml?view=diff&rev=500007&r1=500006&r2=500007
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/overview_and_setup/eclipse_setup.xml Thu Jan 25 13:48:30 2007
@@ -210,7 +210,7 @@
%UIMA_HOME%/docs/examples directory</para></listitem>
<listitem><para>Click <quote>Finish.</quote> This will create a new project called
- <quote>uima_examples</quote> in your Eclipse workspace. There should be no
+ <quote>uimaj-examples</quote> in your Eclipse workspace. There should be no
compilation errors. </para></listitem></itemizedlist>
<para>To verify that you have set up the project correctly, check that there are no error
@@ -224,7 +224,7 @@
<para>You can run many tools without using Eclipse at all, by using the shell scripts in the
UIMA SDK's bin directory. In addition, many tools can be run from inside Eclipse;
examples are the Document Analyzer, CPE Configurator, CAS Visual Debugger, Semantic
- Search, and JCasGen. The uima_examples project provides Eclipse launch
+ Search, and JCasGen. The uimaj-examples project provides Eclipse launch
configurations that make this easy to do.</para>
<para>To run these tools from Eclipse:</para>
@@ -239,7 +239,7 @@
<quote>UIMA CAS Visual Debugger</quote>, <quote>UIMA JCasGen</quote>,
<quote>UIMA Document Analyzer</quote>, or <quote>UIMA Semantic Search</quote>
from the list of run configurations on the left. (If you don't see, these, please
- select the uima_examples project and do a Menu → File
+ select the uimaj-examples project and do a Menu → File
→ Refresh).</para></listitem>
<listitem><para>Press the <quote>Run</quote> button. The tools should start. Close
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml?view=diff&rev=500007&r1=500006&r2=500007
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tools/tools.cde.xml Thu Jan 25 13:48:30 2007
@@ -38,7 +38,7 @@
presumes you have installed the examples as described in the SDK Installation and Setup
chapter.</para>
- <itemizedlist spacing="compact"><listitem><para>Expand the uimaj_examples
+ <itemizedlist spacing="compact"><listitem><para>Expand the uimaj-examples
project in the Eclipse Navigator or Package Explorer view</para></listitem>
<listitem><para>Within this project, browse to the file
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=500007&r1=500006&r2=500007
==============================================================================
--- 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 Thu Jan 25 13:48:30 2007
@@ -206,7 +206,7 @@
your convenience, as described in <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
+ <para>In Eclipse, expand the <literal>uimaj-examples</literal> project in the
Package Explorer view, and browse to the file
<literal>descriptors/tutorial/ex1/TutorialTypeSystem.xml</literal>.
Right-click on the file in the navigator and select Open With → Component
@@ -382,12 +382,12 @@
<para>The class definition for our RoomNumberAnnotator implements the process method, and is shown here. You
can find the source for this in the
- <literal>uimaj_examples/src/org/apache/uima/tutorial/ex1/RoomNumberAnnotator.java</literal> .
+ <literal>uimaj-examples/src/org/apache/uima/tutorial/ex1/RoomNumberAnnotator.java</literal> .
<note>
<para>In Eclipse, in the <quote>Package Explorer</quote> view, this will appear by default in the project
- <literal>uimaj_examples</literal>, in the folder <literal>src</literal>, in the package
+ <literal>uimaj-examples</literal>, in the folder <literal>src</literal>, in the package
<literal>org.apache.uima.tutorial.ex1</literal>.</para></note> In Eclipse, open the
- RoomNumberAnnotator.java in the uimaj_examples project, under the src directory.</para>
+ RoomNumberAnnotator.java in the uimaj-examples project, under the src directory.</para>
<programlisting>package org.apache.uima.tutorial.ex1;
@@ -925,8 +925,8 @@
the output will be directed to a file named uima.log, in the current working directory
(often the <quote>project</quote> directory when running from Eclipse, for
instance).</para> <note><para>When using Eclipse, the uima.log file, if written
- into the Eclipse workspace in the project uimaj_examples, for example, may not appear
- in the Eclipse package explorer view until you right-click the uimaj_examples project
+ into the Eclipse workspace in the project uimaj-examples, for example, may not appear
+ in the Eclipse package explorer view until you right-click the uimaj-examples project
with the mouse, and select <quote>Refresh</quote>. This operation refreshes the
Eclipse display to conform to what may have changed on the file system. Also, you can set
the Eclipse preferences for the workspace to automatically refresh (Window →
@@ -1086,7 +1086,7 @@
XML descriptor; no Java code is required!</para>
<para>If you go to the <literal>examples/descriptors/tutorial/ex3</literal>
- folder (in Eclipse, it's in your uimaj_examples project, under the
+ folder (in Eclipse, it's in your uimaj-examples project, under the
<literal>descriptors/tutorial/ex3</literal> folder), you will find a
descriptor for a TutorialDateTime annotator. This annotator detects dates and
times (and also sentences and words). To see what this annotator can do, try it out
@@ -1113,7 +1113,7 @@
<para>The descriptor that does this is named
<literal>RoomNumberAndDateTime.xml</literal>, which you can open in the
- Component Descriptor Editor plug-in. This is in the uimaj_examples project in the
+ Component Descriptor Editor plug-in. This is in the uimaj-examples project in the
folder <literal>descriptors/tutorial/ex3</literal>. </para>
<para>The <quote>Aggregate</quote> page of the Component Descriptor Editor is
@@ -1528,7 +1528,7 @@
you find this file under the src folder, in the package
org.apache.uima.tutorial.ex5, with the name
RoomNumberAnnotator_Messages.properties. Outside of Eclipse, you can find this
- in the <literal>uimaj_examples.jar</literal> with the name
+ in the <literal>uimaj-examples.jar</literal> with the name
<literal>org/apache/uima/tutorial/ex5/RoomNumberAnnotator_Messages.properties.</literal>
If you look in this file you will see the line:
@@ -1772,7 +1772,7 @@
Better is a relative URL, which will be looked up within the classpath (and/or
datapath), as used in this example. In this case, the file
<literal>org/apache/uima/tutorial/ex6/uimaAcronyms.txt</literal> is
- located in <literal>uimaj_examples.jar</literal>, which is in the classpath.
+ located in <literal>uimaj-examples.jar</literal>, which is in the classpath.
If you look in this file you will see the definitions of several UIMA
acronyms.</para>
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=500007&r1=500006&r2=500007
==============================================================================
--- 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 Thu Jan 25 13:48:30 2007
@@ -1076,7 +1076,7 @@
please shutdown and restart TomCat.</para></listitem>
<listitem><para>All the Java classes for the UIMA Examples are packaged in the
- <literal>uima_examples.jar</literal> file which is included in the
+ <literal>uimaj-examples.jar</literal> file which is included in the
<literal>%UIMA_HOME%/lib</literal> folder.</para></listitem>
<listitem><para>In addition, if an annotator needs to locate resource files in
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=500007&r1=500006&r2=500007
==============================================================================
--- 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 Thu Jan 25 13:48:30 2007
@@ -313,7 +313,7 @@
<para>If you haven't followed the Eclipse setup instructions and wish to run the
CPE Configurator tool from Eclipse, you will need to do the following. As installed,
this Eclipse launch configuration is associated with the
- <quote>uimaj_examples</quote> project. If you've not already done so, you
+ <quote>uimaj-examples</quote> project. If you've not already done so, you
may wish to import that project into your Eclipse workspace. It's located in
%UIMA_HOME%/docs/examples. Doing this will supply the Eclipse launcher with all
the class files it needs to run the CPE configurator. If you don't do this, please
@@ -323,8 +323,8 @@
to change the CPE launch configuration to be based on your project. If you do that, it will
pick up all the files in your project's class path, which you should set up to
include all the UIMA framework files. An easy way to do this is to specify in your
- project's properties' build-path that the uimaj_examples project is on
- the build path, because the uimaj_examples project is set up to include all the UIMA
+ project's properties' build-path that the uimaj-examples project is on
+ the build path, because the uimaj-examples project is set up to include all the UIMA
framework classes in its classpath already. </para></note>
<para>Next, in the Eclipse menu select <literal>Run →
Modified: incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml
URL: http://svn.apache.org/viewvc/incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml?view=diff&rev=500007&r1=500006&r2=500007
==============================================================================
--- incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml (original)
+++ incubator/uima/uimaj/trunk/uima-docbooks/src/docbook/tutorials_and_users_guides/tug.xmi_emf.xml Thu Jan 25 13:48:30 2007
@@ -131,7 +131,7 @@
XMI must conform to the Ecore model generated by
<literal>UimaTypeSystem2Ecore</literal>.</para>
- <para>Also, the uimaj_examples Eclipse project contains some example code that shows
+ <para>Also, the uimaj-examples Eclipse project contains some example code that shows
how to use the serializer and deserializer:
<blockquote>
@@ -147,7 +147,7 @@
then do further analysis.</para>
</blockquote></para>
- <para>Finally, in under the folder <literal>uimaj_examples/ecore_src</literal> is
+ <para>Finally, in under the folder <literal>uimaj-examples/ecore_src</literal> is
the class
<literal>org.apache.uima.examples.xmi.XmiEcoreCasConsumer</literal>, which
writes each CAS to XMI format and also saves the Type System as an Ecore file. Since this