Overview

Primary use cases

Tours have two primary use cases:

• To draw the user's attention to critical components of the interface, especially those elements that might not be immediately obvious
• To guide the user through a workflow

History

Prior to Drupal 11.0 the Tour module was part of Drupal core. In Drupal 10.3 it was deprecated, and then removed. The contributed project https://www.drupal.org/project/tour serves as a replacement.

General principles

The general principles of Tours are:

• Tours are a complement (not a substitute) for good interface design.
• Tour text should follow the Drupal style guide for interface text.
• The tour should start and end in a logical place
• If the tour is intended to illustrate a workflow, it should stay focused on completion of a single task. Avoid providing tangential information.
• If the tour is intended to highlight the UI, it may not be necessary or desirable to include every option for every widget.
• Keep tip content short, preferably 1 to 2 sentences.
• Provide examples to give a deeper understanding of tips context.

Shepherd.js

Tour is based on the Shepherd

Requirements

1. Users must be given 'access tour' permission in order to view available tours.
2. JavaScript must be enabled in the browser

Auto start and navigate between tours

By adding links in your tour body text with ?tour=1 will continue the tour if available on the linked page.

<a href="/admin/structure/views/view/frontpage?tour=1">Auto start the views tour</a>

More information

Guidelines for developing tours