Custom Twixl URL Schemes

Luk Dhondt How-To

As of version 3.4 of Twixl Publisher, a number of custom URL schemes can be used in different types of “HTML content elements”, such as

  • a web viewer
  • a web overlay
  • the embedded web browser
  • the kiosk info page
  • the kiosk info cell
  • the entitlements dialog

Here’s an overview of the different HTML content elements that may be available in a Twixl Publisher-based apps:

Types of HTML content elements

Web viewer

Any rectangle on a page can be turned into a ‘web viewer’ that will display either local (embedded) or remote HTML content.

Web overlay

A web overlay is a modal web viewer that is displayed on top of your page. The web overlay will always be positioned at the center of the page and will add a level of transparency to the rest of the page.

Embedded web browser

When tapping a hyperlink in a Twixl publication, a full-screen browser window is placed on top of the current page.

Kiosk Info Page

An “info page” is a special page in a multi-issue app that can be called on first start-up or by tapping a button in the status bar of the storefront.
Here publishers can introduce readers to their app or provide information about the company.

Kiosk Info Cell

The “info cell” is essentialy the same as an info page, the only difference is the way it is presented to the reader. The info cell is displayed at the top of a store window in grid view.

Entitlements dialog window

If your multi-issue app has support for entitlements, then the entitlements dialog is where e.g. existing print subscribers will be able to enter their user name and password to get access to the digital versions.

Overview of custom URL schemes

Page link

(Available in a web viewer or a web overlay)

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 the toolbar

(Available in a web viewer)

tp-toolbar://hide

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

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

(Available in a web viewer – will only work in multi-issue apps)

tp-store://show

Returns to the store overview window.

Close the current window

(Available in a web overlay, an embedded web browser, the kiosk infoPage.html and the Entitlements dialog)

tp-close://self

Closes the current window.

Show the 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.

Shows the Entitlements register form

(Available in the kiosk info cell – infoCell.html)

tp-entitlements-register://self

Triggers the entitlements register form. This only works if the entitlements server provides a “register” action.

Clear entitlements token

(Available in the kiosk info cell – infoCell.html)

tp-entitlements-clear-token://self

Clears the entitlements token (can be used for testing purposes).

Tweet this article: Custom Twixl URL Schemes

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