Slicer Tutorial Maker

The Slicer Tutorial Maker is an extension to 3D Slicer to streamline the creation of 3D Slicer tutorials in multiple languages. The sections below provide a user guide to the tool.

Documentação em Português Documentación en Español

Installation (Using Extension Manager)

• Install 3D Slicer 5.9.0-2025-01-28 preview version or latest stable available
• Go to the "Extension Manager" and search for "TutorialMaker"
• Click to restart to get the extension loaded
• Proceed to How to use Tutorial Maker

Installation (Manually)

Follow these steps if you want to get the latest version of the extension before the preview build (which occurs in the morning ~9 EST).

• Install the latest 3D Slicer Stable Release or 3D Slicer Preview Release

• Open the Tutorial Maker repository on GitHub

• Clone the green button Code' and select the option 'Download ZIP' as displayed in the image below to download the file 'TutorialMaker.zip' on your computer

• Unzip the 'TutorialMaker.zip' archive to access the 'TutorialMaker-main' directory

• Windows users :

  1. Start 3D Slicer
  2. Drag and drop the TutorialMaker folder to the Slicer application window
  3. A first pop-up window, 'Select a reader,' appears. Select 'Add Python scripted modules to the application' and click OK.
  4. A second pop-up window appears to load the Tutorial Maker module. Click on 'Yes'.

• MacOs users:

  1. Start 3D Slicer
  2. Select 'Edit' in the main menu
  3. Select 'Application settings'
  4. A 'Parameters' window appears: select 'Modules' in the left panel
  5. Select the file 'TutoriaMaker.py'
  6. Drag and drop the file TutorialMaker.py located in the sub-directory 'TutorialMaker-main/TutorialMaker/'into the field 'Additional module paths' and click on OK to restart Slicer

How to use Tutorial Maker

• Select the 'Tutorial Maker' module from the 'Utilities' category in the list of modules in Slicer

Important

Before starting this tutorial, switch Slicer to Full-Screen mode and set the font size to 14pt to ensure the screenshots are easy to read.

• Select FourMinuteTutorial
• Click Run and Annotate

Annotation Tool

• The screenshots will appear on the left
• Each screenshot includes a title section (green arrow) and a Comments section (red arrow)
• Select one of the three annotation tools
• After selecting a tool, specify the style and the text of the annotation
• Then click on the element that will receive the annotation

Warning

For people who have epilepsy, the screen will blink for each screenshot.

• After creating all annotations, click on the save file

The Screenshots with Annotations are now saved in the Module folder under Outputs;