Hyperlink

Description

Hyperlinks are visible on documents loaded into ARender. By clicking on it, you can access other content. You will need a source text, which will be the selected and clickable text, and a target.

Uses

To enable the creation of hyperlinks, two options are available. Right Click on the document and select the Create link option the contextual menu.

Or activate the hyperlink creation button. This button is displayed in annotation creation top panel. Repeated creation of hyperlinks is also available.

topPanel.annotationMenu.hyperlink=true
topPanel.annotationMenu.hyperlink.repeat=true

If no text is selected at the time of creation, a popup will appear asking you to select the source text and press Enter to commit. Validation by the Enter button is enabled by default. It is possible to deactivate it with the property shown below.

text.selection.hyperlink.use.enter=true

For editing the source text, the above popup appears after clicking on the pencil in the source panel. The source can be changed by selecting a new text.

After selecting your source, then a popup appears asking you for the target. Several possibilities are available to you:

• To select a page from the current document
• To provide a URL
• To select an external document to ARender using the Javascript API. To do so, you must save a function that will be executed when ARender enters or exits the target selection mode.

var waitingTarget = false;
function arenderjs_init(arenderjs_)
{
    arenderjs_.registerNotifyHyperlinkToggleTargetModeEvent(function(activated){
        waitingTarget = activated;
    });
}

Next, you will need a function to send the target to ARender when the target is requested.

function armt_notifyHyperlinkTarget(target)
{
    if(waitingTarget)
    {
        getARenderJS().notifyHyperlinkTarget(target);
        waitingTarget = false;
    } 
}

This third option is enabled by default. It is possible to deactivate it with the property shown below.

To modify the target, the above popup appears after clicking on the pencil in the target panel. Once the option is selected, the target will be changed. The same options and configurations are available.

text.selection.hyperlink.use.enter =true
annotation.hyperlink.externe.target.enabled=true

Here is a user case to better understand:

• When loading ARender, the function registerNotifyHyperlinkToggleTargetModeEvent will be called. It listens when the hyperlink creation button is pressed.
• When the hyperlink creation is enabled, a text must be selected if this has not been done first.
• Once the text is selected, select the target. When it is external to ARender (an ECM document that has not been uploaded to ARender) this document must be selected directly in the ECM. The function notifyHyperlinkTarget is called and the hyperlink target is created corresponding to the URL of the selected document.
• The hyperlink is created.

Hyperlink Explorer

Hyperlinks are visible in the hyperlink explorer. By default, it is enabled.

hyperlinkexplorer.enabled=true

The hyperlink explorer displays all the created hyperlinks. A hyperlink contains the following information :

• the name of the creator
• the date
• the source text
• the source document
• the target

Several display options are available:

Filter hyperlinks

In the hyperlink explorer, two buttons are available to filter or sort the hyperlinks.

Several filter options are available:

• per document
• per creator

You can also use the available filter buttons. ARender has two.

The fist one allows you to filter based on the username. By hovering the username, it will appear.

When this filter is activated, it will be blue. To deactivate it, simply click on it again.

The second filter allow you to filter according to the date. It will be appear by hovering the date (only if the date is displayed).

It also be blue when activated. To deactivate it, simply click on it again.