Uploaded image for project: 'Apache Jena'
  1. Apache Jena
  2. JENA-476

Improve Text Search documentation

    XMLWordPrintableJSON

    Details

    • 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
    • Labels:
      None

      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.)

        Attachments

        1. text-query.html
          37 kB
          Joachim Neubert
        2. text-query.html.patch
          13 kB
          Joachim Neubert
        3. text-query.orig.html
          36 kB
          Joachim Neubert

          Activity

            People

            • Assignee:
              andy Andy Seaborne
              Reporter:
              jneubert Joachim Neubert
            • Votes:
              1 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: