tika-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Tyler Palsulich <tpalsul...@gmail.com>
Subject Re: [DISCUSS] Give examples of Parser, Detector, and Translator usage
Date Thu, 07 Aug 2014 17:31:16 GMT
Thank you for the input, Nick and Avi.

> This needs to pull from the examples in svn, so we make sure it compiles
and stays working. See above!
Ahh. Thank you for the link. So, first, create the tika-example module and
some examples. The integrate Apache CMS into the website (never done this
before, anyone have experience?). Integrate the tika-example code with the
CMS and website.

How does that sound?

Tyler


On Thu, Aug 7, 2014 at 10:16 AM, Nick Burch <apache@gagravarr.org> wrote:

> On Thu, 7 Aug 2014, Tyler Palsulich wrote:
>
>> 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 did[1]. The CMS coupled with Markdown is able to pull in snippets from
> SVN. There was a general sense that we should see if we could do it with
> Apt too (maybe with a plugin?), otherwise switch from Apt to Markdown + CMS
> for building + editing the site. That was about it... Volunteer(s) needed!
>
>  *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.
>>
>
> We can check for breakages with the compiler and unit tests, which is very
> handy! (Nothing worse than examples that don't work any more...)
>
>  *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.
>>
>
> This needs to pull from the examples in svn, so we make sure it compiles
> and stays working. See above!
>
> Nick
>
> [1] eg http://mail-archives.apache.org/mod_mbox/tika-dev/201406.
> mbox/%3Calpine.DEB.2.02.1406022014580.13115%40urchin.earth.li%3E
>

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message