Annotations

Annotations tell something about (parts of) your content and optionally tell you how to improve your content by giving suggestions. For example, think of spelling and grammar suggestions or potential reference-, linking- and reuse-opportunities.

The FontoXML Content Quality App executes its analysis and will return the results in the form of annotations back to the editor. It are the annotators that produce the actual annotations. 

You configure the editor how to handle the annotations and what suggestions to give to the author when implementing custom annotation types. You configure this behavior based on the type and metadata that is attached to the annotations

The metadata of an annotation is a JSON object that could contain any relevant data for that specific annotation. For example, the spelling error annotation will have a list of replacement suggestions in its metadata object so that the editor can be configured to show these as possible suggestions.

Build-in annotations

LanguageAnnotation

By default the Content Quality App is configured to check the xml:lang attribute in your content and adds a LanguageAnnotation for that part of your content. It will automatically add these annotations before executing your analysis.

It's metadata object will look as follows:

{
	"tag": "[The tag for identifying the language, e.g. en-GB]"
}

The value of the tag is an IETF language as described in the BCP 47 document series.

A LanguageAnnotation will not be returned to the editor since the content is already tagged with that language. They are made available as annotations so they can be used by the LanguageToolAnnotator or an implementation of the HttpApiAnnotator.