tutorial

[GoogleCodeExporter]

uimaFIT needs a comprehensive tutorial that covers the following topics:

- annotating uima components
- using factories
- creating test suites
- running simple pipelines

etc.

Original issue reported on code.google.com by pvogren@gmail.com on 21 Apr 2010 at 3:52

[GoogleCodeExporter]

[deleted comment]

[GoogleCodeExporter]

[deleted comment]

[GoogleCodeExporter]

[deleted comment]

[GoogleCodeExporter]

adding comment to test uimafit-issues email.

Original comment by pvogren@gmail.com on 1 May 2010 at 8:49

[GoogleCodeExporter]

I think a more task oriented tutorial may be nice. Come up with a couple of 
simple tasks which are motivated and documented in the wiki along with code 
examples. Then provide the full code in the example project. While the tutorial 
should still cover the topics mentioned above, those topics should not be the 
main focus of the tutorial, but rather means to perform the tasks.

The tasks should be simple enough to be realizable with a minimum amount of 
code while covering the important uimaFIT features. I think the examples that 
have already been adapted from the UIMA tutorial are quite nice here.

I don't like that example components contain main methods or getDescription() 
methods to create XML descriptors. Components should focus only on the 
processing code. Instead there should be more test cases and task oriented 
example pipelines.

To make components even more concise, we should employ the Apache commons 
libraries where possible, e.g. to read in files or close files.

Original comment by richard.eckart on 13 Jun 2010 at 8:20

[GoogleCodeExporter]

Richard,

Thanks for the suggestions.  I rewrote the getting started page last night 
which is based on GetStartedQuickAE.java that does not have a main method or a 
getDescription method per your suggestion.  Hopefully, it is a good starting 
point for the documentation.  I think next I will create a documentation home 
page that will have a pointer to this example, the javadocs, the uima-users 
list and whatever additional content we put together.  

I'm not sure when to call this issue done - but I think if we had about 4x what 
is in the getting started - that would be a reasonable start/goal.

Original comment by pvogren@gmail.com on 15 Jun 2010 at 2:30

[GoogleCodeExporter]

I am satisfied with the documentation as it is now - at least for the 1.0.0 
release.  Future issues concerning documentation can address specific 
deficiencies.  

Original comment by pvogren@gmail.com on 16 Jul 2010 at 3:25

• Changed state: Fixed