On Sat, 19 Dec 2015, Joey Hong wrote:
Regarding TIKA-1329, I found the tike-site on the Subversion source code, and I called: svn checkout https://svn.apache.org/repos/asf/tika/site/publish/1.11/ <https://svn.apache.org/repos/asf/tika/site/publish/1.11/>.Since this isn’t part of the main tika/trunk repository, I was wondering if I should still follow the same protocol and svn commit my changes to the site folder.
You shouldn't be working on those files - they're the generated HTML. You need to work on the original APT (Almost Plain Text) files which are in a sibling folder
I'd suggest, if you want to work on any docs stuff (yey!), you just checkout https://svn.apache.org/repos/asf/tika/site
Then edit the files in src/site/apt/1.x/, and use "mvn install" in the checkout root to test how the resulting HTML looks
In case I shouldn’t, I’ve attached my changes to the usage examples page of the website below. I basically added how to parse documents with embedded docs using the RecursiveParserWrapper class, and how to serialize the returned Metadata list to JSON, with some description.
Examples is a bit special! Any code should go into the tika-example module in the main source tree, along with unit tests that verify that they work properly + stay working properly. That avoids the common issue of examples that no longer work/compile!
Once your changes are in the example svn area, edit in the site folder the file src/site/apt/1.{x+1}/examples.apt to both pull in the appropriate code snippet + describe it. Use the %{include} directive to have the code pulled in, tell it which file to grab from, and which method, and it'll nicely inline the unit-tested example for you
Nick
