You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@uima.apache.org by Jörn Kottmann <ko...@gmail.com> on 2008/02/11 18:24:12 UTC
Cas Editor documentation review
Hello,
before the release of the Cas Editor can be done, the documentation
should be reviewed.
Can someone help me out with this task ?
Thanks,
Jörn
Re: Cas Editor documentation review
Posted by Marshall Schor <ms...@schor.com>.
Jörn Kottmann wrote:
> Hello,
>
> before the release of the Cas Editor can be done, the documentation
> should be reviewed.
>
> Can someone help me out with this task ?
>
> Thanks,
> Jörn
>
Hi - in section 3.1 - I think you need to expand on the meaning of
"annotation renderer and rendering layer". I don't know what these are
or what I can do with them.
Cheers. -Marshall
Re: Cas Editor documentation review - special file types e.g. .ann and .con
Posted by Tong Fin <to...@gmail.com>.
As Marshall mentioned, the content type concept is very powerful and is
introduced in Eclipse 3.0. It is very helpful to avoid using "special"
naming or extensions for files.
Even said that, let get the thing out first and come back to improve it in
the next release.
It is good to have a JIRA for this issue.
I will help to do that.
-- Tong
On Feb 12, 2008 3:08 AM, Jörn Kottmann <ko...@gmail.com> wrote:
> > I'm guessing that files labeled as .ann and .con are "converted" to
> > end in ".xml" - and that these are standard UIMA descriptors, is
> > that correct?
>
> The .ann or .con files contain standard uima descriptor files, bute
> they are not converted to .xml they are accessed with the eclipse
> resource api
> and then passed on to uima. The file ending is used to identify the
> type of the descriptor. The goal was that the Cas Editor can detect
> annotator
> and consumer descriptor files. This is necessary to reference them
> later e.g. in the ui actions to run them against a document.
>
> > If there are good reasons to have a different convention for these
> > kinds of things in the CasEditor, it would probably be good to
> > document the rationale - to help motivate the reader to get past any
> > initial confusion about this.
>
> I can add this to the documentation.
>
> Jörn
Re: Cas Editor documentation review - special file types e.g. .ann and .con
Posted by Jörn Kottmann <ko...@gmail.com>.
> I'm guessing that files labeled as .ann and .con are "converted" to
> end in ".xml" - and that these are standard UIMA descriptors, is
> that correct?
The .ann or .con files contain standard uima descriptor files, bute
they are not converted to .xml they are accessed with the eclipse
resource api
and then passed on to uima. The file ending is used to identify the
type of the descriptor. The goal was that the Cas Editor can detect
annotator
and consumer descriptor files. This is necessary to reference them
later e.g. in the ui actions to run them against a document.
> If there are good reasons to have a different convention for these
> kinds of things in the CasEditor, it would probably be good to
> document the rationale - to help motivate the reader to get past any
> initial confusion about this.
I can add this to the documentation.
Jörn
Re: Cas Editor documentation review - special file types e.g. .ann
and .con
Posted by Marshall Schor <ms...@schor.com>.
I'm guessing that files labeled as .ann and .con are "converted" to end
in ".xml" - and that these are standard UIMA descriptors, is that correct?
This seems like it might be somewhat confusing to UIMA users who are
used to uima descriptors being xml files and ending in .xml.
Other approaches might be to use the content-type capabilities, or to
use special directories holding files of one particular content type.
If there are good reasons to have a different convention for these kinds
of things in the CasEditor, it would probably be good to document the
rationale - to help motivate the reader to get past any initial
confusion about this.
-Marshall
Re: Cas Editor documentation review - only XCAS supported?
Posted by Jörn Kottmann <ko...@gmail.com>.
> Let's try and get a release out with what is there now. Anything
> that's not a show stopper, open a Jira issue so we don't forget.
> The CasEditor has been sitting there almost ready for some time
> now. What it needs most urgently is a release and some end-user
> feed-back. Then we can prioritize for the next release. My
> opinion, anyway.
I see this like Thilo. We should get a release out as soon as possible.
We can then add xmi support for the next release maybe even together
with the next uima core bugfix release in a few weeks.
BTW, there is already an jira ticket UIMA-503.
Jörn
Re: Cas Editor documentation review - only XCAS supported?
Posted by Thilo Goetz <tw...@gmx.de>.
Let's try and get a release out with what is there now. Anything
that's not a show stopper, open a Jira issue so we don't forget.
The CasEditor has been sitting there almost ready for some time
now. What it needs most urgently is a release and some end-user
feed-back. Then we can prioritize for the next release. My
opinion, anyway.
--Thilo
Tong Fin wrote:
> I think a "few" lines of codes can support "both" formats without any
> problem.
>
> -- Tong
>
> On Feb 11, 2008 11:14 PM, Marshall Schor <ms...@schor.com> wrote:
>
>> The Cas Editor docs say that only XCAS file formats are supported.
>> This is a bit unfortunate if still true, because that format is not
>> "preferred" (see the UIMA Docs which say in section 3.2.7 of
>> tutorial/user guide:
>>
>> The CASes are stored in an XML format. There are two forms of this
>> format. The preferred form is the XMI form (see Section 8.3, "Using XMI
>> CAS Serialization"
>> <
>> http://incubator.apache.org/uima/downloads/releaseDocs/2.2.1-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.xmi_emf.using_xmi_cas_serialization
>>> ).
>> An older format is also available, called XCAS.
>>
>> -Marshall
>>
>
Re: Cas Editor documentation review - only XCAS supported?
Posted by Jörn Kottmann <ko...@gmail.com>.
> I think a "few" lines of codes can support "both" formats without any
> problem.
Ok, you are right XMI support is easy, I just checked it in.
Jörn
Re: Cas Editor documentation review - only XCAS supported?
Posted by Tong Fin <to...@gmail.com>.
I think a "few" lines of codes can support "both" formats without any
problem.
-- Tong
On Feb 11, 2008 11:14 PM, Marshall Schor <ms...@schor.com> wrote:
> The Cas Editor docs say that only XCAS file formats are supported.
> This is a bit unfortunate if still true, because that format is not
> "preferred" (see the UIMA Docs which say in section 3.2.7 of
> tutorial/user guide:
>
> The CASes are stored in an XML format. There are two forms of this
> format. The preferred form is the XMI form (see Section 8.3, "Using XMI
> CAS Serialization"
> <
> http://incubator.apache.org/uima/downloads/releaseDocs/2.2.1-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.xmi_emf.using_xmi_cas_serialization
> >).
> An older format is also available, called XCAS.
>
> -Marshall
>
Re: Cas Editor documentation review - only XCAS supported?
Posted by Marshall Schor <ms...@schor.com>.
The Cas Editor docs say that only XCAS file formats are supported.
This is a bit unfortunate if still true, because that format is not
"preferred" (see the UIMA Docs which say in section 3.2.7 of
tutorial/user guide:
The CASes are stored in an XML format. There are two forms of this
format. The preferred form is the XMI form (see Section 8.3, “Using XMI
CAS Serialization”
<http://incubator.apache.org/uima/downloads/releaseDocs/2.2.1-incubating/docs/html/tutorials_and_users_guides/tutorials_and_users_guides.html#ugr.tug.xmi_emf.using_xmi_cas_serialization>).
An older format is also available, called XCAS.
-Marshall
Re: Cas Editor documentation review
Posted by Thilo Goetz <tw...@gmx.de>.
Count me in.
--Thilo
Marshall Schor wrote:
> Jörn Kottmann wrote:
>> Hello,
>>
>> before the release of the Cas Editor can be done, the documentation
>> should be reviewed.
>>
>> Can someone help me out with this task ?
> I'll take a look.
> -Marshall
>>
>> Thanks,
>> Jörn
>>
Re: Cas Editor documentation review
Posted by Marshall Schor <ms...@schor.com>.
Jörn Kottmann wrote:
> Hello,
>
> before the release of the Cas Editor can be done, the documentation
> should be reviewed.
>
> Can someone help me out with this task ?
I'll take a look.
-Marshall
>
> Thanks,
> Jörn
>