Documentation

Introduction
Interactive Tutorials
Overview
Frequently Asked Questions
Supported operating systems and browsers
Managing your company
- Dashboard
- Company details
- Managing projects
- Generate Screens
- Backup
- Managing publications
- Manage access rights
- Managing workflow (Kanban)
- Extended metadata
- Support
- External Platform Integration
- OpenAI Endpoints
Creating a new presentation
- Managing metadata
- Font size selection
- Style of the lesson
- Fixed or changeable page size
Managing lessons
- Lesson details
Managing assets
- Updating assets
- Uploading assets
- Video and Audio file formats
- Online resources
- Downloading assets
- Asset Repository
- Requests Configuration
Page management
- Navigation pages and Commons
- Page Navigation Styling
- Header and Footer
- Adding and deleting pages, changing pages order
- Copying pages between presentations
- Changing page size
- Splitting pages
- Page names
- Adding template pages
- Subset of pages
- Merging lessons
- Custom page loader
- Pop-up
Working with templates
- Creating and managing templates
- Private templates
- Public templates
- Updating templates - Replacing templates
- Template CSS classes
- Using external fonts
- Error loading template
CSS class and inline CSS styles
Creating responsive layouts
- Managing Layouts
- Layouts view and basic operations on the multi-layout page
- CSS Stylesheets and Inline CSS in responsive layouts
- Previewing and displaying lessons
- Adding pages from template
- Copying pages between lessons
Creating Accessible Content
- CSS Classes
- Headings
- Alternative texts
- Finding missing alternative texts
- Videos
- Language definition
- Keyboard navigation mode
- Dedicated screen reader
- Keyboard and TTS Modules
- Autofill function (TTS)
- Adding missing TTS modules
- Sorting the modules
- Sort function (TTS)
- Speech text dictionary
- Editing default TTS titles
Adaptive Learning
- Adaptive Learning Editor
- Navigation in the Adaptive Lesson
- Reporting Pages
- Testing The Adaptive Lesson
Printing
- Examples of lessons with digital and print layers
- Printing methods and modes
- Print mode in mAuthor
Content output
- SCORM packages
- Experience API (TinCan)
- Off-line playback
- Add mAuthor lesson to the epub3 book
- Player versions
- Course management
Working with modules
- Working with keyboard navigation
- Inserting modules
- Defining the module's size and position
- Nesting of addons/modules
- Grouping modules
- Favourites
- Grid
- Rulers
- Snapping
- Changing modules' order
- Blocking modules
- Showing/Hiding Modules
- Selecting and editing the modules' style
- Copying modules between pages
- Copying modules between presentations
- Relative layouts
- Content preview
- Drag&Drop and Click&Click module manipulation
- Activity scoring
- Redo & Undo commands
- Iframe animation controlled by Advanced Connector
- Additional classes
- Mutation Observer
Using jQuery
- jQuery Library
Saving user's result
Modules description
- Activities
- Games
  - Board Game
  - Catch
  - Crossword
  - Dice
  - Hangman
  - Magic Boxes
  - Maze
  - Memo Game
  - Puzzle
  - Quiz
  - Shooting Range
  - Sudoku
- Reporting
- Navigation
- Media
  - 3D Viewer
  - AI Assistant
  - Animation
  - Audio
  - Audio Playlist
  - Coloring
  - Drawing
  - Edge Animation
  - Editable Window
  - Flash Cards
  - Glossary
  - Heading
  - Iframe
  - Image
  - Image Viewer
  - Image Viewer Button Controlled
  - IWB Toolbar
  - Layered Image
  - Line
  - LottiePlayer
  - Media Recorder
  - Model Viewer 3D
  - MultiAudio
  - Scoreboard
  - Shape
  - Shape Tracing
  - Slideshow
  - Standard Shapes
  - SVG
  - Swiffy Animation
  - TextAudio
  - Video
  - Vimeo
  - YouTube
  - Zoom Image
  - Zoom
- Scripting
- LearnPen
- CSS z-Indexes list
Math expressions
Private addons' development
- Creating addons
- Sharing the addons
- Addon CSS Guide
- Addon Presenter
- Addon Documentation
- Addon Model
- Player services
- Available JavaScript Libraries
- Addon Scripting
- Sample addon
- Addon-Events
Version control
Player development
- Requirements
- Build process
- Create addon
- Embedding the player
Exporting Lessons
- SCORM 2004
- SCORM 1.2
- xAPI
- Importing Lessons
- HTML5/Offline
Content localisation
- Localisation editor
- Audio narrations
Importing InDesign XML files

AI Assistant

Description

AI Assistant is an addon that allows you to configure an AI chatbot that the user can talk to. AI API key needs to be configured in mAuthor/mCourser for this addon to function correctly.

Properties

The list starts with the common properties, learn more about them by visiting the Modules description section. The other available properties are described below.

Property name	Description
Chat name	The name of the chat, which will be displayed at the top of the addon.
Welcome text	The initial text which will be displayed by the addon.
Hidden prompt	This will be the first message that will be sent to the AI assistant automatically after it has been initialized. The content of the Hidden prompt will not be displayed for the user.
Suggestions	These suggestions will be displayed for the user as a prompt under the Welcome text.
Instructions	This property allows you to define the instructions for the AI Assistant. Instructions serve to guide its responses and behaviour.
Draggable	When checked, the addon becomes draggable.
Hide header	When checked, the addon's header will not be displayed.
Mute voice	If checked, the addon will not read the contents of the Assistant's messages. This property does not affect the TTS functionality in the WCAG mode.
Voice language	Defines the language which will be used to read the contents of the Assistant's messages. The default value is 'en'. This property does not affect the TTS functionality in the WCAG mode.
Voice type	Defines the voice type which will be used to read the contents of the Assistant's messages. The default value is 'onyx'. This property does not affect the TTS functionality in the WCAG mode.
Reading speed	Defines the speed at which the contents of the Assistant's messages will be read. Te value must be greater than 0.25 and lesser than 4. The default value is '1'. This property does not affect the TTS functionality in the WCAG mode.
Translation languages	Defines the languages which will be available for translating the Assistant's messages. Each code should be separated by a semicolon.
Class names	The specified classes will be used in place of 'display: none' when using the hide and show methods. This enables the author to define the exact behaviour when hiding/showing the addon, such as by adding css for animations. If the property is left empty, 'display: none' will be used.
Lang attribute	Defines the language that will be used by TTS in the WCAG mode.
Speech texts	List of speech texts: Message sent, Recording, Finished Recording, Last message, Assistant message number:, User message number:, Text input, Record button, Send button, Disabled, Active. These texts will be read while using the addon in the WCAG mode.

Supported commands

Command name	Params	Description
show		Displays the addon. If Class names property has been set, the classes specified in that property will be used.
hide		Hides the addon. If Class names property has been set, the classes specified in that property will be used.
showAnimated		Displays the addon by assigning it either the class specified in the class names property, or the 'open' class if the Class names property is empty.
hideAnimated		Hides the addon by assigning it either the class specified in the class names property, or the 'close' class if the Class names property is empty.