[
https://issues.apache.org/jira/browse/JENA-476?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Joachim Neubert updated JENA-476:
---------------------------------
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.)
was:
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):
{{monospaced}}
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
{{monospaced}}
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.)
> Improve Text Search doc
> -----------------------
>
> Key: JENA-476
> URL: https://issues.apache.org/jira/browse/JENA-476
> Project: Apache Jena
> Issue Type: Documentation
> Components: Fuseki
> Affects Versions: Fuseki 0.2.8
> Reporter: Joachim Neubert
>
> 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.)
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira