Internal links in ScreenSteps use data-attributes to expose the ID of the article being linked to. A typical URL might look like this:
<a href="/a/24-title" data-internal-link-id="24" data-internal-link="lesson" target="_blank">My link</a>This table explains the meaning of these items:
| Value | Description |
|---|---|
data-internal-link-id
|
This is the ScreenSteps id of the object that is being linked to. |
data-internal-link
|
This is the type of object that is being linked to. |
data-internal-anchor
|
This is an (optional) anchor name for the target |
data-internal-link
Because of some legacy content, data-internal link can have a variety of values. The table below will show you what you should use to resolve links using the API.
| data-internal-link value | API endpoint |
|---|---|
article, lesson, or step
|
The data-internal-link-id will be pointing to an article (or a step inside an article). lesson is deprecated. |
chapter or section
|
The data-internal-link-id will be pointing to a chapter in your site. section is deprecated. |
manual |
The data-internal-link-id will be pointing to a manual. |
Article versions saved prior to April 11, 2025 will have a different format for the href value then is shown at the start of this help article. It will be prefixed with ../../. These values were not accurate and did not actually point to the article on the website. The new format is an accurate relative URL.
<a href="../../52/l/24-title" data-internal-link-id="24" data-internal-link="lesson" target="_blank">My link</a>
0 Comments
Add your comment