URL schemes for navigation in a Twixl publication

Luk Dhondt InDesign

A number of custom URL schemes can be used in a web hyperlink, a web viewer, a web overlay, the embedded web browser, etc.

(Available in a hyperlink, 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 <a>href="tp-pagelink://TOC/3"></a>
Hyperlink

In a publication-based workflow, it is relatively easy to create page links to another document (article) in the book file. When working in an article-based workflow, defining page links can be a bit harder. That's why in Twixl Publisher 4.0, a number of new URL schemes for relative article and page navigation have been added.

Go to the next article

tp-next-article://show

Go to the previous article

tp-previous-article://show

Go to the first article of a publication

tp-first-article://show

Go to the last article of a publication

tp-last-article://show

Go to the next page in an article

tp-next-page://show
If at the last page of an article, you'll go to the next page in the following article.

Go to the previous page in an article

tp-previous-page://show
If at the first page of an article, go to the last page of the previous article.

Go to the first page of an article

tp-first-page://show

Go to the last page of an article

tp-last-page://show

Show/hide toolbar

(Available in a web viewer and web link)

Hide the toolbar

tp-toolbar://hide
Hides the toolbar with the Table of Contents icon, and optional sharing and bookmarking icons.

Show the toolbar

tp-toolbar://show
Displays the toolbar with the Table of Contents icon, and optional sharing and bookmarking icons.

Toggle the toolbar

tp-toolbar://toggle
Toggles the current view, whether visible or invisible.

Show bookmarks

(Available in a hyperlink, a web viewer or a web overlay)

tp-bookmarks://show
When the tp-bookmarks://show url is triggered, it will:
  • show the title bar
  • open the TOC popup highlighting the bookmarks.
  • (Available in a hyperlink, a web viewer or a web overlay)

    tp-search://<search_term>
    When the tp-search:// is triggered, it will:
    • show the title bar
    • open the TOC popover
    • activate the search function
    • perform a search with the given search term
    If no search term is provided, it will just activate the search function

    Close the current window

    (Available in a web overlay, an embedded web browser - i.e. the one triggered by tapping a hyperlink -, the kiosk infoPage.html and the Entitlements dialog)

    tp-close://self
    Closes the current window.

    Opening a hyperlink in the device browser

    (available for hyperlinks)

    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

Tweet this article: URL schemes for navigation in a Twixl publication

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