Scroll Content Manager
4.6 4.5 4.4 4.3 4.2 4.1 4.0 3.39 3.38 Cloud Data Center
Scroll Content Manager
4.6 4.5 4.4 4.3 4.2 4.1 4.0 3.39 3.38 Cloud Data Center
Breadcrumbs

Assign Context Keys

Context Keys are stable identifiers you assign to pages in your Scroll document. Use them to create reliable links for context-sensitive help in your product, or for sharing links that keep working as your documentation changes.

Before you start

To use Context Keys, you'll need:

Why Context Keys are useful

As documentation grows, its structure changes. Pages get split, merged, or renamed, and any links you've shared can break.

Context Keys solve this. Instead of linking to a page, you link to a key that points to a page. When content moves, reassign the key, every existing link keeps working.

Context Keys are especially useful for:

  • Context-sensitive help in your product.

  • Long-lived links in marketing or customer communications.

  • Deep links that need to survive restructuring.

Create and Manage Context Keys

Context Keys are created in the Document Settings and apply to all versions of a page.

New or updated Context Keys only take effect after you republish your Scroll site.

Open Context Keys settings

To open the Context Keys settings for a document, follow these steps:

  1. Find your document in the Document Library and click its card to open the Document Manager.

  2. Click Settings.

  3. Select Context Keys.

You are in the Context Keys settings for this document, where you can create keys and assign them to pages.

Create a Context Key

A page can have multiple Context Keys, but each key can only point to one page.

Choose keys carefully. Keys can't be renamed after creation, you'd need to delete and recreate them, which breaks existing links.

To create a new Context Key, follow these steps:

  1. Click Add Context Key.

  2. In the Page field, select the page. Use the dropdown or start typing.

  3. In the Key field, type your key. Acceptable characters: a-z, A-Z, 0-9, _, -, +.

  4. Click Create.

The new key appears in your list, showing which versions it applies to.

Edit a Context Key

You can reassign a Context Key to a different page at any time. To edit a Context Key, follow these steps:

  1. Find the key in the list.

  2. Click More actions (•••) and select Edit.

  3. In the Page field, select the new page.

  4. Click Save.

Delete a Context Key

Deleting breaks links. Any existing links using the key will stop working. Reassigning is usually better than deleting.

To delete a Context Key, follow these steps:

  1. Find the key in the list.

  2. Click More actions (•••) and select Delete.

  3. In the dialog, click Delete to confirm.

You can copy a Context Key link to share it or embed it in your product. To copy a link, follow these steps:

  1. In the Context Keys settings or next to a page in the Content Manager, click Get link.

  2. The link is copied to your clipboard.

Use Context Keys in Publications

To create stable links using Context Keys in your Scroll Sites or Scroll HTML Exporter publications, see:

Last updated: