Documentation

Informational

Anatomy Of An Ultralink

Take a tour of the Ultralink and get familiar with the terminology we use to describe various elements of the user interface.

How Ultralinks Work

A high-level overview describing how the various front-end Ultralink processes work.

DeploymentHow the Ultralink logic gets loaded into a page.
Load ProcessWhat Ultralink code does when it is loaded and how it processes the page content.
Ultralink InjectionHow the actual Ultralinks get overlaid on of the existing content.
Ultralink User InterfaceA quick summary of the core elements the Ultralink itself.
Ultralink ConfigurationAn overview of the various ways that you can configure Ultralink behavior.
Ultralink StorageOutlines that ways that Ultralinks can be defined and modified.
Being A Good HouseguestExplains how Ultralinks do not interfere with existing page function and performance.
Deployment
How the Ultralink logic gets loaded into a page.
Load Process
What Ultralink code does when it is loaded and how it processes the page content.
Ultralink Injection
How the actual Ultralinks get overlaid on of the existing content.
Ultralink User Interface
A quick summary of the core elements the Ultralink itself.
Ultralink Configuration
An overview of the various ways that you can configure Ultralink behavior.
Ultralink Storage
Outlines that ways that Ultralinks can be defined and modified.
Being A Good Houseguest
Explains how Ultralinks do not interfere with existing page function and performance.
Content Targeting

An in-depth examination on how the Ultralink code decides where to look for content in webpages and how to break it up into fragments for analysis. In most cases, it just does the right thing automatically. There are however, a variety of ways that you can specifically override the default behavior and dictate how your content gets identified.

Scanning Guides

When high-level content targeting options are not enough, you can use scanning guides to surgically target individual chunks of your content and specify custom Ultralink behavior on different fragments in the same page.

Fragment Analysis

This is an overview of the exact process of client-side preparation, and server-side analysis of indiviudal fragments. Here you can learn about what things influence the returned Ultralink results, and how it correctly disambiguates between multiple Ultralinks that match against the same word.

Ultralink Autogeneration

In most cases, the Ultralinks overlaid into your content will come from an Ultralink Database. However, there can be some cases where it makes sense to generate Ultralinks on the fly based on the values in the content.

Ultralink Roots

Roots are the primary way to add your own functionality to Ultralinks. This document guides you through how Ultralink Roots are laid out, describes options.json which is the central configuration file for a Root and lists the various attributes you can use there to customize your own link types.

Inline Views

The Inline View is where you create specific solutions for your custom link types. Out of the box they contain formatting and structures that allow you to take advantage of powerful Ultralink features.

Reference

The Ultralink Object

The core Ultralink functionality is delivered through the ultralink.js file. It creates a global Ultralink object that you can manually interact with to customize the behavior of the Ultralink code in that context. The interfaces on that object are documented here.

Server Class Documentation

If you are running your own Ultralink Server, you can write scripts directly against the object-oriented back end as opposed to using the REST API. This can have significant performance benefits for processing large data sets or making a high volume of changes.

The classes are very similar to those found in our API Client Libraries and in many cases the scripts you write can be used in either context with minimal modification.

Glossary

Detailed definitions of all the different names for things and terms we use.