This is intended to be a collection of short documents about the development of BlackLab.
They describe processes and plans for BlackLab. These are intended to be like RFCs or Python's PEPs, but even less formal.
Types of BARKs:
- Information, some information about BlackLab, e.g. a bit of history.
- Process, about how we develop BlackLab, for example a backwards compatibility policy.
- Change, about a new feature or implementation in BlackLab, for example better support for searching tree-like structures.
See below for the current list. Each BARK can be extended and improved over time. Previous versions are recorded in version control.
Changes also have a status: planned, in development, experimental or production.
| BARK# | Name | Description | Type | Status |
|---|---|---|---|---|
| 1 | The story so far | Quick overview of how BlackLab (Server) has changed between versions and why. | info | |
| 2 | Evolution and backward compatibility | How we evolve BlackLab over time and deal with backward compatibility. | process | |
| 3 | Code style | The layout of our code. | info | |
| 4 | Performance and resource requirements | Why BlackLab has limits, and general ways to improve matters. | info | |
| 5 | Relationship with Lucene | How BlackLab uses Lucene and why staying up to date is important. | info | |
| 6 | Integrated index format | All external files incorporated into the Lucene index. | change | experimental |
| 7 | Solr integration | How we'll make use of Solr's feature set. | change | experimental |
| 8 | Distributed search | Better scaling to huge corpora and many users. | change | development |
| 9 | Optional content store | Provide for alternatives to the built-in content store. | change | planned |
| 10 | Searching tree-like structures | Enable treebanks-like search. | change | planned |
| 11 | Parallel corpora | Corpora containing multiple languages. | change | planned |
| 12 | Project goals | High-level goals of the BlackLab project. | info |