Using custom URL schemes in Twixl Publisher apps

Luk Dhondt InDesign

Sometimes you want to be able to e.g. trigger navigation in a Twixl publication from a web viewer, so that tapping a link in that web viewer will navigate to a specific page in the publication.

Or in the infoPage of your kiosk (the HTML-based content area at the top), you want to add a link that triggers the Subscription purchase window or the Entitlements sign-in form for existing subscribers.

Twixl Publisher supports a number of custom URL schemes can be used in a web viewer, a web overlay, the kiosk info page, the kiosk info cell, in the entitlements dialog and the embedded web browser.

Here’s an overview of the different actions that can be triggered:

Page link

If you want to add a link to a page in your publication from within a web viewer or web overlay window, you can do so by creating an HREF like the one below:

tp-pagelink://{article_name}/{page_number}

An example would be:

<a href="tp-pagelink://TOC/3">

Show/hide toolbar

tp-toolbar://hide

Hides the toolbar with the Table of Contents icon, and optional sharing and bookmarking icons from a web viewer and web link.

tp-toolbar://show

Displays the toolbar with the Table of Contents icon, and optional sharing and bookmarking icons.

tp-toolbar://toggle

Toggles the current view, whether visible or invisible.

Go to the store overview

tp-store://show

Returns to the store overview window – will only work with web viewers in multi-issue apps.

Close the current window

Available in a web overlay, an embedded web browser – the one triggered by tapping a hyperlink, the kiosk infoPage.html and the Entitlements dialog.

tp-close://self

Closes the current window.

Show the kiosk info page

Available in the kiosk info cell – infoCell.html – and the Entitlements dialog

tp-info-page://self

Displays the infoPage.html window.

Show the subscriptions window

Available in the kiosk info cell – infoCell.html

tp-subscriptions://self

Displays the subscriptions window.

Show the entitlements sign-in form

Available in the kiosk info cell – infoCell.html – and the Entitlements dialog

tp-entitlements-signin://self

Triggers the entitlements sign-in form.

Show the entitlements register form

Available in the kiosk info cell – infoCell.html

tp-entitlements-register://self

Triggers the entitlements register form. Note that this will only work if the entitlements server provides a “register” action.

Tweet this article: Using custom URL schemes in Twixl Publisher apps

Share this post to your network.

Download the free trial of Twixl Publisher

Start using Twixl Publisher immediately, preview the result on your own device, share your creations with a colleague or client, get started!
Need any help? Visit our documentation site.

Download the trial Check out the documentation today

× Free trial/download