-
Notifications
You must be signed in to change notification settings - Fork 6
IParatextScrTextAnnotationPlugin
Interface for plugins that want to create annotations to show in the Scripture text child window.
IEnumerable<PluginAnnotationMenuEntry> PluginAnnotationMenuEntries
List of menu entries that will show or hide a set of annotations
NOTE: PluginAnnotationMenuEntry
string Name
Gets the name of the plugin.
Version Version
The version of the plugin
string VersionString
The version of the plugin suitable for showing to the user
string Publisher
Gets the name of the plugin's publisher.
IEnumerable<KeyValuePair<string, XMLDataMergeInfo> > MergeDataInfo
Defines the merge handling for all plugin data. The string is the name of the data identifier used when saving and the merge info defines the merge handling for that data. For any plugin data that is not XML or for which you want the default merge behavior, the merge info can be null. (see XMLDataMergeInfo for more information).
NOTE: If the plugin has no data to be saved in a project, null should be returned.
string GetDescription(string locale)
Gets the description of the plugin
| Parameter | Description |
|---|---|
| locale | ISO 639-3 language code with optional RFC 5646 subtags to identify the language in which term plugin description is requested. If a plugin is not localized or does not have a description in the requested locale, it can fall back to English (en). |
This page is auto-generated. User edits will be lost when regenerated.