conceptual overview wiki page

[GoogleCodeExporter]

Folks, I have created a much more detailed conceptual overview for the project 
wiki and have linked to it from the front page and the documentation page.  
Please review and edit as you see fit.  

This seems like a uncontroversial ticket so I am going to close it.  Please 
re-open as you see fit.  I really just want a record of the documentation 
change for our CHANGES file...

Original issue reported on code.google.com by pvogren@gmail.com on 7 Jan 2011 at 4:40

[GoogleCodeExporter]

I couldn't find a method with this signature:

AnalysisEngine tagger = createAnalysisEngine("mypackage.MyTagger", 
typeSystemDescription);

I assume you meant this:

AnalysisEngine tagger = createAnalysisEngine("mypackage.MyTagger");

I have changed this in the page.

Original comment by richard.eckart on 7 Jan 2011 at 4:55

[GoogleCodeExporter]

Did you consider omitting the parameter "typeSystemDescription" from 
createPrimitive()? There is a version of that method that internally uses 
createTypeSystemDescription() and does not require this parameter.

Original comment by richard.eckart on 7 Jan 2011 at 4:57

[GoogleCodeExporter]

No - I didn't think of that.  It does make the code snippet shorter and more 
attractive looking - but it is going to be harder for a user to cut-n-paste and 
try out without setting up the automated type system detection.  So, I am 
inclined to leave it as it is.  

Truthfully, I haven't yet used this feature and so I don't really know whether 
it is easy or hard to use.  

Original comment by pvogren@gmail.com on 7 Jan 2011 at 5:04

[GoogleCodeExporter]

You just have to maintain the /META-INF/org.uimafit/types.txt file. I am a bit 
lazy, so I simply put 

> classpath*:desc/type/**/*.xml

into the file and keep all my type descriptors under 
src/main/resources/desc/type/. It would be cleaner though if the file lists all 
XML files individually, like

> classpath*:desc/type/Segments.xml
> classpath*:desc/type/PartsOfSpeech.xml

The only issue that I have noticed so far is that m2eclipse sometimes fails to 
copy files from src/main/resources to the target/classes. When that happens I 
have to do a clean/rebuild and after that things are usually back to normal. 
But this is an m2eclipse/Eclipse issue, not a problem of the automatic type 
system detection.

Original comment by richard.eckart on 7 Jan 2011 at 5:10

[GoogleCodeExporter]

Mind to remove the ">" at the beginning of each line. My intention was to make 
it look quoted... failed...

Original comment by richard.eckart on 7 Jan 2011 at 5:11

[GoogleCodeExporter]

Yeah - I have recently been aggravated by the failure of m2eclipse to copy 
descriptor files to the classpath.  I have to do a clean/rebuild as well - so 
this is definitely independent of the automatic type system detection.  

Where does the /META-INF folder go?  Is it a child of your project's top-level 
folder - or does it sit in /src/main/resources or some such?  

Thanks,

Original comment by pvogren@gmail.com on 7 Jan 2011 at 5:21

[GoogleCodeExporter]

I put it to src/main/resources.

Original comment by richard.eckart on 7 Jan 2011 at 5:43