> For the complete documentation index, see [llms.txt](https://docs.correlaid.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.correlaid.org/wiki/infrastructure/moodle/moodle-user-tours.md).

# Moodle: User tours

A user tour is a short step-by-step guide that appears directly on a Moodle page. Each step highlights one element of the interface and explains it in a pop-up. User tours are useful for onboarding new course participants. The tour usually starts automatically on the first visit. Here is an example:

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2F2BbeMnHLyCN77Z8AF7eU%2F00_ut_example.png?alt=media&amp;token=aeb9f09c-5091-4df1-8f12-15b045d71367" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**Requirement:** Only site administrators can create user tours (= you need admin rights).
{% endhint %}

## Finding the tours

Path: *Site administration > Appearance > User tours*

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2FxGoIDhl4zrUQLDgOPCXZ%2F01_ut_navi.png?alt=media&amp;token=1a2e53c0-fa20-4fd0-baa6-3b9ce8cdda73" alt=""><figcaption></figcaption></figure>

The "Tours" page lists all existing user tours and their status (enabled or not). The tours at the bottom of the list were created automatically by Moodle and are disabled (crossed-out eye icon).

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2FAntDWAGDmQYainkmHGVO%2F02_ut_list.png?alt=media&amp;token=103e3419-ac66-489b-8d02-b5364aff6d2b" alt=""><figcaption></figcaption></figure>

Each tour is linked to one URL pattern. If you want tours on two different pages of a course (e.g. the course overview and the first lecture), you need two separate tours.

Since CorrelAid courses share a similar structure, you can reuse existing tours: duplicate them (two-squares icon), then edit them (pen icon).

## Adapting a duplicated tour

When you duplicate a tour, you need to adjust several things:

#### 1. Tour settings (klick the pen icon)

* **Name** and **Description**
* **Apply to URL match**, e.g. `/course/view.php?id=123`. `%` works as a wildcard.
* **Filters:** Course or Category, to show the tour only in specific courses
* **Tour is enabled:** check that it is switched on

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2FxKn19O3GsgddhsU8HJ1t%2F04_ut_ut_edit.png?alt=media&amp;token=515696db-1b03-4100-8401-8a2ba7e5187d" alt=""><figcaption></figcaption></figure>

This page lists all steps of the tour. You can edit, delete or add steps.

#### 2. Tour steps (click the tour name in the list)

This page lists all steps of the tour. You can edit, delete or add steps.

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2FgH8SwtH6w9sDNANJkBE9%2F05_ut_ut_steps.png?alt=media&amp;token=891d52c6-d75b-4438-a39c-39ec61889b46" alt=""><figcaption></figcaption></figure>

The screenshot below shows the edit form of the step "Inhaltsverzeichnis" (table of contents) in the tour "CorrelAid\_DatenKommunizieren\_BLOCK\_Kursübersicht".

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2F2jVf3NVr5guEwb28v2jM%2F06_ut_ut_steps_edit.png?alt=media&amp;token=0c80c533-7ff8-48cf-9f22-7d11108b99e2" alt=""><figcaption></figcaption></figure>

* **Target type (Zieltyp):** Choose between "Display in middle of page", "Block" or "Selector" ("Auswahl" in the German interface, as shown in the screenshot). With "Selector", the step points to a page element defined by a CSS selector.
* **CSS selector:** Required if the target type is "Selector". It must identify a *unique* element on the page. To find it, right-click the element in the browser, choose "Inspect", select the element the pop-up should point to and look for an ID or class. This can be tricky. An AI chatbot can help, but test the result in the tour.
* **Title:** heading of the pop-up
* **Content:** explanation text

## Testing

You can test the tour as often as you like: click the question mark on the course page (in the bottom right corner) and select "Reset user tour on this page" ("Tour erneut anzeigen" in the German interface).

<figure><img src="https://2365861684-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-Lvg_oIb4oZtCuInS01x-887967055%2Fuploads%2FL68yyeuBMKWAt5IAJUQP%2F07_ut_test.png?alt=media&amp;token=3660de02-760e-4079-ad71-ea517149cff6" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.correlaid.org/wiki/infrastructure/moodle/moodle-user-tours.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
