[JENA-476] Improve Text Search documentation

• Type: Documentation
• Status: Closed
• Priority: Major
• Resolution: Done
• Affects Version/s: Fuseki 1.0.0
• Fix Version/s: Jena 2.11.0
• Component/s: Fuseki
• Assignee: Andy Seaborne
• Reporter: Joachim Neubert
• Created: 23/Jun/13 05:11
• Updated: 01/Feb/15 19:12
• Resolved: 01/Feb/15 19:12

Description

The text index documentation should give an clearer idea about the options to build an index. Additionally, currently the TOC is out of sync with the document itself, and it is difficult to grab the overall structure.

Therefore, I'd suggest an update mainly on the configuration part, and enhance it with the different index maintenance options. They should start with the most simple option (Fuseki) to the most demanding (Java code):

• Architecture
• Query with SPARQL
• Configuration and Index Maintenance
  • Assembler Example
  • Working with Fuseki
  • Building the Index Explicitly
  • Use and Build with Code
  • Deletion of Index Entries
• Maven Dependency

I've considered splitting up Configuration and Index Maintenance, but that would require additional work in the Fuseki and Code parts.

Along the way, I have corrected some obvious spelling errors. But perhaps the text should be checked by an univolved native speaker.

The attached patch is against the current http://jena.staging.apache.org/documentation/query/text-query.html. (I could not figure out where to find a source for it.)