HyperLinkBuilder Manual

HyperLinkBuilder.jsx
Javascript for InDesign CC, CS6, CS5.5, CS5
By www.aiedv.ch

PURPOSE:

Convert any text styled with a given Character Style to a HyperLink URL or email link.
Create:
- URL Hyperlinks
- Email Hyperlinks
These Hyperlinks also work in interactive PDF files.

Creating Hyperlinks

Convert Web Addresses:

These settings:

Convert text to hyperlinks which is styled with character style:

URL

Before:	http://
+'found text'+
After:

will convert text styled with the Character Style 'URL'
to valid clickable links to external web sites.
The styled text in InDesign may be of these types:
ddd.cc
www.ddd.cc
http://ddd.cc
http://www.ddd.cc

The target hyper links in InDesign will look like this:
http://www.ddd.cc

Convert Email Addresses:

These settings:

Convert text to EMAIL hyperlinks which is styled with character style:

Before:	mailto:
+'found text'+
After:	?subject=Subject regarding:

will convert text styled with the Character Style 'mailto'
to valid clickable email links which open the computer's standard email client.
The subject line will be preset with 'Subject regarding: '.
The styled text in InDesign may be of this type only:
xy@ddd.cc

The target hyper links in InDesign will look like this:
mailto:xy@ddd.cc?subject= Subject regarding:

Convert Web Addresses With Parameters:

Example: creating article calls into an online-shop.
These settings:

Convert text to hyperlinks which is styled with character style:

ArticleNum

Before:	http://dd.cc/shop.php ?checkout &Action,addArticle &Add,A
+'found text'+
After:

will convert text styled with the Character Style 'ArticleNum'
to valid clickable links to external web sites.
Let's assume, the styled text parts are article numbers like '123-45678'

The target hyper links in InDesign will look like this:
http://dd.cc/shop.php ?checkout &Action,addArticle &Add,A123-45678
This will push article 123-45678 directly into the shopping cart.

Cleaning Existing Hyperlinks

Hyperlinks already defined in InDesign may be 'cleaned'.
- remove orphan URL target links
- remove ALL currently defined hyper links

The settings in the 'Hyperlinks Cleaning' panel also are effective BEFORE creating the new Hyperlinks.
Clicking the 'Clean Hyperlinks' button performs a 'clean-up' only.

Storing and Reloading Settings

The currently shown settings may be stored on the disk for later use.
The default settings file 'settings.set' is always loaded before showing the main dialog.
If you always want the same settings at startup, store your preferred settings as 'settings.set'.

Pressing the 'Save Settings' Button:
Give the settings a self-describing name when asked for the settings name.

Pressing the 'Load Settings' Button:
Previously saved settings may be reloaded and executed.

Settings are stored into a folder named 'HyperLinkBuilderSupport' within the user's HOME folder on the startup disk.

DISCLAIMER: