NameLink Documentation

NameLink depends on the NameTag tool to add tags around scientific names. NameLink recognizes these tags and looks the names up in the Global Names Index and adds hyperlinks to the names in the manner specified by the configuration

JavaScript:

NameLink functionality can be initiated by a client by including a javascript file on any HTML page:

 <script type="text/javascript" src="http://services.eol.org/namelink/javascript/namelink.js"></script>

Parameters can be defined BEFORE including the namelink.js file. Here are some customizable parameters:

<script type="text/javascript">
  var namelink_sources = ['eol', 'gbif', 'gni'];
  var namelink_show_logo = true;
  var namelink_show_common_name = true;
</script>

API Prefix: http://services.eol.org/namelink/doc/namelink_service.php

Paramaters:

callback	if a callback is specified the response of this API will be a javascript function of the same name. The only argument of the function will be a JSON object representing the generated HTML. callback=hello_world hello_world({"html":""})
collections	a comma delimited list of collections to link to. The order indicates precedence. col: Catalogue of Life eol: Encyclopedia of Life gbif: Global Biodiversity Information Facility gni: Global Names Index itis: Integrated Taxonomic Information System namebank: uBio Namebank
return_result	if set to anything except 0, the page HTML will be marked up on the NameLink server and the resulting linked HTML will be returned
logo	if set to anything except 0, an icon for the linked collection will be included after each linked name
common_names	if set to anything except 0, common names for the found scientitic names will be looked up and included after the name in parenthesis currently this option only works for collection EOL
url	the URL of the page to be linked