Chinese Text Project

About Chinese Text Project

Chinese Text Project (CTP) offers an Application Programming Interface for integrating its digital library content and tools with external websites and applications. The API has two components: a plugin API that defines functional link points within CTP so external tools and resources can be connected and installed by users without technical knowledge, and a JSON API that allows CTP's functionality to be embedded into external sites.

The plugin system is based on XML files conforming to a published CTPPlugin DTD, specifying elements such as short names, descriptions, and URL templates for linking to external resources. Existing plugin examples include text analysis tools, an annotation tool, a plain text export tool, a tool listing editions of a title on TextRef.org, and a character lookup tool (MHDB), applicable at the chapter, book, character, or word level depending on the plugin.

This resource is intended for developers building tools around classical Chinese texts, including those who want to create their own CTP plugins or integrate CTP's textual data and functionality into other applications.

Key features

• JSON API for integrating Chinese Text Project content and functionality into external sites
• Plugin API for connecting external tools and resources into the CTP
• XML-based plugin definitions conforming to the CTPPlugin DTD
• Text tools plugin for textual analysis at chapter and book level
• Annotate plugin for textual annotation
• Plain text export plugin for books and chapters

Frequently asked questions