> For the complete documentation index, see [llms.txt](https://olab4.gitbook.io/help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://olab4.gitbook.io/help/basic-topics/maps.md).

# Maps

## Maps overview

A map is a set of Nodes, joined together by Links. In its simplest form, the user will start at the beginning of a Map, move through the Nodes until they reach the end of the map. Each Node represents a new page in the story.

![Linear map example](/files/-Lp405efS2KivdNcHjzP)

Some maps are linear, like a novel, where you read through from beginning to end.

## Create a new Map

To get started, once you have logged in to the OLab Designer at <https://demo.olab.ca/designer>, you will see a list of existing Maps.&#x20;

![](/files/2mjKkftyi64OY04e6lyJ)

You can create a Map manually or you can start with a template to speed things up.&#x20;

The first thing you should do is to rename your Map, using the title area here:

{% hint style="warning" %}
Insert screenshot from main Designer panel when available.&#x20;
{% endhint %}

## Map Structure

As shown in the first example up above, the commonest pathway design is linear. But a Map can have any pathway layout that you want.&#x20;

![Hub and spoke map](/files/-Lp41o9CcEdbadtUIOoF)

Some maps have a central starting point but you can visit the pages in any order, like a textbook or reference tome.

![](/files/-Ls_ic_78eItUXKv6SDX)

Some maps are like choose-your-own-adventure books. Depending on the choices you make, you are lead to different choices and consequences.

A Map usually has a single starting point, the Root Node (indicated by the yellow star), but there can be more than one in some designs.

A Map commonly has multiple possible endings, not all of which are happy.

OLab is very flexible. It is entirely up to the map author to decide what is a good pathway or design, how many endings there should be and how many constraints to place on the user’s choices. OLab will allow any learning design or pathway.

## Maps as Containers

Historically, the Map in OLab, and its predecessor OpenLabyrinth, was the container which held together Nodes, Links, Questions, Files, Counters etc. A Map could be exported from one OLab server to another -- all of its objects would be moved with it.

This is still generally true in OLab4. But we have also introduced the concept of [Scoped Objects](/help/basic-topics/objects.md), which means that the objects contained within a Map can be more easily reused.

## Map Attributes

To make a Map more useful, there are several attributes. These are the **Map Details**, which can be found under the My Map menu at the top of the Designer page. Not all of these attributes make a difference to how the Map is played: some of them simply describe what the Map is for or how it was created.

![Basic Details](/files/-Ls_ja1pPZV-J3DCs-8s)

### Map Title

It is helpful if this suggests the purpose of the Map, but the author can be as creative as they wish.

### Map Description

A short paragraph, describing the contents or the purpose of the Map. This description can be quite long but only the first paragraphs are read in most lists of Maps.

### Map Keywords

You know how keywords work, surely. It does help to be consistent in their use but OLab does not enforce this.

### Map Creator

Author's name. Not editable at present

There is also a secondary set of tabs on the Map Details editor, where you can change how the map plays, add notes for other authors and a few more advanced details.&#x20;

![Appearance tab](/files/-Ls_kOICatBCBR_LvnSL)

### Map Theme

{% hint style="warning" %}
\*\* not fully tested yet. This depends on Themes as Scoped Objects
{% endhint %}

### Map Access

{% hint style="warning" %}
\*\*more info about open/closed/private/keyed maps and how this relates to Roles, Courses, ACLs etc.
{% endhint %}

![Content Details](/files/-Ls_q65AuuaaF66vPcaB)

### Author Notes

Notes about the learning design, customizations to how the map works or special coding and scripts.&#x20;

### Map Content Completion

These are also the map publishing details. These are mainly for use when publishing maps to a repository. &#x20;

![Advanced Details](/files/-Ls_qI9L5RMzAL8nhxPt)

### Map xAPI Reporting

Toggle for xAPI realtime or not. This can slow down map performance so be cautious if multiple users are expecting to play this map simultaneously.&#x20;

{% hint style="warning" %}
\*\* In OLab 4.6 this is being deprecated. If you want this function to continue, we will need funded projects to support it being properly integrated into OLab4.6
{% endhint %}

###

### Map isTemplate

Toggle on if this map is to be used as a Template in the creation of other maps. It will not then show in the list of playable maps.&#x20;


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://olab4.gitbook.io/help/basic-topics/maps.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
