Overview of Internal Links in the ScreenSteps API
Internal links in ScreenSteps are special hyperlinks that reference other objects within the ScreenSteps platform, such as articles, chapters, or manuals. These links use specific data attributes to identify the type and target of the link, which is important for resolving and managing content relationships through the API.
- Internal links connect different content objects within ScreenSteps.
- They use data attributes to specify the link's target and type.
- Understanding these attributes is essential for API integration and link resolution.
Key Terms
The following data attributes are used in internal links:
| Value | Description |
|---|---|
| data-internal-link-id | The unique ScreenSteps ID of the object being linked to. |
| data-internal-link | The type of object being linked to (e.g., article, chapter, manual). |
| data-internal-anchor | An optional anchor name for a specific target within the object. |
Understanding data-internal-link Values
The data-internal-link attribute indicates the type of object being referenced. Due to legacy content, this attribute can have several values, some of which are deprecated. The value determines how the API should resolve the link.
| data-internal-link value | API endpoint |
|---|---|
| article, lesson, or step | Points to an article or a step within an article. "lesson" is deprecated. |
| chapter or section | Points to a chapter in your site. "section" is deprecated. |
| manual | Points to a manual. |
- Different values indicate different types of ScreenSteps objects.
- Some values are deprecated but may still appear in legacy content.
- Correct interpretation of these values is necessary for accurate link resolution.
Background: URL Formats and Legacy Content
Internal link URLs have changed over time. Articles saved before April 11, 2025, use a different format, prefixed with ../../. These older URLs may not accurately point to the intended article on the website. The current format uses a relative URL that correctly references the target object.
- Older articles may contain outdated URL formats.
- The new format ensures accurate internal linking within ScreenSteps.