Using the Briefing Panel Editor

The Briefing panel is where you add the core learning content for your lab. This guide covers how to use the editor to add text, media, code blocks, and links, and how to use the newer building blocks — components and templates — to structure your content.

Overview

The Briefing panel contains the core learning content for each lab. It provides users with the essential background knowledge they need before diving into hands-on tasks. This could include an overview of the topic, core concepts, video examples, images, and so on.

For example, in a lab on SQL injection, the Briefing panel should explain what SQL injection is, how attackers exploit it, how to identify and prevent it in code, and relevant industry examples. The goal is to ensure the user understands the why and how behind the subject before they begin practical work. Think of it as the user's learning foundation — concise, clear, and focused.

The Briefing panel:

• Is a markdown editor that supports rich media functionality, including headers, links, quotations, in-line code, and code boxes, as well as features such as image and video upload.

• Provides an easy-to-use WYSIWYG (What You See Is What You Get) editor toolbar that is always available at the top of the page when editing.

• Supports components and templates — reusable building blocks such as cards, callouts, alert banners, and ready-made sections like requirements and prerequisites.

• Is designed to mimic what the panel will look like on the Immersive One platform.

Using the Briefing Panel Editor

To use the Briefing panel editor:

1. On the Lab properties pane, click Briefing.

2. On the Briefing page, click Edit to customize the briefing panel.

3. Provide the core learning content for each lab using the guidelines described in Briefing Panel Writing Guidance. You can add headings, lists, blockquotes, and links; add in-line code and code blocks; upload images and videos; and insert components and templates.

4. Click Save changes.

Two ways to add content

You have two ways to add content while editing.

The toolbar. The WYSIWYG toolbar sits at the top of the editor and is always available. Use it for text formatting and media — headings, lists, blockquotes, links, code, images, and videos.

The + menu and the / command. For components and templates, click the + button to open the component menu, or type / in the editor to bring up a command window. Both open the same library. With the / command, start typing a component name (for example, /callout or /alert) to filter the list, then select it to insert it at your cursor.

Editor features

Headings

You can add headings to break up your text and to organize it into sections.

Lists

Standard bulleted lists and ordered lists are supported.

Blockquotes

Blockquotes allow you to break up text and insert stylized quotes.

Links

Links allow you to specify text that has an embedded URL that can be clicked. This is useful if you have external files or documents that you want the user to interact with as part of a lab.

Note: It is the responsibility of the Org Admin who creates the briefing to ensure that all links that are included are safe and/or approved for your users to access.

Code blocks and in-line code

The editor supports both:

• In-line code, for providing examples of small commands. To add in-line code, on the editor toolbar, click the Inline Code button.

• Code blocks, for multi-line snippets. We support a vast array of languages, from C to YAML. To add a code block, on the editor toolbar, click the Code Block button.

Images

You can easily upload images. To do so:

1. On the editor toolbar, click the Upload Image button.

2. In the dialog box that appears, choose your image from your local computer.

Note: Image uploads are restricted to .png, .jpg (or .jpeg), .gif, or .webp format.

Once an image has been selected, the Add image dialog box appears, which lets you review the image and add alt-text. Alt text (alternative text) describes the content or function of an image. It's important for accessibility (screen readers) and ensures information isn't lost if the image doesn't load. Use clear, concise descriptions relevant to the image's purpose.

If you upload a large image, you can also crop it using the Crop image tool to select the part of the image that you want for the lab.

Videos

The editor also allows you to upload videos. To do so:

1. On the editor toolbar, click the Upload Video button.

2. In the dialog box that appears, choose the video to upload from your local computer.

Note: Video uploads are restricted to .mp4 or .webm format and a maximum size of 1000 MB, along with a video subtitles track limit of 5 MB.

When you have selected your video, it is uploaded to our platform and a Video settings dialog box appears, where you can configure it:

• You can preview your video and add a Title that can be read by assistive technologies (similar to alt-text for images). We recommend adding a title for accessibility purposes.

• You can upload optional subtitles via a .vtt file, which provides captions for your video.

• If you do not have a .vtt file, you can manually add a transcript in the Transcript text box. This transcript is read for accessibility purposes on the platform when a user plays the video.

Note: If you remove your video from the briefing panel, the video file will be deleted.

Components

Components are individual building blocks you insert from the + menu or the / command and then fill in yourself.

• Horizontal rule. A simple dividing line. Use it to separate one part of a briefing from the next without adding a heading.

• Table. A grid of rows and columns. Good for anything that reads better lined up — a sequence of commands, a list of parameters, or a before-and-after comparison.

• Abbreviation / Acronym. Defines a term once so learners aren't left guessing. Enter the short form and its full meaning.

• Card. A contained block of content that stands out from the body text. Use cards to group related information so it reads as one unit.

• Callout. A highlighted section for a note, tip, or aside — flag something without interrupting the flow of the main text.

• Alert banner. A prominent message with a status (success, warning, info, or error). Use it for things learners shouldn't miss, such as a warning about a destructive step.

Templates

Templates are ready-made sections built from the components above, styled to match how our labs are laid out. They give you a consistent starting point so you don't rebuild the same section in every briefing. Add a template the same way as a component — from the + menu or the / command — then edit the content to fit your lab.

Template	What it's for
Requirements	A structured section listing what a learner needs to complete the lab.
Prerequisites	A section covering the knowledge or setup a learner should have first.
Real-world example	A section framing the lab against a real-world scenario.

Real-world example template

Tips

• Type / and the first few letters of a component to insert it without leaving the keyboard.

• Use alert banners sparingly — they carry the most weight when reserved for things that really matter.

• Start requirements and prerequisites sections from their templates rather than building them by hand, so they stay consistent with other labs.

• Add alt-text to images and a title or transcript to videos so briefings remain accessible.

Troubleshooting

Templates cover the common lab sections (requirements, prerequisites, real-world example); other custom sections need to be built from individual components.