You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by jo...@apache.org on 2011/07/14 13:39:35 UTC
svn commit: r1146656 - in /uima/uimaj/trunk/uima-docbook-tools/src/docbook:
images/tools/tools.caseditor/CorpusExplorer.png
images/tools/tools.caseditor/Properties.png tools.caseditor.xml
Author: joern
Date: Thu Jul 14 11:39:35 2011
New Revision: 1146656
URL: http://svn.apache.org/viewvc?rev=1146656&view=rev
Log:
UIMA-2123 Removed documentation about Cas Editor Project
Removed:
uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.caseditor/CorpusExplorer.png
uima/uimaj/trunk/uima-docbook-tools/src/docbook/images/tools/tools.caseditor/Properties.png
Modified:
uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.caseditor.xml
Modified: uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.caseditor.xml
URL: http://svn.apache.org/viewvc/uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.caseditor.xml?rev=1146656&r1=1146655&r2=1146656&view=diff
==============================================================================
--- uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.caseditor.xml (original)
+++ uima/uimaj/trunk/uima-docbook-tools/src/docbook/tools.caseditor.xml Thu Jul 14 11:39:35 2011
@@ -65,7 +65,10 @@ under the License.
The Cas Editor expects a type system file at the root of the project
named TypeSystem.xml. If the type system file does not exist in this
location the user has the option to point the Cas Editor to a
- type system file.
+ type system file. Or to change the default type system location in the
+ properties page of the eclipse project. To do that right click the project,
+ select Properties and go to the UIMA Type System tab, there a different
+ type system file can be chosen.
</para>
<screenshot>
@@ -83,177 +86,6 @@ under the License.
After the Cas Editor is opened switch to the Cas Editor
Perspective to see all the Cas Editor related views.
</para>
- <para>
- Depending on the requirements the user should create
- a Cas Editor project. The Cas Editor project is intended for
- users which are building a corpus or need to annotate/view a
- significant number of documents.
- See the Cas Editor project section below for further details.
- </para>
- </section>
-
- <section id="sandbox.caseditor.Projects">
- <title>Cas Editor Project</title>
-
- <para>
- The CAS Editor can operate with special Eclipse projects created using
- the menu pick for new Projects -> Other -> Cas Editor -> Cas Editor Project.
- The CAS Editor operates on artifacts in one or more of these kinds of projects. It is
- recommended to use Cas Editor Project when building a corpus or reviewing/annotating a
- huge amount of documents.
- </para>
-
- <section id="ugr.tools.cas_editor.projects.structure">
- <title>Cas Editor Project structure</title>
-
- <para>A Cas Editor project includes these elements:</para>
-
- <para>
- <itemizedlist>
-
- <listitem>
- <para>
- <emphasis>Type system</emphasis>
- The type system must be present for opening
- a CAS file or running a CAS processor.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Corpus folder</emphasis>
- A corpus folder is a collection of CAS files
- in the project. A project can have multiple
- corpus folders.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>CAS file</emphasis>
- The CAS itself. It must be located in a
- corpus folder and must end with ".xmi" or".xcas" to
- be recognized as a CAS file.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>CAS Processor folder</emphasis>
- A processor folder contains Analysis
- Engine and CAS Consumer Descriptors. The
- CAS processor folder is also put on the data path
- for the processors when they are run. A project can have
- multiple processor folders.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>
- Analysis Engine Descriptor
- </emphasis>
- Configuration for an Analysis Engine which
- can be used to annotate CAS files in a
- corpus folder. To be recognized as Analysis
- Engine Descriptor the file must end with
- ".xml", contain an Analysis Engine Descriptor and
- must be placed in a processor folder.
- </para>
- </listitem>
-
- <listitem>
- <para>
- <emphasis>Consumer Descriptor</emphasis>
- Configuration for a Consumer which can be
- fed with the CAS files in a corpus. To be
- recognized as Consumer Descriptor the file
- must end with ".xml", contain a Cas Consumer Descriptor
- and must be placed in a processor folder.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>
- These elements are shown differently than normal files
- and folders in the corpus explorer view. In addition to
- the listed elements a project can also contain files and
- folders e.g. for documentation. If one of these special
- elements contains an error, a marker which describes the
- problem is added to the file and shown in the editor (the file itself is not marked).
- </para>
-
- <para>
- The corpus explorer with a project looks like this:
- </para>
-
- <para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="100" format="PNG"
- fileref="&imgroot;CorpusExplorer.png" />
- </imageobject>
- <textobject>
- <phrase>
- Screenshot of corpus explorer
- </phrase>
- </textobject>
- </mediaobject>
- </screenshot>
- </para>
- </section>
-
- <section id="ugr.tools.cas_editor.add_typesystem">
- <title>Add a type system</title>
- <para>
- Its strongly recommended to first add a valid type system
- to the project; other functions are only available if the
- type system is present. Use copy and paste to import an
- existing type system (no drag n' drop support).
- Editing of the type system is supported, but afterwards all
- editors should be reopened to recognize the type system change.
- </para>
-
- <para>
- After the type system file is added, you need to make the CAS Editor
- aware of its existence. To do this open the Properties
- dialog for the project and then select the type system as
- shown here:
- </para>
-
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata scale="70" format="PNG"
- fileref="&imgroot;Properties.png" />
- </imageobject>
- </mediaobject>
- </screenshot>
-
- <para>
- Now the new type system element can be seen in the
- project tree of the corpus explorer.
- </para>
- </section>
-
- <section id="ugr.tools.cas_editor.add_corpus">
- <title>Add corpus folder</title>
- <para>
- To add a corpus folder first create a new folder. Then
- open the Properties dialog and add the folder to the
- list of corpus folders. It than appears as a corpus folder
- in the corpus explorer.
- </para>
-
- <para>
- The corpus explorer automatically hides all non-CAS
- files in the corpus folder. The CAS files are organized
- in a flat hierarchy; sub folders which contain CAS files
- are not shown.
- </para>
- </section>
</section>
<section id="sandbox.caseditor.annotation_editor">