Ultralink Roots

Top-level Directory Structure

.htaccessoptional
linkTypes/optional
options.jsonrequired
optional.htaccess
optionallinkTypes/
requiredoptions.json
<IfModule mod_headers.c>
    Header set Access-Control-Allow-Origin "*"
</IfModule>

options.json

linkTypes

icon/required
view.(html, js, css)optional
message.jsoptional
insights.jsoptional
auth/optional
requiredicon/
optionalview.(html, js, css)
optionalmessage.js
optionalinsights.js
optionalauth/

customLinkTypes

namerequiredstringA human friendly name for the link type. This is used in a lot of places to refer to the link type.
iconoptionalfilenameA path to this link type's icon image relative to icon/ if using a single icon file.
iconShrinkageoptionalfloatHow much this link type's icon should be shrunk relative to link's background image. Defaults to 0.75.
iconAdjustXoptionalfloatHow much this link type's icon should be horizontally adjusted relative to it's width. Defaults to 0.0.
iconAdjustYoptionalfloatHow much this link type's icon should be vertically adjusted relative to it's height. Defaults to 0.0.
iconBackgroundoptionalfloatIf false, indicates that the icon should not be drawn over the standard link background (and not shrunk).
paneoptionaltrue | falseIndicates whether this link type should be black shadowed and have an Inline Pane.
viewoptionaltrue | falseIndicates whether this link type has an Inline View. Requires view.(html, js, css) files.
viewTypeoptionallight | darkThe visual style of the Inline Pane. Defaults to dark.
woptionalintThe width of the Inline Pane. Defaults to 500.
hoptionalintThe height of the Inline Pane. Defaults to 350.
messageoptionaltrue | falseIndicates whether the Inline View has a companion message.js file.
insightsoptionaltrue | falseIndicates whether the Inline View has a companion insights.js file.
autoPopoptionaltrue | false | alwaysCan indicate if the Inline Pane should auto-pop when there are few other links or auto-pop all the time.
prefixoptionalpartial URLFor link types in the 'Search' category, this is used to construct the final search link.
quoteoptionaltrue | falseFor link types in the 'Search' category, this indicates whether the word used in the final search link should have quotes around it.
cloneFromoptionallink typeDuring Ultralink construction, this link type should copy it's URL from the link of the specified link type in the Ultralink.
detectorsoptionalarrayAn array of regular expression strings that will match URLs to this link type. This is used in many places.
affiliateTagoptionalstringSpecifies the affiliate tag used in this link type. Used when needing to re-write the affiliate tag.
newWindowSuppressoptionaltrue | falseThis causes a click to navigate to the link as opposed to bringing up a new tab (even if user settings prefer that behavior).
viewDesktopOnlyoptionaltrue | falseIndicates whether the Inline View for this link type should be ignored on mobile browsers.
authoptionallink typeIndicates what link type provides authenticated API calls for this link type (almost always the link type itself).
suppliesAuthoptionaltrue | falseIndicates that this link type has authenticatin logic in auth/.
authTypeoptionaloauth1 | oauth2Type of authentication supplied in auth/. Defaults to oauth2.
endpointDomainoptionalpartial URLA partial URL for the Ultralink Core to match against when clearing it's API cache for a link type.
requirednamestring
A human friendly name for the link type. This is used in a lot of places to refer to the link type.
optionaliconfilename
A path to this link type's icon image relative to icon/ if using a single icon file.
optionaliconShrinkagefloat
How much this link type's icon should be shrunk relative to link's background image. Defaults to 0.75.
optionaliconAdjustXfloat
How much this link type's icon should be horizontally adjusted relative to it's width. Defaults to 0.0.
optionaliconAdjustYfloat
How much this link type's icon should be vertically adjusted relative to it's height. Defaults to 0.0.
optionaliconBackgroundfloat
If false, indicates that the icon should not be drawn over the standard link background (and not shrunk).
optionalpanetrue | false
Indicates whether this link type should be black shadowed and have an Inline Pane.
optionalviewtrue | false
Indicates whether this link type has an Inline View. Requires view.(html, js, css) files.
optionalviewTypelight | dark
The visual style of the Inline Pane. Defaults to dark.
optionalwint
The width of the Inline Pane. Defaults to 500.
optionalhint
The height of the Inline Pane. Defaults to 350.
optionalmessagetrue | false
Indicates whether the Inline View has a companion message.js file.
optionalinsightstrue | false
Indicates whether the Inline View has a companion insights.js file.
optionalautoPoptrue | false | always
Can indicate if the Inline Pane should auto-pop when there are few other links or auto-pop all the time.
optionalprefixpartial URL
For link types in the 'Search' category, this is used to construct the final search link.
optionalquotetrue | false
For link types in the 'Search' category, this indicates whether the word used in the final search link should have quotes around it.
optionalcloneFromlink type
During Ultralink construction, this link type should copy it's URL from the link of the specified link type in the Ultralink.
optionaldetectorsarray
An array of regular expression strings that will match URLs to this link type. This is used in many places.
optionalaffiliateTagstring
Specifies the affiliate tag used in this link type. Used when needing to re-write the affiliate tag.
optionalnewWindowSuppresstrue | false
This causes a click to navigate to the link as opposed to bringing up a new tab (even if user settings prefer that behavior).
optionalviewDesktopOnlytrue | false
Indicates whether the Inline View for this link type should be ignored on mobile browsers.
optionalauthlink type
Indicates what link type provides authenticated API calls for this link type (almost always the link type itself).
optionalsuppliesAuthtrue | false
Indicates that this link type has authenticatin logic in auth/.
optionalauthTypeoauth1 | oauth2
Type of authentication supplied in auth/. Defaults to oauth2.
optionalendpointDomainpartial URL
A partial URL for the Ultralink Core to match against when clearing it's API cache for a link type.
requiredname
string
A human friendly name for the link type. This is used in a lot of places to refer to the link type.
optionalicon
filename
A path to this link type's icon image relative to icon/ if using a single icon file.
optionaliconShrinkage
float
How much this link type's icon should be shrunk relative to link's background image. Defaults to 0.75.
optionaliconAdjustX
float
How much this link type's icon should be horizontally adjusted relative to it's width. Defaults to 0.0.
optionaliconAdjustY
float
How much this link type's icon should be vertically adjusted relative to it's height. Defaults to 0.0.
optionaliconBackground
float
If false, indicates that the icon should not be drawn over the standard link background (and not shrunk).
optionalpane
true | false
Indicates whether this link type should be black shadowed and have an Inline Pane.
optionalview
true | false
Indicates whether this link type has an Inline View. Requires view.(html, js, css) files.
optionalviewType
light | dark
The visual style of the Inline Pane. Defaults to dark.
optionalw
int
The width of the Inline Pane. Defaults to 500.
optionalh
int
The height of the Inline Pane. Defaults to 350.
optionalmessage
true | false
Indicates whether the Inline View has a companion message.js file.
optionalinsights
true | false
Indicates whether the Inline View has a companion insights.js file.
optionalautoPop
true | false | always
Can indicate if the Inline Pane should auto-pop when there are few other links or auto-pop all the time.
optionalprefix
partial URL
For link types in the 'Search' category, this is used to construct the final search link.
optionalquote
true | false
For link types in the 'Search' category, this indicates whether the word used in the final search link should have quotes around it.
optionalcloneFrom
link type
During Ultralink construction, this link type should copy it's URL from the link of the specified link type in the Ultralink.
optionaldetectors
array
An array of regular expression strings that will match URLs to this link type. This is used in many places.
optionalaffiliateTag
string
Specifies the affiliate tag used in this link type. Used when needing to re-write the affiliate tag.
optionalnewWindowSuppress
true | false
This causes a click to navigate to the link as opposed to bringing up a new tab (even if user settings prefer that behavior).
optionalviewDesktopOnly
true | false
Indicates whether the Inline View for this link type should be ignored on mobile browsers.
optionalauth
link type
Indicates what link type provides authenticated API calls for this link type (almost always the link type itself).
optionalsuppliesAuth
true | false
Indicates that this link type has authenticatin logic in auth/.
optionalauthType
oauth1 | oauth2
Type of authentication supplied in auth/. Defaults to oauth2.
optionalendpointDomain
partial URL
A partial URL for the Ultralink Core to match against when clearing it's API cache for a link type.

Link Type Icons

Inline Views

Authentication

PreviousPrev
Next