Great idea! This is what we did with apache OODT radix you can scope here https://cwiki.apache.org/confluence/display/OODT/RADiX+Powered+By+OODT
Sent from my iPhone On Aug 7, 2014, at 12:56 PM, "Hong-Thai Nguyen" <thaicha...@gmail.com<mailto:thaicha...@gmail.com>> wrote: Nice idea. We could do more than samples. We can generate parser, detecter or translator maven archetype. A kind o templete so that user can have quickly project to develop new one. Regards, Hong-Thai On 07 Aug 2014, at 18:56, Tyler Palsulich <tpalsul...@apache.org<mailto:tpalsul...@apache.org>> wrote: Hi All, I think we should add some consolidated documentation on how to use Tika's Java API. It would be very helpful if we had short snippets of code that showed how exactly you can use Parser.parse(), for example. I think I remember a thread about testing example code a while back, but I'm not sure. We have some developer documentation on the site, but the user docs are somewhat lacking. I can think of a few options: *1) tika-example module*. This module would have example code of using each main interface of Tika. Simplicity and organization would be king, so new users can find exactly what they're looking for quickly. A big benefit of this is that unit tests would be baked in. I like this option. One downside is that reading source code in the browser is terrible (e.g. see [0]). *2)* Examples section on the *wiki*. My impression is that the wiki is not as popular as the root website. And, it's also very easy to forget about and let go out of date. But, formatting and explanations would be pretty. *3)* Examples section on the *website*. This has the benefit of pretty formatting and coloring, without the potential user having to check out the repo or view direct source in browser. Another benefit is this section would be perfect for showing how to use the tika-app jar. Right now, I think the best option is a combination of 1 and 3. We get some end to end examples running in the tika-example module and short snippets of usage on an examples page of the website. What do you guys think? What other options should we consider? Tyler [0] - http://svn.apache.org/repos/asf/tika/trunk/tika-core/src/main/java/org/apache/tika/parser/Parser.java
