You can create hyperlinks in articles that jump to websites, other articles, and more. You can create hyperlinks in HTML-based articles or use the Hyperlinks panel or the Buttons panel in InDesign-based articles.
For InDesign articles, not all InDesign button actions and hyperlink types are supported. Hyperlink overlays are supported in scrollable frames and slideshows, but not in other overlays.
Linking to articles
Use the “navto” format to link to other articles or collections.
When creating either a button or hyperlink, you can replace “http://” with “navto://” in the URL field. Use the Article Name or Collection Name value as it appears in the metadata, not the Title value.
The following navto formats are valid:
Adding #n specifies a page number. The first page of a document is 0, so specifying #2 jumps to page 3.
Linking to collections
Using the "openTo" parameter determines whether the target collection opens to the browse page or content view (first item in the collection), overriding the Collection Open Default setting.
navto://collection/topLevelTabletContent (jumps to the top level tablet collection)
navto://collection/topLevelPhoneContent (jumps to the top level phone collection)
navto://collection/topLevelContent (jumps to the top level collection)
goto://ApplicationViewState/library (jumps to initial launch collection)
Linking to articles in context of a collection
If you use navto://collection/[collectionname]/article/[articlename], users can swipe horizontally to view other articles in that collection. If you simply use navto://[articlename], the article does not appear in the context of a collection, and users cannot swipe to view other articles in that collection.
- Navto links are case-sensitive.
- For InDesign source files, any link that specifies a path to an InDesign file is broken when viewed in an app. Use the navto format for linking between articles.
Navto examples in InDesign (Hyperlinks panel or Buttons panel)
navto://biking#2 (jumps to page 3 of biking article)
When you create a URL-based hyperlink or button, you can use the “navto://” URL to jump to a different article.
Jump to another article in HTML source articles
Use the navto format to jump from one HTML article to another using the folder name. Example:
<a href="navto://newsArticle01">See the News Article</a>
You can also navigate to a specific page within an InDesign article by adding the page number after the document name. The first page of the document is 0, and the second page is 1, and so on. Example:
<a href="navto://Cycling#3">Go to Page 4 of the Cycling Article>
By default, URL hyperlinks open within an in-app browser on iOS devices. To create a hyperlink in an HTML article that opens outside the app, use the goto://DeviceBrowser?url= format described in the next section.
Jump to anchor in HTML article
You cannot jump to a specific page within an HTML article, but you can jump to an anchor by typing navto://[articlename]#[anchorname].
To define an anchor in an HTML file, open the HTML file in a text editor. Navigate to the text that you want to act as an anchor, and enclose the text with an anchor tag, such as <a name="part4"></a>.
Use the following goto links to mimic the behavior of various options found within the app interface.
Go to the launch page of the app:
Do the same thing as the Back button:
Do the same thing as the Social Share button:
Do the same thing as the Search option:
Do the same thing as choosing the Settings option in an Android or Desktop Web Viewer app:
Open the mobile browser or associated app instead of using in-app browser for iOS:
Example: <a href="goto://DeviceBrowser?url=https://www.adobe.com">Adobe Website</a>
To make hyperlinks in InDesign-based articles open an external app, you can select the hyperlink or button object and choose "Open in Device Browser" in the Overlays panel.
You can use various navto://relative formats to jump to the next, previous, first, or last article within a collection. For example, a button with a navto://relative/first action jumps to the first article in the collection. Valid formats include first, last, next, previous, current. The reset format is not available in AEM Mobile. You can also jump to a specific article relative to its position in the collection, such as the fifth article.
Example: navto://relative/last (jumps to last article in collection)
Example: navto://relative/last#last (jumps to last page of last article in collection)
Example: navto://relative/4 (jumps to fifth article in collection)
Example: navto://relative/4#2 (jumps to third page of fifth article in collection)
Using the "current" format is especially useful for page navigation. You can use #previous, #next, #first, #last, and you can jump to a specific page, such as #3 to jump to page 4 of the article.
Example: navto://relative/current#previous (jump to previous page in article)
Example: navto://relative/current#last (jumps to last page in article)
Example: navto://relative/current#3 (jumps to fourth page in current article)
In Smooth Scrolling articles, you can use decimals or percentages to jump to a specific position.
Example: navto://myarticle#3.3 (jumps to a specific position in smooth scrolling article that displays the bottom of page 4 and the top of page 5)
Example: navto://myarticle#50% (jumps to the middle of smooth scrolling article)
Example: navto://relative/parent (jumps to the parent view of the current article, similar to the Back button)
In most instances, the navto://relative/parent button functions the same ways as the Back button. If the parent button appears in a target article that is in the same collection as the source article, tapping the parent button would jump up to the collection, whereas tapping the Back button would return to the source article. When linking to an article in a different collection, the parent button returns to the source article, same as the Back button.
At this time, navto://relative/last and navto://relative/4 (article number) are not supported in Android viewers.
This advanced technique is currently supported, but the format might change. To create "deep links" from outside the app, you must publish the target articles and collections. Deep linking does not work in preflight apps.
This deep linking technique works only in iOS and Android apps.
Create a link to an app
Use this format to create a link to an AEM Mobile app from outside the app:
To obtain the Publication ID for the project, go to the Content & Layouts section of the On-Demand Portal (https://aemmobile.adobe.com) and copy the string of characters near the end of the URL.
Create a deep link to a collection in an app
Use this format to create a link to a collection in an app:
This link goes to the collection browse page or to the first item in the collection depending on whether the collection is set to Browse Page or Content View.
Create a deep link to an article in an app
Use this format to create a link to an article in an app from outside the app without collection context:
Use the Article Name, not the Article Title.
Create a deep link to an article in context of a collection
Use this format to create a deep link to an article within the context of a collection (requires apps built after 2015.8 December release):
Use the Buttons panel to create links to websites, to another page, or to another article.
For best results, use the Buttons panel instead of the Hyperlinks panel to create links. The Buttons panel is more flexible and more reliable.
A. Supported actions for hyperlink buttons B. Supported actions for slideshow buttons
Supported hyperlink actions include Go To First Page, Go To Last Page, Go To Next Page, Go To Previous Page, Go To URL, Sound, Video, and Go To Page. Go To Next State, Go To Previous State, and Go To State actions are supported for slideshows.
Do not use the Go To Destination action to jump to a different article. Instead, use the Go To URL action with a “navto” format. See the related section later in this article.
To change hyperlink settings, select the button object, and then specify these settings in the Overlays panel:
Open in App
Display the content in a web view within the viewer. Deselect this option when linking to URLs such as mailto: and tel:.
In InDesign, you can use the Hyperlinks panel to add hyperlinks. Hyperlinks are especially useful for text. If you want a frame to be a hyperlink, consider using the Buttons panel instead of the Hyperlinks panel. Buttons are more versatile and more stable.
To change hyperlink settings, select the hyperlink objects, and then specify these settings in the Overlays panel:
Open In App
Display the content in a web view within the app. Deselect this option when linking to URLs such as mailto:, and tel: that should allow users to leave the app.
Open In Device Browser
Display the content outside the viewer in the mobile device browser, such as mobile Safari on the iPad. Select Ask First if you want a prompt to appear when users tap the link. This option is disabled if Open In App is selected.
The Overlays panel settings are not available for text hyperlinks. You cannot change settings for text hyperlinks; they are set to Open In App by default. However, the viewer includes built-in exceptions for certain prefixes such as itms://, tel:, and mailto:. For these URLs, an external app is opened by default.
For additional details on creating hyperlinks, see Create hyperlinks in InDesign Help.
You can create a link that sends an email message (mailto:), a text message (SMS), or calls a number (tel:) from an article. You can also create links that open the YouTube app or an iTunes song or album. To learn more about the required formats to use for iOS devices, see the Apple URL Scheme Reference.
Whenever you create a link in InDesign to an external app or service, select the button and choose the Open In Device Browser option in the Overlays panel.