Documentation

When you download and install any of the CWB projects, you will find some documentation is present within the download, usually with a helpful name, such as README or INSTALL or similar. However, the most extensive documentation is in the form of manuals that are accessible separately. These are listed on this page.

CWB manuals

Currently, the official CWB documentation consists of two detailed manuals on the CWB core, which document the corpus encoding procedure, the CQP query language, and interactive use of the CQP query processor.

CQPweb documentation

The most extensive guide for installing and managing CQPweb is its system administrator's manual, available within the CQPweb code itself (under doc) as well as from this website.

Users interested in installing CQPweb on Windows might take a look at Peter Uhrig's guide to installing CQPweb on Windows Subsystem for Linux.

CQi — a client-server protocol for the CWB

The corpus query interface (CQi) is a remote client-server API that provides low-level corpus access as well as (almost) complete CQP functionality. Its main purpose is to enable CWB-based development in programming languages which cannot easily be linked to C libraries or run an interactive CQP backend.

The CWB core includes a stand-alone CQPserver that implements the CQi protocol. A reference implementation of a CQi client interface is included in CWB/Perl.

Available documentation:

The CQi specification as it stands applies to Versions 3.0 to 3.5 of CWB. You may confidently expect things to be fundamentally different in CWB 4.0.