Skip to main content
Skip table of contents

Link between Scroll Documents

Scroll Documents is only aware of versions within its own document. If you want to manage links between different documents, this article outlines some methods to do so.

Your approach depends on your publishing method.

Publish to Scroll Viewport or Scroll HTML Exporter

If you're publishing your content to Scroll Viewport (for an online help center) or exporting it as HTML, you can leverage a feature called Context keys:

  • What are Context keys? Context Keys generate stable, persistent links to your pages. These links remain valid even if the page title changes or the page is moved within your document. This ensures that your links always direct users to the correct content.

  • Linking to the latest version: To link to the most up-to-date version of a page in another Scroll Document, create a Context key with the version parameter set to "Latest". This ensures the link to always point to the newest version.

  • Linking to a specific version: If you need to link to a particular version of a page, create a Context key specifically for that version. This ensures the link always directs users to the intended version, even if newer versions are created.

To learn more about Context Keys and how to use them, see: Assign Context Keys

Publish to Confluence

If you're publishing your content to a Confluence space, especially if you're combining versions, variants, and translations from different Scroll Documents into a customized manual, you'll need a slightly different approach:

  • Add links after publishing: Instead of linking pages from other Scroll Documents while you're still authoring content, we recommend waiting until after you've published the relevant versions to your target space. Once all the needed versions are published, you can then add standard Confluence page links between the pages in the target space.

  • Be mindful of updates: If you update the published documentation in the target space using the Scroll Documents publishing feature, be aware that any manual linking changes you made will be overwritten. This is because Scroll Documents republishes the entire page tree, undoing your manual link updates.

To learn more about publishing to Confluence, see: Publish to Confluence

This approach also applies if you plan to publish the target space to Scroll Viewport.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.