Home

Paratext Plugin API 2.0

The Paratext plugin API has been rewritten from the ground up to be easier to use, more performant, and to allow much more direct interaction with Paratext.

To help plugin developers get started, we've included some helpful material:

• Full API documentation
• Decisions the plugin developer needs to make
• How to build a plugin
• How to debug a plugin
• How to specify a menu entry
• How to get user and project information from Paratext
• How to read Scripture data from Paratext
• How to write Scripture data to Paratext
• How to display data in a Paratext window
• How to keep Scripture location synchronized with Paratext
• How to generate content for a List Window in Paratext
• How to annotate Scripture text displayed by Paratext
• How to interact with Biblical Terms
• How to save plugin data
• How to be notified when a selection changes
• How to access project notes
• How to make an entry in the Paratext log
• How to access protected resource content
• About verse references and versifications

See also some Reference Plugins that show examples of how to do the above.