NAME

NNexus - Procedural API for NNexus indexing, auto-linking and annotation.

SYNOPSIS

use NNexus;
$annotated_text = linkentry($text,%options);
$invalidated_urls = indexentry($url,%options);

DESCRIPTION

This class provides a high-level user-facing procedural API for NNexus processing. Useful for Perl scripting, for example:

perl -MNNexus -e 'print linkentry(join("",<>))' < example.html > linked_example.html

METHODS

$annotated_text = linkentry($text,%options);

Wikifies/auto-links the provided $text against the default NNexus database, unless otherwise specified. The accepted %options are all accepted options of the NNexus::Job new constructor.

$invalidated_urls = indexentry($url,%options);

Indexes a new entry located at the provided $url, invalidates the current auto-link jobs known to the default database and returns the entries to be invalidated. The accepted %options are all accepted options of the NNexus::Job new constructor.

SEE ALSO

NNexus::Job, nnexus, NNexus::Manual

AUTHOR

Deyan Ginev <d.ginev@jacobs-university.de>

COPYRIGHT

Research software, produced as part of work done by 
the KWARC group at Jacobs University Bremen.
Released under the MIT License (MIT)