Context-sensitive help means that the help documentation opens to the correct topic automatically, based on your location in the software. This functions through a unique identifier assigned to each page, a Context Key (if you’re using Scroll Content Manager) or a Page Key (if you’re using Scroll Versions). The naming differs, but the concept is the same: a stable identifier that points to a page, so links keep working even when content is moved or restructured.
For context-sensitive help to work, a unique key must be set manually for each page. The key is stored as a content property, so it isn’t visible to readers and doesn’t show up in search results.
Which app do you use? The setup differs depending on whether your content is managed with Scroll Content Manager or Scroll Versions. See the relevant section below.
Set Up a Key
If you use Scroll Content Manager
Context Keys are created and managed in the Document Settings of your Scroll document. For step-by-step instructions, see Assign Context Keys.
If you use Scroll Versions
Page Keys are set up directly on Confluence pages in Scroll Versions. For details, see Use Page Keys.
Scroll Versions compatibility: The Page Key feature in Scroll Sites requires Scroll Versions 3.8.0 or higher.
Use a Key in Scroll Sites
Once you’ve assigned a Context Key or Page Key to a page, you can link to it in your Scroll site. The URL pattern differs slightly depending on which app you use.
Scroll Content Manager (Context Keys):
<site-base-url>/?contextKey=<key>&version=<version>
Scroll Versions (Page Keys):
<site-base-url>/<version>/?contentKey=<key>
If the page is moved or renamed, the link still resolves to the correct page.
Example:
A page published at https://www.example.com/this/and/that/example-page-90407357.html is reachable via https://www.example.com/?contextKey=exampleKey&version=latest , even after the page is moved or renamed.
Keys and variants
If you use variants, link directly to the correct variant of a page by appending the variant to your URL.
Scroll Content Manager (Context Keys):
<site-base-url>/?contextKey=<key>&version=<version>&variant=<variant>
Scroll Versions (Page Keys):
<site-base-url>/<version>/<variant>/?contentKey=<key>
Example:
-
Context Keys:
https://www.example.com/?contextKey=exampleKey&version=latest&variant=default -
Page Keys:
https://www.example.com/this/and/en/?contentKey=exampleKey
Keys and translations
If you use translations (either in Scroll Content Manager or Scroll Translations), link directly to translated pages by appending the language to your URL.
Scroll Content Manager (Context Keys):
<site-base-url>/?contextKey=<key>&version=<version>&language=<language>&variant=<variant>
Scroll Versions (Page Keys):
<site-base-url>/<version>/<language>/?contentKey=<key>
Example:
-
Context Keys:
https://www.example.com/?contextKey=exampleKey&version=latest&language=en&variant=default -
Page Keys:
https://www.example.com/this/and/en/?contentKey=exampleKey
Page Keys with anchors
You can use anchors with Page Keys to jump to a specific section on a page by appending #<myAnchor> to your URL.
<site-base-url>/<version>/?contentKey=<key>#<myAnchor>
Example:
https://www.example.com/this/and/that/?contentKey=exampleKey#MyAnchor
Not supported with Context Keys. Anchors are only compatible with Page Keys in Scroll Versions.