Jörn,
I'm attaching my edits of the docbook for this. Since attachments
aren't allowed on our mailing lists, I'm copying you directly also :-)
You can apply the patch and then do a compare-with-base-revision to see
everything I changed.
Cheers. -Marshall
Index:
C:/a/Eclipse/3.3/apache/CasEditor/docbook/casEditorUserGuide/casEditorUserGuide.xml
===================================================================
---
C:/a/Eclipse/3.3/apache/CasEditor/docbook/casEditorUserGuide/casEditorUserGuide.xml
(revision 620694)
+++
C:/a/Eclipse/3.3/apache/CasEditor/docbook/casEditorUserGuide/casEditorUserGuide.xml
(working copy)
@@ -35,9 +35,11 @@
<para>
The CAS Editor is an annotation tool which supports
manual and automatic
- annotation of CAS files. The CAS Editor can visualize
and edit feature structures
- including annotations which can be viewed and edited
- directly on text. Currently only text based CAS are
supported.
+ annotation (via running UIMA annotators) of CAS files.
+ Currently only text-based CAS are supported.
+ The CAS Editor can visualize and edit all feature structures.
+ Feature Structures which are annotations can additionally be viewed and
edited
+ directly on text.
</para>
<screenshot>
@@ -54,15 +56,15 @@
<title>Projects</title>
<para>
- The CAS Editor organizes all artifacts in a project. It
is
+ The CAS Editor organizes all artifacts in one or more
projects. It is
not possible to open artifacts which are located
outside of
- the project.
+ a project.
</para>
<section id="ugr.tools.cas_editor.pojects.structure">
<title>Project structure</title>
- <para>The project can be composed of these
elements:</para>
+ <para>A project includes these elements:</para>
<para>
<itemizedlist>
@@ -87,7 +89,7 @@
<listitem>
<para>
<emphasis>CAS
file</emphasis>
- The CAS itself, it must
be located in a
+ The CAS itself. It
must be located in a
corpus folder and must
end with ".xcas" to
be recognized as a CAS
file. Currently only
xcas files are
supported.
@@ -97,10 +99,10 @@
<listitem>
<para>
<emphasis>CAS Processor
folder</emphasis>
- A processor folder
contains the Analysis
- Engine and Consumer
Descriptor files. The
- CAS processor folder is
also the data path
- for the processors. A
project can have
+ 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>
@@ -137,7 +139,7 @@
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
+ elements contains an error, a marker which
describes the
problem is added to the file.
</para>
@@ -166,7 +168,7 @@
<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
+ to the project; other functions are only
available if the
type system is present. Use copy and paste to
import an
existing type system. Editing of the type
system is
currently not supported inside the CAS Editor.
@@ -175,13 +177,13 @@
<note>
<para>
If an external text editor is used to
modify the
- type system close all editors inside
the CAS Editor
+ type system, close all editors inside
the CAS Editor
and run the refresh action.
</para>
</note>
<para>
- After the type system file is added make the
CAS Editor
+ 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:
@@ -207,14 +209,14 @@
<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
corpus folder
+ 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
+ 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
+ in a flat hierarchy; sub folders which contain
CAS files
are not shown.
</para>
</section>
@@ -231,34 +233,39 @@
<section id="ugr.tools.cas_editor.annotation_editor.editor">
<title>Editor</title>
<para>
- The editor has a edit mode. By default the
editor only
+ The editor has an associated, changable CAS
Type.
+ This type is called the editor "mode".
+ By default the editor only
shows annotation of this type. Actions and
views are
- sensitive to the edit mode. To switch the type
of edit
- mode use the "Mode" menu in the editor context
menu. The
- editor can also show other annotation which
have not the
- type of the edit mode. For this use the "Show"
menu in
+ sensitive to this mode. To change the
+ mode for the editor, use the "Mode" menu in the editor context menu.
+ </para>
+ <para>
+ The editor can also show annotations of other Types.
+ To do this, use the "Show" menu in
the context menu. The annotation renderer and
rendering
layer can be changed in the Properties dialog.
After the
change all editors should be re-opened.
</para>
<para>
- The editor automatically selects annotations
near the
- cursor of the edit mode. This selection is then
+ The editor automatically selects annotations of
the
+ editor mode Type that are near the
+ cursor. This selection is then
synchronized or displayed in other views.
</para>
<para>
- To create an annotation mark a piece of text
and then
- press the enter key. The annotation now has the
bounds
- of the selection and the type of the edit mode.
+ To create an annotation manually using the
editor, mark a piece of text and then
+ press the enter key. This creates an annotation
of the
+ type of the editor mode, having bounds corresponding to the selection.
</para>
<para>
- It is also possible to choose the annotation
type, press
+ It is also possible to choose the annotation
type; press
shift + enter for this. Then a dialog asks for
the
- annotation type.
+ annotation type to create.
</para>
<para>
To delete an annotation select it and press the
delete
- key. Only annotations of the edit mode can be
selected.
+ key. Only annotations of the editor mode can be
selected.
</para>
<screenshot>
<mediaobject>
@@ -273,8 +280,8 @@
<section id="ugr.tools.cas_editor.annotation_editor.outline">
<title>Outline view</title>
<para>
- The outline lists the annotations of the
current edit
- mode of the editor. There are actions to
increase or
+ The outline lists the annotations of the
current editor
+ mode. There are actions to increase or
decrease the bounds of the selected annotation.
There is
also an action to merge all selected
annotations.
</para>
@@ -293,7 +300,7 @@
id="ugr.tools.cas_editor.annotation_editor.properties_view">
<title>Edit Views</title>
<para>
- The Edit Views are showing details about the
currently
+ The Edit Views show details about the currently
selected annotations or feature structures. It
is
possible to change primitive values in this
view.
Referenced feature structures can be created
and deleted
@@ -315,8 +322,8 @@
<section id="ugr.tools.cas_editor.annotation_editor.fs_view">
<title>FeatureStructure View</title>
<para>
- The FeatureStructure View list all feature
structures of
- a certain type. The type is selected in the type
+ The FeatureStructure View lists all feature
structures of
+ a specified type. The type is selected in the
type
combobox.
</para>
@@ -338,18 +345,18 @@
<chapter id="sandbox.caseditor.cas_processor_integration">
<title>Cas processor integration</title>
<para>
- The Analysis Engine can be run against a whole corpus
or a
- few CAS files. To do this select a corpus or CAS files
and
+ An Analysis Engine can be run against either a whole
corpus or just a
+ few CAS files. To do this select a corpus or some CAS
files and
then choose in the context menu the correct Analysis
Engine.
The filename of the Analysis Engine must end with ".ann"
otherwise it is not recognized as an Analysis Engine.
</para>
<para>
- The Consumer can be fed with the CAS files inside a
corpus.
+ The CAS Consumer can be fed with the CAS files loaded
from a corpus.
To do this select a corpus and then select the consumer
in
- the context menu. To add a Consumer Descriptor paste a
file
- into the processor folder. The filename must end with
".con"
+ the context menu. To add a CAS Consumer Descriptor
paste a file
+ into the processor folder. The filename must end with
".con";
otherwise it is not recognized as consumer.
</para>
</chapter>
