Knowledge Base

Guides

Guides are individual sections focusing on one aspect of your brand. Guides will be available as separate tiles on the Brand Guidelines overview page. You can set up guide covers to give each tile an individual and distinctive look.

How to create a guide?

  1. Go to Brand Guidelines and click the button.
  2. Enter a title for your new guide and click Create.

How to modify the title of a guide?

  1. Go to Brand Guidelines.
  2. Hover over the guide for which you want to change the title and click the icon.
  3. Click Edit title and modify the title in the Guide title box.
  4. Click Save to save the changes.

Guide visibility

For each guide the visibility needs to be set up. By default guides are only visible to users with the Manage Guidelines permission. This allows editors to first create and manage the content of a guide before making it available to all users. There are four types of visibility.

Private
Guides with this visibility can only be viewed and edited by the creator of that guide and other users with the Manage Guidelines permission. On the guide overview page you can recognize these guides by the icon below the thumbnails. When you open a guide and see the icon in the top bar, you know it is only visible to editors.

Specific users

The Specific users visibility option is only available for the Advanced Brand Guidelines package.
Guides with this visibility can be viewed and edited by the specified permission profiles, user groups and users. On the guide overview page you can recognize these guides by the icon below the thumbnails. When you open a guide and see the icon in the top bar, you know it is visible to specified permission profiles, user groups or users only.

The normal Brand Guidelines permissions still apply. The specified users still need to have the View Guidelines permission in order to view the guide and its content.

Depending on your portal setup the Specific users visibility option may not be available.

All users
Guides with this visibility can be viewed by all users who have access to view Brand Guidelines. On the guide overview page you can recognize these guides by the icon below the thumbnails. When you open a guide and see the icon in the top bar, you know it is visible to all users who can view Brand Guidelines.

The normal Brand Guidelines permissions still apply. The users still need to have the View Guidelines permission in order to access and view the content of a guide set to the All users guide visibility.

Public

The Public visibility option is only available for the Advanced Brand Guidelines package.
Guides with this visibility can be viewed by all users. This also includes external users who do not have an account with the portal. On the guide overview page you can recognize these guides by the icon below the thumbnails. When you open a guide and see the icon in the top bar, you know it is a public guide.

Depending on your portal setup the Specific users visibility option may not be available.


Click for visual walkthrough

How to make a guide visible to users?

By default guides are only visible to editors. For each individual guide the guide visibility needs to be set up. Follow the steps below.

  1. Go to Brand Guidelines.
  2. Hover over the guide for which you want to change the guide visibility, click the icon and click Guide visibility.
  3. Click the Change dropdown and select Specific users.
  4. Use the search bar to search for the permission profile, user group or user account that is allowed to view the guide. Hover over the name and click the icon. Alternatively, you can click the Change dropdown and select All users to make the guide visible to all users.
    Depending on the setup of your portal this switch may not be available.

  5. (Optional) Repeat the previous step to add other permission profiles, users groups or users.
  6. Click Save to save the changes

The guide is now visible for the selected permission profiles, user groups, users and for all users who can manage guides.

By setting the visibility for a guide, the pages of that guide do not automatically become visible as well. Pages still need to be published before they become visible.

How to hide a guide for users?

Follow the steps below to hide a guide.

  1. Go to Brand Guidelines.
  2. Hover over the guide you want to hide, click the icon and click Guide visibility.
  3. Deselect all the selected permission profiles, user groups or users. Hover over the name and click the icon. If the guide visibility is set to All users or Public, open the Change dropdown and select Private in order to hide the guide for all users.
    Depending on the setup of your portal these options may not be available.
  4. Click Save to save the changes.

The guide and the published pages that belong to this guide can now only be accessed by editors. It will no longer be visible to the deselected users with access to Brand Guidelines.

How to make a guide publicly available?

Public guides can be viewed by all users. This also includes external users who do not have an account for the portal. Follow the steps below to set a guide to public.

  1. Go to Brand Guidelines.
  2. Hover over the guide you want to make public, click the icon and click Guide visibility.
  3. Open the Change dropdown and select Public.
  4. Click Save to save the changes.

The guide is now publicly available and can be shared with users who do not have an account in the portal. See Sharing guides and pages to find out how you can share guides.

How to view the live version of a guide?

Do you want to check how a guide looks like on the user side? Follow the steps below to check the live version of a guide.

  1. Open the guide that you want to see live.
  2. Click the icon in the top bar and click View live version.

The live version of your guide will open in a new browser tab. You will only see the pages that are currently published.

Guide covers

With guide covers you can set up a cover image for your guides. This allows you to create a distinguishable look and feel for each guide making sure your users can easily find the content they need.

How to set up a guide cover?

  1. Go to Brand Guidelines.
  2. Hover over the guide for which you want to set up a guide cover, click the icon and click Set Guide Cover.
  3. Filter or search for the asset you want to use, select it and click Add media.

How to change a guide cover?

  1. Go to Brand Guidelines.
  2. Hover over the guide for which you want to change the guide cover, click the icon and click Set Guide Cover.
  3. Filter or search for the asset you want to use, select it and click Add media.

How to delete a guide cover?

  1. Go to Brand Guidelines.
  2. Hover over the guide for which you want to remove the guide cover and click Remove Guide Cover.
This action is permanent and cannot be undone.

How to delete a guide?

  1. Go to Brand Guidelines.
  2. Hover over the guide you want to delete and click Delete guide.

Learn more