NNexus::Annotate - Class for serializing NNexus concepts into annotations
use NNexus::Annotate qw(serialize_concepts); $serialized_result = serialize_concepts( body=>$original_concept_source, concepts=>$discovered_concepts, annotation=>$annotation_format, embed=>$boolean, domain=>$target_domain, verbosity=>$boolean);
NNexus::Annotate provides fleixble annotation capabilities for serializing NNexus concept harvests. It includes support for embedded and stand-off annotation in a variety of annotation formats. Currently, the supported annotation forms are (one or more of) HTML, JSON, RDFa, Perl.
The embedded links serialization comes with support for embedding multi-links.
$serialized_result = serialize_concepts(%options);
Main serialization API, taking in a reference to an array of NNexus concepts, and producing the desired annotation serialization.
The available options are:
concepts: (required) the arrayref of concept hashes
body: (optional) the original HTML/text source the concepts were discovered from. required when "embed" is turned on
embed: boolean switch between embedded and stand-off annotation. Embedding by default
domain: if defined and not set to "all", will only serialize concepts from the given $domain.
annotation: desired annotation format - currently one or more of "HTML" (default), "HTML+RDFa", "JSON"
verbosity: boolean switch turning verbosity on or off (default).
Deyan Ginev <email@example.com>
Research software, produced as part of work done by the KWARC group at Jacobs University Bremen. Released under the MIT License (MIT)