ShaunSocial docs Tourguide plugin
Version 1.1.0
  • 1.1.0 (this version)

Tourguide plugin 1.1.0 / AdminCP

Tours

Admin

This page is for admins: how to write a tour and its steps, and how to put a tour on a page.

Write a tour and its steps#

Last updated: 2026-11-19 · v1.1.0

The list shows each tour's Name and whether it is Active, with Edit, Delete and Steps.

The Tourguide list with one tour, Active Yes, and the Edit, Delete and Steps links, and the Create new button
AdminCP → Plugins → Tourguide → Manage Tourguides with one tour. Screenshot taken 2026-11-19.

Create the tour#

  1. Click Create new.
  2. Enter a Name (up to 255 characters; only admins see it) and leave Active on. A tour that is not active shows nowhere.
  3. Click Submit.

    What you should see: "Tourguide has been successfully created." and the tour in the list.

The Create window of a tour: Name, the Active switch on, Submit and Cancel
The window to create a tour. Screenshot taken 2026-11-19.

Add the steps#

  1. Click Steps on the tour, then Create new step.
  2. Fill in the step:
    FieldWhat to enter
    Languagethe language of the text below. "Select a language to translate for tourguide content only." Write the step in your site's main language first; choose another language later to add its text
    Tourguide Contentthe text of the step, with headings, bold text, links or pictures from the editor. Required
    Targetwhich part of the page the step points at, written as a CSS selector: the name of a page element (nav), a class with a dot (.btn-primary) or an ID with a hash (#header). Required, up to 255 characters. "The tour will not appear if no matching element exists on the page."
    Activeoff: the step is left out of the tour
  3. Click Submit.

    What you should see: "Tourguide step has been created." and the step in the list of steps.

Finding the target

A CSS selector is the name your browser uses for a part of the page. To find one, right-click the part of the page in your browser and choose Inspect; the highlighted line shows its classes (after class=), and you put a dot before one of them. Pick a class that appears only once on the page, and check the tour on the page itself afterwards.

The Edit screen of a step: Language English, Tourguide Content in a text editor with the heading Your shortcuts and one sentence, Target .header-icons-list with its help text, the Active switch on, and Submit
A step: language, content, target and Active. Screenshot taken 2026-11-19.

The list of steps (Steps of: …) shows each step's Target and whether it is enabled. Drag a row by its four-arrow handle to change the order of the steps. Edit changes a step, Delete removes it after a confirmation. Deleting a tour also deletes its steps.

Steps of a tour: two steps with the targets .header-icons-list and .main-content-section, Enable Yes, the Edit and Delete links, and the Create new step button
The steps of a tour, in the order visitors see them. Screenshot taken 2026-11-19.

Put a tour on a page#

Last updated: 2026-11-19 · v1.1.0

  1. Open the layout editor and choose the page the tour is about (see Add, change and remove blocks in the ShaunSocial guide).
  2. Drag Tourguide Block from Available Widgets into the page.
  3. In the block's window, choose the tour in Tourguide. The list shows the active tours. Set Allow Access as for any block, and click Save changes.
  4. Click Save change at the top of the layout editor.

    What you should see: "Layout has been successfully updated." The tour starts the next time someone who may see it opens that page.

The block itself shows nothing on the page; it only starts the tour. Place it on both the Desktop and Tablet and the Mobile layout if the tour should also run on phones, and check that the targets exist in each.

Change log#

Last updated: 2026-11-19 · v1.1.0

Date (GMT+7)SectionWhat changed
2026-11-19manage-tours, place-tourNew page. Its sections were moved here unchanged, with links to other pages updated: "Write a tour and its steps", "Put a tour on a page" (from the former page "Set up and use Tourguide").
2026-11-19manage-tours, place-tourFirst version for Tourguide 1.1.0, written from the 1.1.0 code. The admin steps were read from the code, not run. Screenshots from a demo site running Tourguide 1.1.0 with one sample tour.
2026-11-19allPages reorganised: AdminCP content now has its own pages.