Improve documentation

Open jan-niestadt opened this issue 5 years ago • 2 comments

BlackLab Server requests

[x] For example, it is not very clear that the patt parameter is in Corpus Query Language (unless you override that with pattlang, which in practice is almost never done).
[ ] The examples section could probably do with a few additional examples.
[ ] It might be worth pointing out that you can use the Network tab in the browser's Developer Console to see what queries corpus-frontend sends to BLS.

May 07 '20 11:05 jan-niestadt

(most of these from https://github.com/INL/BlackLab/issues/142)

Better explain how to avoid common issues:

[x] Ensure your input XML is tokenized ( tags), see https://github.com/INL/BlackLab/issues/141
[x] How to avoid running out of memory (JVM heap size)
[x] How to index unique ids without using too much memory/disk space (disable forward index)
[ ] How to ensure whole documents can be viewed (contentViewable: true)
[ ] How to use a different configuration directory for BlackLab and corpus-frontend (probably use 1 mechanism between the two projects)
[ ] How to configure displaying whole documents with pagination (article.xsl, config file)
[ ] forEachPath, Subannotations (#126)

Jun 08 '20 07:06 jan-niestadt

[ ] inline tags, within / containing (#143, #144)
[ ] Complex XPath-like queries with complex nesting, calculations, etc. (no, XML database is better for this) (#144)
[ ] Numeric fields, range queries (only for metadata fields, not annotations) (#131, #144)

Jun 08 '20 07:06 jan-niestadt