Problem/Motivation

While a tour takes visitors through various steps, the visitors have to remember the steps so that they can replicate those steps later. This places a cognitive load on the visitor or forces them to take notes. It would be good if they had the option at the end of the tour to pop the tour points up in a separate window that they can refer to while actually doing the task which was trained by the tour.

I am tagging this as accessibility due to the cognitive load issue.

Steps to reproduce

Steps:
1. As a visitor, go through a tour
2. Arrive at the last stop on the tour

Desired result (option one): Three buttons:
Previous
End tour
List steps in new window

Desired result (option two): Two buttons:
Previous
End tour

and a check box:
List steps in new window

Current result: Two buttons:
Previous
End tour

Proposed resolution

On the last stop of a tour, add a button "List steps in new window". Clicking that button pops up a resizable, positionable browser window listing all of the tour steps.

Or, on the last stop of a tour, add a check box "List steps in new window". Checking that box before clicking End Tour pops up a resizable, positionable browser window listing all of the tour steps.

Remaining tasks

Decide which option to use.

User interface changes

API changes

Data model changes

Issue fork tour-3471088

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

Comments

charles belov created an issue. See original summary.

charles belov’s picture

Title: Add a button at the end to open a tour recap in a separate window » Enable opening a tour recap in a separate window

smustgrave made their first commit to this issue’s fork.

smustgrave’s picture

Oops not working on this one, wrong ticket.

smustgrave’s picture

Status: Active » Postponed

Correct me if I'm wrong but for this to work we would need something like #3469330: Add an "alt text" to tour tips describing the situation and the highlighted element added?

Else that overview page would just be

title
body

Excluding selector value because I imagine that wouldn't be useful to anyone.

charles belov’s picture

smustgrave’s picture

Status: Postponed » Active

Blocker landed.

Decided we will stay using the label (now title) + body field, with the assumption the site admins are using descriptive titles.

thejimbirch’s picture

With the alt text approach, I feel like you would basically have to write the tour twice.

An alternative approach could be to parse the tour yaml file completely. Looking at a simple tour:

langcode: en
status: true
dependencies: {  }
id: seo
label: SEO
routes:
  -
    route_name: entity.dashboard.canonical
    route_params:
      id: seo
tips:
  seo_dashboard:
    id: seo_dashboard
    plugin: text
    label: 'SEO Dashboard'
    weight: -10
    position: 'auto'
    selector: null
    body: '<p>This dashboard gathers all the SEO-related features of Drupal with descriptions and links to configuring them.</p>'
  dashboard_section:
    id: dashboard_section
    plugin: text
    label: 'Dashboard Section'
    weight: -10
    position: 'auto'
    selector: .block-dashboard-text-block
    body: '<p>In each of these sections, you will find links to the installed SEO feature with instructions on how to use them.</p>'
  guided_tour:
    id: guided_tour
    plugin: text
    label: 'Guided Tour'
    weight: -10
    position: 'auto'
    selector: null
    body: '<p>Let''s continue the tour by visiting each of the SEO features of the site. First up, the <a href="/admin/config/search/seo-checklist?tour=1">SEO Checklist</a>.</p>'

You could loop through the tips and output something like this:

<h2>tip.*.label</h2>
tip.*.body
thejimbirch’s picture

Drupal core also has Help Topics. Could that be part of the solution?

charles belov’s picture

+1 for parsing the yaml tour as it ensures the steps and labels are in sync and no duplicate effort.

smustgrave’s picture

Actually a -1 for that approach.

1. We have removed all tours from the contrib module and placed into recipes
2 The yml could easily not match what's in the database so what appears in the yml could be different then what appears on the actual tour.

charles belov’s picture

Then could the separate window could be generated from the database? The source doesn't matter; what matters is that it be the same source.

smustgrave’s picture

StatusFileSize
new47.88 KB

@thejimbirch we actually dropped the alt idea. We tweaked the tip form some to make it clear that site builders really should be using descriptive titles. With that assumption we can use title and body. But do need to determine where this link should go

Don't want to distract from the actual content so think at the bottom probably would be best

Thought about a hot key but people may not know about it then. But rough idea, probably would shrink the text and change to "View full tour"

test

thejimbirch’s picture

Nice idea. Maybe a external link style icon next to the close icon with the hover/title text you have there?

smustgrave’s picture

Status: Active » Needs review

  • smustgrave committed ccd3d802 on 2.0.x
    feat: #3471088 Enable opening a tour recap in a separate window
    
smustgrave’s picture

Status: Needs review » Fixed

Going to go ahead and add this.

Now that this issue is closed, review the contribution record.

As a contributor, attribute any organization that helped you, or if you volunteered your own time.

Maintainers, credit people who helped resolve this issue.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.