Login

Help

Documentation

Hyperlinks

Twixl Support Team Updated: - Created :

    Add links to text or objects.

    2. Options

    2.1. Page Link

    You can create a hyperlink that refers to any page within your book (i.e. publication). Page hyperlinks from portrait pages have to navigate to another portait page, and hyperlinks from landscape pages have to navigate to another landscape page.

    Page Hyperlink

    2.2. URL link

    You can create a hyperlink that links to an external URL. On the tablet, tapping such a link will open a browser popup window for that URL within the app. Once the user has finished using the browser, tapping the "Done" button of the browser popup will bring the app back to the foreground.

    URL Hyperlink

    2.3. Opening a hyperlink in the device browser

    Although in most cases, you want to keep readers in the embedded browser, sometimes you may want to open a link directly in Safari on iPad or in the default browser on Android. A good use case for this is if you want to link to a PDF that you want readers to be able to download.

    You can do this by adding an extra parameter to your URL:

    tp-open-in-device-browser=1

    The URLs below will open in the embedded app browser:

    • http://www.website.com/file.pdf?id=1
    • http://www.website.com/file2.pdf

    And these will open in the device browser:

    • http://www.website.com/file.pdf?id=1&tp-open-in-device-browser=1
    • http://www.website.com/file2.pdf?tp-open-in-device-browser=1

    2.4. Integrate embedded web content

    Embedded content will always be available, even when a user is offline.

    All local content, including assets, JavaScript, etc., should be placed in a WebResources folder within the folder where your InDesign book or document is located. The folder will be created by the plug-in automatically. Note that the contents should not be zipped, and should be placed there as is. You can organize several embedded hyperlinks by creating different subfolders in the WebResources folder.

    Once you have copied all your html content and assets to that location, enter the Destination URL in the hyperlink field as shown below:

    webresource://index.html 
    webresource://subfolder/index.html

    2.5. Custom URL schemes

    Twixl Publisher supports a wide range of custom URL schemes for triggering specific functions in your apps. Check the article below for more details about this:

    2.6. Mail link

    You can create a hyperlink that links to an email address with an optional subject. Tapping such a link in the app will open a mail popup window to that email address and optional subject. Once the e-mail has been sent, the app returns to the foreground.

    Mail Hyperlink

    TIP:

    For more advanced info about mail links, see this article: Mailto hyperlinks

    IMPORTANT NOTE:

    If you want to turn text information into a hyperlink, it may seem logical to select the text in the text block, then turn it into a hyperlink. Depending on the point size of your text however, you may decide to place a transparent rectangle on top of the text and attach the hyperlink to that, so you can be sure the tap target is big enough (Apple recommends a minimum size of 44 x 44 pixels for such targets).