Studio Editor User Guide

Version 6.11

Reference Guide

Table of Contents

Copyright and Legal Notice ...... 1 Copyright...... 1 Release Notes ...... 3 Editor 6.11 Release Notes ...... 3 System Requirements ...... 6 Hardware Requirements ...... 6 Software Requirements...... 6 Getting Started in Studio (For New Users)...... 9 Logging In and Updating Your Profile ...... 11 Log into Xyleme Studio ...... 11 Studio Home Page: The Document Manager ...... 13 What is the Document Manager? ...... 13 Common Conventions in Studio...... 17 Helpful Hints ...... 17 Content editing toolbar ...... 21 Building a Document in Studio ...... 23 The Content Editor ...... 23 Document Structure Basics...... 28 Basic Content Authoring ...... 36 Authoring in Xyleme Studio ...... 49 Authoring Fundamentals ...... 51 Getting Started with a Document ...... 51 How Documents are Saved in Studio Editor ...... 55 Text Blocks ...... 56 Lists ...... 59 Tables ...... 66 Media ...... 70 Custom Notes ...... 127 Procedures ...... 133 Equations ...... 141 Glossary ...... 146 Spell Checker ...... 151 Cover Page for Web Course ...... 152

Studio Editor User Guide Page i

Advanced Authoring ...... 155 Cross References and Links ...... 155 Special Notes and Styles ...... 180 Authoring Assessments ...... 210 Content Groups ...... 301 Design Data ...... 303 Document Index ...... 309 Educational Objectives ...... 311 Flash Cards ...... 313 HTML Page ...... 324 Image Map ...... 328 Slides ...... 334 Supplements ...... 337 Topic FAQs ...... 340 Web Component ...... 343 Managing Content ...... 351 Content Workflow ...... 373 Assign a Document to a User ...... 373 Work on an Assigned Task ...... 374 Manage Folder and Document Permissions ...... 379 Reviews ...... 387 Non-Authoring Tasks ...... 427 Copy Documents ...... 429 Export Document XML ...... 433 Import Documents ...... 437 Publish Documents ...... 445 Publish a Document ...... 445 Publish Documents to CDS ...... 450 Searching in Studio ...... 459 Search from Navigation Bar ...... 459 Search for an element by GUID ...... 465 Search and Replace within a document ...... 467 Document Structure ...... 471 Single Source Project (SSP) Structure ...... 473 What is a Single Source Project? ...... 473 Cover Page & Front Matter ...... 473 Structure Using Modules vs Lessons ...... 478 Modules ...... 479

Page ii Studio Editor User Guide

Lessons ...... 483 Topics ...... 487 Web Course Structure...... 495 Pages ...... 495 Containers ...... 495 Slide Deck Document ...... 497 Create a Slide Deck Document ...... 498 Manage Slide Deck Properties ...... 499 Procedure Document ...... 503 Create a Procedure Document ...... 503 FAQ Document...... 505 Create an FAQ Document ...... 505 Lesson and Module Template Documents ...... 507 Create a Lesson Template Document ...... 507 Create a Module Template Document ...... 508 Appendix ...... 510 Previous Release Notes ...... 511 Editor 6.9 Release Notes ...... 511 Editor 6.6 Release Notes ...... 513 Editor 6.4 Release Notes ...... 514 Editor 6.2 Release Notes ...... 515 Moving from Studio Desktop to Studio ...... 521 Overview...... 521 Frequently Asked Questions ...... 521 Detailed Information ...... 534 Glossary ...... 565 Index ...... 575

Studio Editor User Guide Page iii

This product and related documentation are protected by copyright and are distributed under licenses regarding their use, copying, distribution and decompilation. No part of this product or related documentation may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Xyleme, Inc.

Confidentiality and Proprietary Notice

This product and related documentation are the confidential and proprietary products of Xyleme, Inc., the use of which is governed by the terms and conditions of the license agreement. Neither the software nor the related documentation may be distributed to any unauthorized party.

Trademarks

Xyleme™ is a trademark of Xyleme, Inc. in the United States and other countries.

Xyleme, Inc. may own other service marks or trademarks that are not included here. The use of any service mark or trademark herein without the prior written consent of Xyleme, Inc. is strictly prohibited.

All other trademarks that may appear in this product and the related

Studio Editor User Guide Page 1

documentation are the property of their respective owners.

Warranty Disclaimer

This document is provided without any warranty of any kind, either express or implied. This document may contain technical inaccuracies or typographical errors.

Changes are periodically made to this product and related documentation. These changes will be incorporated into new versions of the product and documentation. Xyleme, Inc. reserves the right to make changes or improvements to the product or documentation at any time. Information in this document is subject to change without notice. Companies, names and data used in examples are fictitious unless otherwise noted.

Acknowledgments of Other Software

This product incorporates cadaver (http://www.webdav.org/cadaver).

This product incorporates dom4j (http://www.dom4j.org).

This product incorporates Jazzy (http://jazzy.sourceforge.net).

This product incorporates jcalendar

Page 2 Studio Editor User Guide

(http://sourceforge.net/projects/jcalendar).

This product incorporates kXML2 (http://kxml.sourceforge.net).

This product incorporates NetBeans (http://www.netbeans.org).

This product incorporates WIRIS Editor (http://www.wiris.com/editor).

Release Notes

Editor 6.11 Release Notes

This table details the changes in this document for the 6.11 production release of Editor.

Change Status Description Affected Sections

Added Expand New Added Expand and Getting Started in and Collapse all Collapse all to Studio > Building a to document document outline Document in outline Studio > Document Structure Basics > Controlling the document outline

Studio Editor User Guide Page 3

Added Break New You can now break a Authoring in Link function link once you've reused Studio > Advanced for linked content. Breaking a link Authoring > content makes a copy of the Managing Content object in the location > Reusing Content where you're breaking > Breaking links to the link. It only breaks shared content the link in the location where it is initiated leaving all others instances of the reuse linked.

Search Update  Added Where  Non- Improvements Used to search Authoring results Tasks > Searching in  Streamline the interface for Studio > adding Folder Searching filters to search from the results by adding Navigation a type ahead Bar > control if you Anatomy of know the folder a Search you want to add. Result  Release Notes Only

Page 4 Studio Editor User Guide

Added more Update We've added icons next Release Notes visual to each template Only indications to element in Template Template Manager to indicate if a manager template is public or private and is Check-Out status

Public

Private

Added Update Added Cross-reference Authoring in additional and URL to image Xyleme Studio > image behaviors on Figures Authoring behaviors to Fundamentals > figures Media > Images > Insert image behavior properties for an image.

Made Update Contextual toolbars for Release Notes Contextual items such as tables, Only Toolbars lists, etc. are now movable moveable.

Margin Notes Update You can now drag and Release Notes are now drop margin notes as Only movable you can move other elements in Editor.

Studio Editor User Guide Page 5

Replaced review Update As all new and many Authoring in section of this existing customers are Xyleme Studio > document with using the new Content Workflow the new consolidated review > Reviews consolidated feature we're replacing review function. the review section of this document with information on the new review features.

System Requirements

Hardware Requirements

 2 GHz or greater

 4 GB RAM minimum, 8 GB recommended

Software Requirements

Operating Systems

Version Service Pack and Updates

Windows 7 Latest service packs and security fixes

Windows 8 Latest service packs and security fixes

Windows 10 Latest service packs and security fixes

Page 6 Studio Editor User Guide

Version Service Pack and Updates

Mac OSX 10.11.6 (El Capitan) Latest service packs and security fixes

10.12 (Sierra) Latest service packs and security fixes

10.13 (High Sierra) Latest service packs and security fixes

Internet Browsers

OS Browser

Windows Chrome 62

Windows Firefox 56.0.2

Windows IE 11 with latest security updates applied by Microsoft

Windows Edge with latest security updates applied by Microsoft

Mac Safari 10.1 Safari 11 - Qualified with High Sierra only

Mac Chrome (current official releases supported by Google)

Mac Firefox (current official releases supported by Mozilla)

Studio Editor User Guide Page 7

Please note: Compatibility mode of Windows browsers is not supported.

Email Client

In order to send and receive email communications to and from Xyleme Studio, you will need a configured email client application.

Page 8 Studio Editor User Guide

Module 1 Getting Started in Studio (For New Users)

This module contains content extracted from the Quick Start Guide, which is intended for new users. We have added it to this user guide for your reference.

Lessons

 Logging In and Updating Your Profile  Studio Home Page: The Document Manager  Common Conventions in Studio  Building a Document in Studio

Studio Editor User Guide Page 9

This page intentionally left blank.

Page 10 Studio Editor User Guide

Lesson 1 Logging In and Updating Your Profile

This lesson covers the following tasks:

 Log into Xyleme Studio

 Update Your Profile

Log into Xyleme Studio

When a user account is created for you by an administrator, you will receive an email containing login information, including your username, password, and a link to Studio. Select the link provided in the email to open the Studio login page in your browser.

Log into Studio using the credentials provided in the email. After logging in for the first time, you will be required to change your password. For information on how to complete this task, refer to Update Your Profile.

Update Your Profile (step-by-step)

To update your profile or change your password, follow these steps:

1. Select the person icon in the upper right corner of the page, and choose Profile

Document Manager with Profile menu activated

 You will be redirected to your profile page, where you can change your password and modify other profile information

Studio Editor User Guide Page 11 Logging In and Updating Your Profile

2. Enter your current password (if needed) and your new password in the fields provided, and select Save

User profile page

Passwords must meet the following criteria:

 Must be 8+ characters long

 Must include at least one lower case letter

 Must include at least one upper case letter

 Must include at least one number

 Must be periodically changed according to a password expiration date set by the administrator

3. Use your browser's Back button to navigate back to Studio

Page 12 Studio Editor User Guide

Lesson 2 Studio Home Page: The Document Manager

This lesson will cover the following:

 Overview of the DocumentManager

 How to Manage Documents and Folders

 How to Create a New Document

 Making Bulk Changes to Documents & Folders

What is the Document Manager?

The Document Manager is the landing (or "home") page when you first log into Studio. All documents to which you have access can be managed on this page.

Managing Documents in the Document Manager

In the Document Manager, you can: 1. Use the Navigation bar to access Documents, Media, Reviews, etc. 2. Search for content 3. Manage your user profile and settings 4. Access recent and assigned documents 5. Navigate folders and documents within the Document Manager 6. Select content 7. Create a new document 8. Create a new folder

Studio Editor User Guide Page 13 Studio Home Page: The Document Manager

9. Make bulk changes:

 Delete multiple documents or folders

 Move documents or folders 10. Rename, delete or assign individual documents (from a dropdown menu)

Document Manager (with annotation)

Document Indicators

The Status Column in the Document Manager may contain one or more different colored and/or different shaped indicators. These are document badges, and they specify the current editing state of a particular document. For example, a green checkmark indicates that a document is currently checked out and locked for editing by you.

The following table describes the appearance and meaning of each badge:

Page 14 Studio Editor User Guide Studio Home Page: The Document Manager

Document Badges

Badge Meaning

Green checkmark - the document or element is checked out to you, and you have exclusive editing rights; all other users see the orange checkmark badge.

Orange checkmark - the document or element is checked out to someone else and is unavailable for you to edit; however, you are still able to view it. To see who has checked out the document, select the dropdown arrow on the element, and choose Properties.

Blue circle - the document or element has been assigned to a user and is waiting for work to be completed.

Red box - the document or element is currently being reviewed and is unavailable for editing.

Document Badges

Creating a New Document (step-by-step)

Before you begin, make sure you are in the Document Manager. 1. Select the New Document button

2. Select a document type from the dropdown menu

a For help choosing a document type, see Document Structure Basics for more details

3. Enter a document name, and select OK

 You will be directed to a new page containing the blank document

Making Bulk Changes (step-by-step)

The following procedure guides you through making bulk changes to documents in the Document Manager:

Studio Editor User Guide Page 15 Studio Home Page: The Document Manager

1. Select the checkbox next to each document or folder you want to move, delete or force check-in

a To choose all documents or folders, select the checkbox next to the Bulk Changes button

2. Select the Bulk Changes button, and choose the appropriate action

If you select Delete and any of the items are checked out by other users, you will receive a warning message.

3. To move items, select Move, and choose the new location

 Once you select the new location, the items will be moved

Page 16 Studio Editor User Guide

Lesson 3 Common Conventions in Studio

This lesson contains some useful tips and information to help you get the most out of Studio.

Helpful Hints

 Saving your document: your document is automatically saved as you go

 Content Editor toolbar: perform most of your authoring actions from here; for more information, refer to Content Editor Toolbar  Some elements (eg., lists, figures, tables, etc.) have floating toolbar menus, activated when the element is selected

 Element properties pane: this pane is activated when you select the gear or the menu icon on the right side of an element in the Content Editor The element properties pane contains icons (the number depends on the element) on the left side that allow you to toggle between different properties and actions for that particular element, such as:

1. Element Properties

2. Element Actions

3. Design Data

4. Advanced Properties

Studio Editor User Guide Page 17 Common Conventions in Studio

5. Classification Data

6. Supplements

Element properties pane (with annotation)

Detailed information about the element properties pane for each element can be found in the User Guide.

 Breadcrumbs: you can also access element properties by selecting the element in the breadcrumb trail. For instance, in the following image, selecting Figure in the breadcrumb trail activates the element properties pane for that image. Selecting Topic activates the element properties pane for the topic.

Page 18 Studio Editor User Guide Common Conventions in Studio

Document breadcrumb in the content editor

 Undo/Redo: perform these actions from the content editing toolbar

Studio Editor User Guide Page 19 Common Conventions in Studio

Undo/Redo icons (with annotation)

 Delete an element: how you delete an element depends on what type of element it is:

1. Structural elements, such as Lesson or Topic: from the document outline on the left side of the Content Editor, select the menu icon and Delete

Delete element from the outline

2. Content elements, such as Rich Text, Table, or List: from the right side of the Content Editor, select the menu icon and Delete

Page 20 Studio Editor User Guide Common Conventions in Studio

Delete element from the content editing pane

Content editing toolbar

The content editing toolbar is where you perform the majority of your authoring tasks. You can add content to your document, as well as add formatting and context-specific objects to inserted elements from this area.

Content editing toolbar

The toolbar menus are context-sensitive, so you may see different options available depending on which object is selected in the editor.

Studio Editor User Guide Page 21 Common Conventions in Studio

This page intentionally left blank.

Page 22 Studio Editor User Guide

Lesson 4 Building a Document in Studio

In this lesson, we will cover the following topics:

 Introduction to the Content Editor

 Document Structure Basics

 Basic Content Authoring

The Content Editor

Opening a document from the Document Manager displays the Content Editor, where you author and preview your content.

Once in the Content Editor, you can: 1. Manage Studio components (Documents, Media, etc) 2. View and edit the current document 3. Preview the current document 4. Author content via the content editing toolbar 5. Determine whether the current document is available for editing

Studio Editor User Guide Page 23 Building a Document in Studio

Content Editor interface (with annotation)

You may edit a document only if you currently have it locked for editing. See Editing a Document for more information.

Editing a Document

In order to edit a document in Studio Editor, you must have the document checked out. When a document is checked out, only the person to whom it is checked out may edit the content. Other users can see the document and its contents but they cannot make any changes.

Determining Whether a Document is Available for Editing

When you open a document, you can easily determine whether or not you can check it out for editing by noting the status of the document in the

Page 24 Studio Editor User Guide Building a Document in Studio upper right corner of the Content Editor. The status indicates whether the document is "editable" or "not editable."

The editing status messages are:

 Editable - the document is currently checked out to you

 Not editable - the document is not checked out to you; check the message in the editing pane to see whether the document is checked out to someone else or is available to be checked out to you

You can also check the document badge in the Document Manager as described in Document Indicators.

Checking out a Document

There are two ways to check out a document for editing: 1. Click on the status to change it from not editable to editable 2. Check out the document from the Actions dropdown menu (shown below)

Studio Editor User Guide Page 25 Building a Document in Studio

Checking out a document - with annotation

Please note: Studio Administrators may utilize the Force Check In All feature when the option is available in the above menu.

Checking in a Document

There are two ways to check in a document so others may edit it: 1. Click on the status to change it from editable to not editable 2. Check in the document from the Actions dropdown menu (shown below)

Page 26 Studio Editor User Guide Building a Document in Studio

Checking in a document - with annotation

When you check in a document, the Version Control window will display in a pop-up window. Enter a meaningful Label and Description and select the Commit button.

The document will be checked in and available for others to check out for editing, and a version of the document will be created. The label and description entered will be displayed in the Version History for the document (currently available in Studio Desktop Editor only).

Studio Editor User Guide Page 27 Building a Document in Studio

Version Control window - available during check-in of a document

Here are some best practices around versions:

 Define points in your workflow when you will version the whole document

 When replacing media in a new version, use media with a new file name and update the XML, leaving the older media in place

 Archive the finished products on another system for reference to be safe (CDS or a share drive)

 Manually create a version before rolling forward an older version and after Accept/Reject.

 Roll forward should be temporary to make a quick fix and immediately return to the new version of the document

Document Structure Basics

In this topic, we'll cover the basics of structuring a document in Studio, including:

 Supported document types

 Document structure

 Adding structure to a document

Page 28 Studio Editor User Guide Building a Document in Studio

 Controlling the document display

 Reorganizing the structure of a document

Supported Document Types

The following document types are currently supported in Studio:

 Single Source Project (SSP)

 ISD Lesson Template

 Glossary

 Slide Deck

 Web Course

 Procedure

 Topic

 FAQ

This guide will focus on the structure of a Single Source Project.

Overview of Document Structure

Document structure is the outline of your document. Single Source Project documents are typically made up of Lessons and Topics. Lessons contain Topics, and Topics can contain other topics.

Example of document structure

Studio Editor User Guide Page 29 Building a Document in Studio

Adding Structure to Your Document

You can add structural elements to your document by selecting the Add Structure button in the top left corner of the outline.

Structural elements include:

 Front Matter: contains chapter elements that appear at the beginning of your document before lessons or modules

 Lessons: the default structure type for Single Source Projects, containing topic elements

 Topics: contain content elements such as text, tables, and lists

 Appendices: contain chapter elements that appear at the end of your document after all lessons or modules

This guide will focus on lessons and topics.

Add structure button in the Content Editor

To add a lesson, select Lesson from the Add structure menu, and a new lesson will be added at the end of your document.

To add a topic, select the lesson where you want the new topic to be added, and select Topic from the menu. A new topic will be added at the end of the lesson.

As you add structure to your document, it will appear in the Document Outline.

Page 30 Studio Editor User Guide Building a Document in Studio

Document Outline

The location of the structural element being inserted into the document depends on what you have selected in the outline. If you have a lesson selected and you add a topic, it will be added as the last topic of the selected lesson. If you have a topic selected

and you add another topic, it will be added as a subtopic of the selected topic.

Controlling the Document View

The Content Editor limits the content displayed based on the level selected in the outline. For example, selecting a lesson displays the contents of the entire lesson in the Editor.

Studio Editor User Guide Page 31 Building a Document in Studio

Editor view with a lesson selected

Selecting a topic displays the contents of the entire topic and all of its subtopics in the Editor.

Page 32 Studio Editor User Guide Building a Document in Studio

Editor view with a topic selected

Studio Editor User Guide Page 33 Building a Document in Studio

Reorganizing the Structure of a Document

 Delete lessons or topics

– Select the menu icon to the right of a lesson or topic in the outline, and select Delete

 Move lessons or topics in the outline

– Drag and drop lessons or topics to move them around in the outline; as you drag the element, a blue line displays to indicate an acceptable location

Move lesson in the outline

Page 34 Studio Editor User Guide Building a Document in Studio

Controlling the document outline

There are a couple of controls in the outline that allow you to hide and show parts of the outline. Expand and collapse buttons at the top of the outline that work on the entire outline and individual expand and collapse controls that work on individual elements in the outline. 1. Expand and collapse buttons

 located at the top of the outline.

 controls the entire outline. 2. Individual expand and collapse controls

 located next to each outline item.

 controls individual elements in the outline.

Studio Editor User Guide Page 35 Building a Document in Studio

Basic Content Authoring

This topic describes basic content authoring in Studio. For more specific authoring information and step-by-step details, refer to the user guide.

Three of the most common basic authoring tasks in the Content Editor are: 1. Insert content elements 2. Upload media 3. Preview documents

Basic content authoring tasks (with annotation)

Adding Content Elements (step-by-step)

Page 36 Studio Editor User Guide Building a Document in Studio

Before you begin, make sure the topic is locked for editing (checked out) by you.

1. Navigate to the location in the document where you want to insert the element

2. Place your cursor in the location just above where you want the new element to appear

If you place your cursor in a Topic title, the new element will be added as the last element in the topic.

3. Choose an element icon from the toolbar

If the desired element is not pictured in the toolbar, select the +Insert dropdown menu to display more options.

Uploading Media

All media assets used in your documents (such as image files, movies, and audio files) must be stored in the Media Manager.

You can upload media to the Media Manager in one of two ways: 1. Via the Media tab located at the top of the page

Media tab

2. When you add a new media element to a document

Studio Editor User Guide Page 37 Building a Document in Studio

You can quickly add multiple files or folders to the Media Manager using the Drag and Drop feature. For more information, please see the Drag and Drop step-by-step procedure.

Supported media file types include:

File File Extension Type

Audio .mp3, .wav

Flash .flv, .swf

Movie .avi, .flv, .mov, .mp4, .wmv, .m1v/.mpeg-1, .m2v/mpeg-2, .mpeg, .mpg,

.ogg, .ogv, .webm

Image .bmp, .gif, .jfif, .jpg, .png, .tiff

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Page 38 Studio Editor User Guide Building a Document in Studio

Upload Media to the Media Manager (step-by-step)

Upload a single file or folder of media to the Media Manager

Before you begin, make sure you have permission to access the Media Manager.

Adding media to the Media Manager (with annotation)

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

1. Select Media from the Navigation bar at the top of the page

 You will be redirected to the Media Manager page

2. Specify a location in the Media Manager to store the media asset(s)

3. Select the appropriate Upload button (for example, Upload Files)

 A pop-up window will appear displaying your local hard drive

Studio Editor User Guide Page 39 Building a Document in Studio

4. Choose the media file(s) and select Open

 The file(s) are uploaded to the Media Manager using the existing filename(s)

a If you wish to rename the file(s), select Rename from the dropdown arrow associated with the newly uploaded file and enter a new name in the available field

5. If uploading a folder of media files, select the folder to upload from your hard drive

a If you wish to save the media folder with a different name, enter it in the available field

Page 40 Studio Editor User Guide Building a Document in Studio

6. Select OK to upload

Upload multiple files or folders using Drag and Drop

Before starting this procedure, please make sure you have navigated to the location in the Media Manager you want to place the items.

7. Locate the files/folders on your hard drive that you wish to upload

8. Select the items using Ctrl+Click and drag them to the Media Manager in your web browser

9. When prompted (see the image below), drop the items onto the page

 A progress pane will open at the bottom of the page as your files upload, and when the upload is finished, the page will refresh to display the newly uploaded media files

Studio Editor User Guide Page 41 Building a Document in Studio

Add Media to a Document (step-by-step)

1. Place your cursor in the location where you want to add the media asset

2. Select a media element icon from the toolbar, such as Figure or Movie

3. From the Select media resource pop-up, choose the media asset, and select OK

If the desired media asset is not yet uploaded to the Media Manager, you can upload it from the Select media resource window by selecting the Upload button and following the instructions on the page. Once the file is uploaded, the window

will refresh, and you will be able add the asset to the document.

Page 42 Studio Editor User Guide Building a Document in Studio

4. If you need to change any of the image properties, such as size, select the properties gear icon to access the Element properties pane

Previewing Content

The way your content displays in the Content Editor is not necessarily how it will look when published. You can generate a preview of the document via the Preview tab to see how it will appear in a selected format. You can also preview the document via the menu icon in the document outline.

You can preview:

 the entire document, or

 a subset of the content, such as a lesson or topic

Previewing a Document (step-by-step)

1. To access the Preview page, select the Preview tab in the Content Editor

2. Alternatively, you can select Preview from the menu in the outline

Studio Editor User Guide Page 43 Building a Document in Studio

Access the Preview page (with annotation)

3. From the Preview page, select a preview format from the left panel

Page 44 Studio Editor User Guide Building a Document in Studio

 The document preview will be generated and displayed in the preview pane on the right side of the page using the format selected

The following image is an example of a Single Source Project (SSP) document with the Reference Guide (PDF) format selected:

Studio Editor User Guide Page 45 Building a Document in Studio

4. To publish the document, select the Actions dropdown menu and select Publish

Page 46 Studio Editor User Guide Building a Document in Studio

Previewing a Subset of Content (step-by-step)

1. With the desired structural element (lesson or topic) selected in the outline, select the menu and choose Preview

 The Preview page will be displayed

2. From the available options in the left pane, select an output type, such as Reference Guide (PDF)

Studio Editor User Guide Page 47 Building a Document in Studio

 The selected content will display as the specified output type in the preview pane

3. To publish the document, select Publish from the Actions dropdown menu

Page 48 Studio Editor User Guide

Module 2 Authoring in Xyleme Studio

This module will cover the various elements in Studio in more detail than the Quick Start Guide, including:

 Authoring content, such as rich text blocks, lists, tables, and media

 Content workflow, such as assigning content to other users

Using Studio Editor and Desktop Editor Simultaneously

Currently, there is functionality available in Desktop Editor that is not yet available in Studio Editor. Until Studio Editor catches up (and Desktop eventually goes away), you may need to log into Desktop Editor to perform some authoring functions. In light of this, there are some things to be aware of when using Studio Editor and Desktop Editor simultaneously.

Platform Share changes with See changes Update folders other platform made in other and folder platform contents

Desktop Save the document Close document Folder refresh view > Refresh All > Reopen document

Studio Document Browser refresh Document automatically saved (while editing Manager Refresh document)

Lessons

 Authoring Fundamentals

Studio Editor User Guide Page 49

 Advanced Authoring  Content Workflow

Page 50 Studio Editor User Guide

Lesson 1 Authoring Fundamentals

This lesson covers everything you need to know regarding authoring content in Editor, such as adding and formatting text blocks, images and other media; inserting assessment questions; configuring glossary terms; and including Design Data.

Getting Started with a Document

Create a New Document

To create a new document in Editor, select the New Document button from the Document Manager page and select the document type you want to create

Studio Editor User Guide Page 51 Authoring Fundamentals

Document Manager - create new document (with annotation)

Open/Check Out a Document

To open a document, simply locate it in the Document Manager and click on the title of the document to open it in Editor. If the document is not checked out, you may check it out by selecting Check out from the dropdown menu:

Page 52 Studio Editor User Guide Authoring Fundamentals

Check out a document from inside Editor

If a document is checked out to another user, you may still view the document. If you wish to make changes, however, the other user or a Studio Administrator will need to check in the document first so that you may then check it out.

Studio Editor User Guide Page 53 Authoring Fundamentals

Add Structural Elements to a Document

Structural elements can be added to a document via the Add Structure button located above the document outline

Editor Add Structure menu button

Once a structural element is added to the document, you can add supporting elements to it from the content editing toolbar.

Content editing toolbar

For detailed information about Document Structure, please see the Document Structure module.

Page 54 Studio Editor User Guide Authoring Fundamentals

How Documents are Saved in Studio Editor

Please note: The manner in which documents are saved in Studio Editor differs between the Desktop and Web versions. The following information applies only to the Web version.

Documents in Editor are saved automatically in the following manners: 1. When you "move off" or click outside of an element immediately after authoring or editing the element 2. Every 30 seconds

A save indicator displayed in the upper right hand corner of Editor shows the save status of the current document. Documents in Editor are saved automatically when you "move off" or click outside of an element immediately after authoring or editing the element. You may also click in this save status area to save your document at anytime.

Save Indicator (with annotation)

Studio Editor User Guide Page 55 Authoring Fundamentals

Text Blocks

Rich text blocks are paragraphs or simple statements added throughout your document. To add a rich text block, select the location where you want to add one, and select the Rich Text icon from the content editing toolbar, as shown in the image below:

Insert a rich text block

Rich Text Formatting

To format text in rich text blocks, use the Format icons in the toolbar as shown in the following image:

Format menu icons in the content editing toolbar

There are a couple of different ways you can style your rich text:

 Simple text formatting - this includes formatting text as bold or italic font types as well as underlining, subscript/post-script, etc. Notice Bold, Italic and single underline are available on the content editing toolbar; the remaining formatting styles are located in the Styles dropdown menu.

Simple text formatting options

 Semantic tag formatting - set tags for specific word groups like menu selections, keyboard commands, etc. Semantic formatting options are displayed in the Styles dropdown menu:

Page 56 Studio Editor User Guide Authoring Fundamentals

Formatting Styles

The following image provides an example of a paragraph authored in Studio Editor with various rich text formatting styles.

Rich text block authored in Studio Editor

The next image shows an example of the same paragraph previewed as a reference guide.

Studio Editor User Guide Page 57 Authoring Fundamentals

Rich text block previewed as a reference guide

Please note: while there are some similarities between the two examples, the text displayed in Studio Editor is not truly WYSIWYG. Therefore, it is best to always preview your work to make sure it looks the way you expect it to look rather than

simply going by the display in the content editor.

Semantic Tags

Using semantic tags involves a little back-end setup but can make authoring various types of text much easier. For example, if you use keyboard keys in your documents frequently, you can set up a "keyboard" tag to display a certain way and tag those words with a keyboard tag rather than having to add formatting individually.

The following is a list of currently supported semantic tags in Studio Editor:

 Keyword

 Code

Page 58 Studio Editor User Guide Authoring Fundamentals

 Keyboard

 Menu Selection

 Syntax-Keyword

 Syntax Argument

 Application Prompt

 Command Name

 Instructor Text

 Type This

 Lab File

 Variable Text

 Window Name

 Highlight

 Quote

Lists

List elements allow you to author content whenever you want to quickly or concisely display items or ideas rather than write about them in paragraph form. By default, a list item contains a rich text block for you to add text.

Below are some examples of what you can do when authoring a list in Studio Editor:

 Add a preamble for the list

 Mark list items with bullets, numbers, letters, etc.

 Add animation (for a slide or an online course only)

 Add figures, tables, etc to each list item

 Create a sub-list within the list

Two images are provided below to give an example of a list as authored in Studio Editor (the first image) as well as the same list previewed as a print output (the second image):

Studio Editor User Guide Page 59 Authoring Fundamentals

List authored in Studio Editor

List previewed as a print output

Lists can have one or more of the following characteristics:

 Preamble: text preceding your list items

 List markers: symbols or characters preceding each list item, such as numbers, letters or bullets

 List delimiters: punctuation after list markers preceding each list item, such as commas or periods

Page 60 Studio Editor User Guide Authoring Fundamentals

 Sublists: lists related to a particular list item indented below the list item

 List items with text and/or images

Insert a List

To add a list to your document, select the location where you want the list added, and select the List icon from the content editing toolbar as shown below:

Insert a List

Add List Items

Add Text to the Beginning of a List

Many times, you will want to introduce a list with some text to give the list some context. It is a best practice to add a preamble to the list. This way, if you reuse the list, the text will be included when you reuse it elsewhere.

To add a preamble to your list, select the List Preamble icon from floating List Toolbar:

Studio Editor User Guide Page 61 Authoring Fundamentals

Add a list preamble

Add additional list items

To add additional list items, simply use the Enter key on your keyboard and a new list item will be added immediately below the previously selected item.

You can add additional list items by selecting the menu properties icon and selecting Add Sibling List Item, as shown below in the image:

Page 62 Studio Editor User Guide Authoring Fundamentals

List item element actions

A new list item will be inserted immediately below the previously selected item.

Add a Sub-list

To add a sublist, simply use the Tab key on your keyboard and a new, indented sublist item will be created immediately below the previously selected item.

You can also add a sublist via the element actions menu by selecting the menu icon and selecting Indent List Item as shown in the following image:

List item element actions

Adding other elements to a list item

Besides sublists, you can also add images to a list item. To do this, select the list item where you want to add the image, select the Figure icon from

Studio Editor User Guide Page 63 Authoring Fundamentals the content editing toolbar (shown in the image below), and select your image when prompted.

Add an image to a list item

Selecting or Adding List Properties

To set the properties of a list, select the properties gear on the right side of a list element in the editing pane to activate the properties pane at the bottom of the page.

This menu contains the following properties:

 Target Audiences: Select a specific audience for which to publish the list

 Target Outputs: Select a specific output for which to publish the list

 Build: Select an animation option for lists displayed in an online course or slide presentation

 StartAtNumber: Default setting is 1 or A; use this property to set a different starting number

 List Marker: Select a symbol or character type to precede each list item, such as numbers, letters or bullets

 List Delimiter: Select punctuation to display after list markers, such as commas or periods

To add one of these characteristics to your list, refer to the image shown below:

Page 64 Studio Editor User Guide Authoring Fundamentals

List properties menu

You can also select a List Marker from the floating menu by selecting one of the icons shown below:

Floating List Toolbar - select a list marker (with annotation)

Rearranging a List (step-by-step)

If you need to rearrange list items in your list, you can do so using the drag-n-drop functionality built into Studio Editor.

Studio Editor User Guide Page 65 Authoring Fundamentals

1. Hover your cursor over the list item you want to move until the four-sided arrow icon appears

2. Drag and drop the item to the new location

3. Select the Move Here button

Element drag and drop options

Tables

Presenting content in tables in your documents and courses can give you greater flexibility when it needs to be organized in a linear manner. Cells can be formatted and can include images, lists and text blocks within them.

The following two images show examples of a table authored in Studio Editor and how the table will look in a print output.

A table authored in Studio Editor

Page 66 Studio Editor User Guide Authoring Fundamentals

Authored table previewed as a print output

Remember, Studio Editor's content editor will not show your content in a true WYSIWYG display, so you will want to preview this content in whichever output(s) it will be published so that you can see how it will truly look in your publications.

Insert a table

To insert a table, place your cursor in the location where you want to add the table, select the Table icon from the content editing toolbar, and select the number of rows and columns you want from the grid that appears

Studio Editor User Guide Page 67 Authoring Fundamentals

Insert Table

After you insert a table and anytime you select one in the editor, the floating Table Toolbar is activated and appears adjacent to the table in the editing pane.

Modify a table layout

You can modify your table layout and insert other components to the table via the floating Table toolbar. For example, you can: 1. Insert or Remove Rows and Columns 2. Merge Rows or Columns* 3. Set a Header or Footer Row 4. Set a Header Column 5. Reset Column Width 6. Add a Caption and/or Title

Floating Table Toolbar (with annotation)

Page 68 Studio Editor User Guide Authoring Fundamentals

Resize the column widths of a table

Table columns can be resized by selecting a vertical border of a column and clicking & dragging it to the desired width. 1. Click and drag the vertical line left or right to resize the columns 2. Place your cursor on a column border to see column sizes (in percentage values) 3. To reset the column widths back to the original settings, select the Reset Column Width icon from the floating Table Toolbar

Resize columns in a table (with annotation)

Format a table

The following image displays the table element properties pane, where you can modify the format of your table. To activate this menu, select the Table tab from the breadcrumbs at the bottom of the editing pane. 1. Table Orientation: Choose Landscape or Portrait 2. Table Width: Enter a numeric value

Studio Editor User Guide Page 69 Authoring Fundamentals

3. Table Alignment: Choose left, center, or right (Left is default; applies to the entire table, will not affect cell alignment) 4. Table Border: Choose True or False (False is default) 5. Table Theme: Choose a user-defined theme (None/Blank is default)

Table Element Properties (with annotation)

Current constraint with tables

 Currently, there is not a way to unmerge cells in a table. If you wish to unmerge cells that have been merged, the available work-around is to delete the merged cells and re-insert them.

Media

Media objects that can be added to Studio documents include audio files, Flash objects, images and videos. This topic covers each of the supported media types, and explains how to upload media files to the media drive, how to add media to your documents, and how to modify them to fit your needs.

For general information on uploading media to the Media Drive, please refer to Uploading Media. For specific element-related information, please refer to the appropriate subtopic.

Page 70 Studio Editor User Guide Authoring Fundamentals

Uploading Media

All media assets used in your documents (such as image files, movies, and audio files) must be stored in the Media Manager.

You can upload media to the Media Manager in one of two ways: 1. Via the Media tab located at the top of the page

Media tab

2. When you add a new media element to a document

You can quickly add multiple files or folders to the Media Manager using the Drag and Drop feature. For more information, please see the Drag and Drop step-by-step procedure.

Supported media file types include:

File File Extension Type

Audio .mp3, .wav

Flash .flv, .swf

Movie .avi, .flv, .mov, .mp4, .wmv, .m1v/.mpeg-1, .m2v/mpeg-2, .mpeg, .mpg,

.ogg, .ogv, .webm

Studio Editor User Guide Page 71 Authoring Fundamentals

File File Extension Type

Image .bmp, .gif, .jfif, .jpg, .png, .tiff

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Upload Media to the Media Manager (step-by-step)

Upload a single file or folder of media to the Media Manager

Before you begin, make sure you have permission to access the Media Manager.

Adding media to the Media Manager (with annotation)

Page 72 Studio Editor User Guide Authoring Fundamentals

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

1. Select Media from the Navigation bar at the top of the page

 You will be redirected to the Media Manager page

2. Specify a location in the Media Manager to store the media asset(s)

3. Select the appropriate Upload button (for example, Upload Files)

 A pop-up window will appear displaying your local hard drive

4. Choose the media file(s) and select Open

 The file(s) are uploaded to the Media Manager using the existing filename(s)

a If you wish to rename the file(s), select Rename from the dropdown arrow associated with the newly uploaded file and enter a new name in the available field

5. If uploading a folder of media files, select the folder to upload from your hard drive

Studio Editor User Guide Page 73 Authoring Fundamentals

a If you wish to save the media folder with a different name, enter it in the available field

6. Select OK to upload

Upload multiple files or folders using Drag and Drop

Before starting this procedure, please make sure you have navigated to the location in the Media Manager you want to place the items.

7. Locate the files/folders on your hard drive that you wish to upload

8. Select the items using Ctrl+Click and drag them to the Media Manager in your web browser

Page 74 Studio Editor User Guide Authoring Fundamentals

9. When prompted (see the image below), drop the items onto the page

 A progress pane will open at the bottom of the page as your files upload, and when the upload is finished, the page will refresh to display the newly uploaded media files

Add Media to a Document (step-by-step)

1. Place your cursor in the location where you want to add the media asset

2. Select a media element icon from the toolbar, such as Figure or Movie

3. From the Select media resource pop-up, choose the media asset, and select OK

Studio Editor User Guide Page 75 Authoring Fundamentals

will refresh, and you will be able add the asset to the document.

4. If you need to change any of the image properties, such as size, select the properties gear icon to access the Element properties pane

Audio Files

Audio files can be added to your document via the content editing toolbar. All media objects used in your Studio documents must be stored in the Media Drive.

You can upload media at any time via the Media Manager or at the time you insert a media object into your document.

Page 76 Studio Editor User Guide Authoring Fundamentals

Instructions to upload media objects via the Media Manager can be found in Upload Media to the Media Manager (step-by-step).

Instructions to upload a media object at the time of inserting the audio object element are included in the Inserting an audio file procedure.

The following audio file types are currently supported in Studio Editor: .mp3.

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Insert an audio file

There are two ways you can insert an audio file in a document: 1) If the file is already stored on the Media Drive, you can select it from the Select Media Resource window 2) If the file needs to be uploaded, you can do so from the Select Media Resource window at the time you insert the element

Inserting an audio file (step-by-step)

1. Place your cursor in the location where you want to add the file and select the Audio icon from the content editing toolbar as shown below:

2. Locate the media object from the Select Media Resource pop-up window

Studio Editor User Guide Page 77 Authoring Fundamentals

a If the image needs to be uploaded to the Media Drive, select Upload in the selection window

b From the pop-up window that appears, browse and select the file to upload and select OK

3. Select the media object (2) and select OK (3)

Change the audio file used in an audio element

When you initially insert an audio element, you'll be asked to select the audio file to use at that time. If you need to change the audio file, it can be done within the audio properties pane, as shown below:

Page 78 Studio Editor User Guide Authoring Fundamentals

Audio element properties - change audio file

Upload an Audio file to the Media Drive

Audio files can be added to your document via the content editing toolbar. All media objects used in your Studio documents must be stored in the Media Drive.

You can upload media at any time via the Media Manager or at the time you insert a media object into your document.

Instructions to upload media objects via the Media Manager can be found in Upload Media to the Media Manager (step-by-step).

Instructions to upload a media object at the time of inserting the audio object element are included in the Inserting an audio file procedure.

The following audio file types are currently supported in Studio Editor: .mp3.

Studio Editor User Guide Page 79 Authoring Fundamentals

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Specify audio display properties

You can specify properties associated with how an audio file is displayed in a browser via the appropriate dropdown menu in the audio element properties, as shown below. 1. Change the audio file associated with the element 2. Specify target outputs and/or audiences for the element 3. Specify height and width (in pixels) of the audio element for when it loads in the browser 4. Specify whether an audio file starts automatically once it loads in the browser 5. Specify whether the audio controls are displayed (play/pause, stop, etc)

Audio element properties - browser display settings

Page 80 Studio Editor User Guide Authoring Fundamentals

Specify text to display with an audio object

From the floating audio toolbar, you can add the following text objects:

 Audio Title

 Audio Caption

 AV Script

Audio element floating toolbar

Adding narrative text to an audio object (step-by-step)

You can add narrative text, or a script, to an audio object for reference or for Accessibility compliance. The following procedure illustrates how to add a narrative script to audio objects.

1. Select the AV Script tab from the audio object in the editing pane and enter script text in the rich text field provided

2. To enter scene-specific narration, select the AV Script icon from the floating audio toolbar or Scene from the +Insert dropdown menu in the content editing toolbar

a Enter script text and scene notes for each scene in the fields provided

3. Enter the text of the script in the rich text field provided

Studio Editor User Guide Page 81 Authoring Fundamentals

Flash Objects

A Flash Object element lets you add Adobe Flash animations to your content. Flash objects will be rendered in web-based courses and performance support outputs; they are filtered out of print-based publications.

Flash objects can be added to your document via the content editing toolbar. All media objects used in your Studio documents must be stored in the Media Drive.

You can upload media at any time via the Media Manager or at the time you insert a media object into your document.

Instructions to upload media objects via the Media Manager can be found in Upload Media to the Media Manager (step-by-step).

Instructions to upload a media object at the time of inserting the Flash object element are included in the Inserting a Flash object (step-by-step) procedure.

Insert a Flash Object

There are two ways you can insert a Flash object in a document: 1) If the file is already stored on the Media Drive, you can select it from the Select Media Resource window

Page 82 Studio Editor User Guide Authoring Fundamentals

2) If the file needs to be uploaded, you can do so from the Select Media Resource window at the time you insert the element

Inserting a Flash Object (step-by-step)

1. Place your cursor in the location where you want to add the file and select the Flash icon from the +Insert dropdown menu in the content editing toolbar.

2. Locate the media object from the Select Media Resource pop-up window

a If the object needs to be uploaded to the Media Drive, select Upload in the selection window

b From the pop-up window that appears, browse and select the file to upload and select OK

3. Select the media object (2) and select OK (3)

Studio Editor User Guide Page 83 Authoring Fundamentals

4. If applicable, select Add to insert media assets and/or media asset folders that accompany the object in the Insert related media pop- up window

a Select the media object or folder to add and select OK

b Repeat the previous step for each media asset you wish to add and select Insert when finished

Change the Flash file used in a Flash object element

When you initially insert a Flash object element, you'll be asked to select the file to use at that time. If you need to change the Flash file, it can be done from the Flash element properties pane, as shown below:

Page 84 Studio Editor User Guide Authoring Fundamentals

Flash object element properties - change Flash file (with annotation)

This will launch the Insert related media window. In this window, you can:

 Edit the Flash file to use for the Flash element

 Add/remove any related media assets associated with the file

Insert related media window (with annotation)

Studio Editor User Guide Page 85 Authoring Fundamentals

Add related media to a Flash object element

When you initially insert a Flash object element, you'll be able to add related media assets at that time. If you need to change the Flash file or any of its related assets, this can be done within the Flash element properties pane. Select Browse from the element properties to open the Insert related media window.

Flash object - Insert related media

Adding related media to a Flash object element (step-by-step)

1. Activate the element properties pane for the Flash object by selecting the object in the content editor and then selecting Flash Object in the breadcrumbs

Page 86 Studio Editor User Guide Authoring Fundamentals

2. Select the Browse button from the element properties pane

3. Select Add to insert media assets and/or media asset folders that accompany the Flash object in the Insert related media pop-up window

a Select the media object or folder to add and select OK

b Repeat the previous step for each media asset you wish to add and select Insert when finished

Studio Editor User Guide Page 87 Authoring Fundamentals

Upload a Flash file to the Media Drive

Flash objects (.swf files) can be added to your document via the content editing toolbar. All media objects used in your Studio documents must be stored in the Media Drive.

You can upload media at any time via the Media Manager or at the time you insert a media object into your document.

Instructions to upload media objects via the Media Manager can be found in Uploading Media to the Media Manager in the Quick Start Guide.

Instructions to upload a media object at the time of inserting the Flash object element are included in the Inserting a Flash object (step-by-step) procedure.

Specify Flash object display properties

You can specify properties associated with how a Flash file is displayed in a browser via the appropriate dropdown menu in the Flash file element properties, as shown below: 1. Change the Flash file associated with the element 2. Specify whether a Flash file starts automatically once it loads in the browser 3. Specify whether the Flash player controls are displayed 4. Specify whether the file must be played completely before continuing 5. Specify whether text should be wrapped around the object 6. Specify alternative text to be displayed 7. Object caption to be displayed 8. Specify target audiences and/or outputs 9. Specify height and width (in pixels) of the Flash element when it loads in the browser

Page 88 Studio Editor User Guide Authoring Fundamentals

Flash object display properties (with annotation)

Images - Figures, Inline Images, Icons

You will most likely want to add images in various places throughout your documents. In Studio you can add them inline with text in a paragraph, as stand alone objects, and you can use different images and/or properties for different content outputs.

This topic will cover the following tasks related to authoring images in your documents:

 Inserting an image

 Uploading images to the Media Drive

 Changing the size of an image

 Changing the image of a figure element

 Adding a caption for the image

 Specifying unique properties for different outputs

 Wrapping text around an image

 Adding content for accessibility

 Specifying production notes

 Adding an inline image within the text of a paragraph

 Adding icons

Studio Editor User Guide Page 89 Authoring Fundamentals

 Managing SVG images

 Adding an image overlay to an image

The following image file types are currently supported in Studio Editor: .bmp, .gif, .jfif, .jpg, .png, .tiff and SVG

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Insert an Image

There are two ways you can insert an image file in a document: 1) If the file is already stored on the Media Drive, you can select it from the Select Media Resource window 2) If the file needs to be uploaded, you can do so from the Select Media Resource window at the time you insert the element

Inserting an Image (step-by-step)

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

1. Place your cursor in the location where you want to add the image and select the Figure icon from the content editing toolbar

Page 90 Studio Editor User Guide Authoring Fundamentals

2. Choose an image file from the Select Media Resource window

a If the image needs to be uploaded to the Media Drive, select the Upload icon in the Select media resource window

b Select Choose File, select the image to upload and select OK

3. Select the media object and select OK

 A figure element will be added to your document, and the default rendition type will be Web. To add more renditions, see the Specify unique properties for different outputs topic.

Upload an Image to the Media Drive

In order to select media to add to your figure element, the media must be stored in the Media Drive. This can be done via the Media Manager or when

Studio Editor User Guide Page 91 Authoring Fundamentals you insert an image into your document.

Instructions to upload the media object when inserting an image are included in Inserting an Image.

For instructions on uploading images to the Media Drive, please refer to Upload Media to the Media Manager (step-by-step) in the Quick Start Guide.

Change the size of an image

The size of an image can be changed manually in the figure element properties pane by modifying the height/width of the image.

You may also change an image's thumbnail size by selecting one of the sizing icons in the Media floating toolbar as shown below. This will change how the image is displayed in the editor only. It will not affect how the image is displayed when published.

Page 92 Studio Editor User Guide Authoring Fundamentals

Media menu annotating thumbnail sizing options

Studio Editor User Guide Page 93 Authoring Fundamentals

Changing the size of an image (step-by-step)

1. Select the image to edit in the content editor

2. Select the rendition name (eg., Web) in the breadcrumbs to activate the element properties pane

3. Enter values in the Width and/or Height fields under the Dimensions heading

4. Select Save and close to save changes and exit the properties pane or Cancel to close without saving changes

Change the image for a figure element

When you initially insert an image, you'll be asked to select the image file to use at that time for each rendition. If you need to change the image, it can be done within the figure element properties pane for the selected rendition, as shown below:

Page 94 Studio Editor User Guide Authoring Fundamentals

Figure element properties pane for web renditions (with annotation)

Add a border to an image

You can add a border to a figure element via the figure's element properties pane. Simply select the image in the content editor, select Figure (as opposed to the rendition type) in the breadcrumbs to activate the element properties pane.

Figure element properties (with annotation)

Please note: the border selected will apply to all renditions (i.e., web, print, etc) of the figure.

Studio Editor User Guide Page 95 Authoring Fundamentals

Add a caption to an image

Including a Caption with a figure element allows you to add a short description that will be displayed directly below the image.

Adding a caption to an image (step-by-step)

1. Select the image to which you wish to add a caption

2. Select the Caption icon from the Media menu in the content editing toolbar

3. Insert text for the caption

4. Select anywhere outside the caption to save

Page 96 Studio Editor User Guide Authoring Fundamentals

Specify unique properties for different outputs

It is common with Single Source Projects to use different outputs (such as web and print) and possibly have a need for different images for each one. This is managed in the editing pane within the Figure element, as shown below:

Supported figure outputs

When you add a Figure element, the default rendition type is Web. To add media for additional output types: 1. Select the Figure element from within the content editor 2. Select the rendition type within the media object (i.e., Print) 3. Select the media object to use for the selected rendition 4. Set properties for each rendition type as needed

Specifying the source file for a group of images is done from the floating Media toolbar.. The media toolbar becomes active when you select a media object in the content editor. All figure rendition types are also displayed when you select the media

object.

Studio Editor User Guide Page 97 Authoring Fundamentals

Wrap text around an image

Wrapping text around an image is set in a Figure's Media Object element. The text that follows a wrapped media object will be rendered to the left or right of it when the document is published. To set an end to wrapped text, you can add an End Wrap token element. Any text authored in the rich text block after this element will continue as normal paragraph text.

You can select how to wrap text around an image from the floating Media toolbar. The Media toolbar becomes active when a figure element is selected in the content editing pane. The default setting is No Wrap. To change to wrap left or right, select the option from the Wrap menu as shown below:

Page 98 Studio Editor User Guide Authoring Fundamentals

Media menu - wrap text options (with annotation)

Studio Editor User Guide Page 99 Authoring Fundamentals

End text wrapping for an image

When wrapping text around an image, authors can set a location within the text block where the text wrapping should end. Subsequent text in the text block will continue as normal paragraph text. The location is tagged with an End Wrap token.

To insert an End Wrap token, select the location in the rich text block and then select the End Wrap icon from the References dropdown menu from the content editing toolbar:

Content editing toolbar - References (with annotation)

An indicator will be inserted into the text block, as shown below:

End Wrap token indicator (with annotation)

To remove an End Wrap token, select the indicator and then select Remove from the pop-up window

Add content for Accessibility

If you are creating content for users who are handicapped or may otherwise be impaired, you can add accessibility content to your figure. This is done in the Figure element's properties pane shown below:

Page 100 Studio Editor User Guide Authoring Fundamentals

Accessibility options for figure elements (with annotation)

Specify production notes

Production notes for an image can be added in the figure's element properties pane. Simply enter your notes in the Production Note field outlined below:

Figure element properties - production notes

Studio Editor User Guide Page 101 Authoring Fundamentals

Insert an image inline with text in a paragraph

Sometimes you may want to insert a small thumbnail-sized image so that it is inline with your text rather than having it displayed before or after a paragraph. In this case, you can insert an "inline image" in a rich text block.

Inserting an image within a paragraph (step-by-step)

To insert an image that is inline with the text of a paragraph, follow the steps below:

1. Place your cursor in the location in the rich text block where you want to add the image

2. Select the Inline Image icon from the content editing toolbar

3. From the Select Media Resource window, choose an image and select OK

Icons

Icons can be added to many different authoring elements throughout your document. When an icon is added to an element, it will typically be displayed in the top left margin of the element. Icons can be added to elements at the Topic level and lower in the hierarchy; they are not supported in lessons or modules.

To ensure your icons display at the beginning of a section properly, be sure each icon element is the top-most child element contained in the element to which it belongs.

Page 102 Studio Editor User Guide Authoring Fundamentals

Icons can be added to many different authoring elements throughout your document, such as:

 Cover page

 Topics

 Procedures

 Steps of procedures (action block elements)

 Para Blocks/Rich Text blocks

 List Items

 Custom notes

Icon added to a rich text block in the content editor

Studio Editor User Guide Page 103 Authoring Fundamentals

Icon displayed in a rich text block in print preview

Add an icon (step-by-step)

Select the location where you would like to add the icon, like a topic or para block.

1. Select Icon from the +Insert dropdown menu in the content editing toolbar

2. Choose an image and select OK

Change the size of an icon The image and thumbnail sizes of an icon can be changed in the icon element properties pane.

Changing the size of an icon (step-by-step)

1. Select the properties gear icon to display the element properties pane

2. Enter the desired width and height values:

Page 104 Studio Editor User Guide Authoring Fundamentals

1. To modify the image size for an output, enter values in the Width and/or Height fields under Dimensions

2. To modify the size of the image as it appears in the content editor, enter values for the Width and/or Height fields under Thumb Dimensions

To keep the aspect ratio for either dimensions, select Keep Aspect Ratio and enter a value in only one field, such as Width. The Height field will automatically be populated based on the value you entered in the Width field.

3. Select Save and Close to save changes and exit the properties pane or Cancel to close without saving changes

Change an icon image When you initially insert an icon, you will be asked to select the image file to use. If you need to change the icon image, it can be done within the element properties pane for the icon, as shown below:

Studio Editor User Guide Page 105 Authoring Fundamentals

Icon element properties pane

SVG Images

SVG files can be added to a document everywhere that other image formats can be inserted. This allows an author to utilize scalable vector graphics in the content they create. Like other image types, thumbnail previews of the SVG images will appear in the Media Manager and within a document when it is inserted. Procedures for inserting, uploading and editing SVG images are similar to the procedures for other image file types. These procedures can be found in the Images- Figures, Inline Images, Icons topic.

Page 106 Studio Editor User Guide Authoring Fundamentals

Example of .svg image in the Media Manager

Note: The use of SVG images as a base image or image overlay in elements such as Image Map, Hotspot etc. is not supported at this time.

Image Overlay Editor

Overview

The Image Overlay Editor allows users to create overlay objects that are associated with images when a document is published. These overlays are specific to each rendition of a Figure element, and there can be one overlay per rendition.

The following image includes the Image Overlay Editor icon as shown in the floating media toolbar:

Studio Editor User Guide Page 107 Authoring Fundamentals

Media toolbar - Image Overlay Editor icon (with annotation)

Page 108 Studio Editor User Guide Authoring Fundamentals

The following image overlay types are supported in the Image Overlay Editor:

 Rectangle

 Line

 Circle

 Image

 Text

 Callout

Add an overlay object to an image The Image Overlay Editor allows users to create overlay objects that are associated with images when a document is published. These overlays are specific to each rendition of a Figure element, and there can be one overlay per rendition.

The following image includes the Image Overlay Editor icon as shown in the floating media toolbar:

Studio Editor User Guide Page 109 Authoring Fundamentals

Media toolbar - Image Overlay Editor icon (with annotation)

Page 110 Studio Editor User Guide Authoring Fundamentals

The following image overlay types are supported in the Image Overlay Editor:

 Rectangle

 Line

 Circle

 Image

 Text

 Callout

Adding an overlay object to an image (step-by-step)

Before attempting this procedure, be sure the image is added to your document for the appropriate rendition, and the rendition is selected in the content editor.

1. Select the image you want to be associated with overlay and select the appropriate rendition from within the Figure element in the content editor:

Studio Editor User Guide Page 111 Authoring Fundamentals

2. Select the Image Overlay Editor icon

 The Image Overlay Editor opens in a pop-up window

3. Configure your overlay object(s) and select OK

 The Image Overlay Editor window closes and when the screen refreshes, the image will have an indicator displayed in the content editor:

Page 112 Studio Editor User Guide Authoring Fundamentals

Edit an overlay object To edit an overlay object, select the image containing the overlay object, and select the Image Overlay Editor icon from the floating Media Toolbar

Studio Editor User Guide Page 113 Authoring Fundamentals

Media toolbar - Image Overlay Editor icon (with annotation)

Page 114 Studio Editor User Guide Authoring Fundamentals

Editing an overlay object (step-by-step)

Before attempting this procedure, be sure the appropriate image rendition is displayed in the content editor for the image overlay you wish to modify.

1. Select the image containing the overlay object in the content editor

2. Select the Image Overlay Editor icon from the content editing toolbar

3. To edit an existing overlay object:

a Select the object you wish to modify, making sure the four axis points are displayed, as highlighted below inside the red box:

b Make changes and select OK to save and close

4. To delete an overlay, select the object overlay and then select the Delete icon, as highlighted below inside the red box:

Studio Editor User Guide Page 115 Authoring Fundamentals

Page 116 Studio Editor User Guide Authoring Fundamentals

Insert image behavior properties for an image

For web outputs you can set a particular image behavior for images. The following image behaviors are currently supported:

 Blank (default)

 Pop-up – This setting will initally display an image in the size of the Thumbnail setting. – Clicking on the image will show the image in full size.

 Xref – Clicking on the image will display the cross-referenced topic in a popup widow.

 Href

– Clicking on the image will open a website in a new browser tab. Insert image behavior properties to an image (step-by-step)

1. Select the Figure element and activate the element properties pane by clicking on the Figure tab in the breadcrumbs

2. Select an option from the Image Behavior dropdown menu

Studio Editor User Guide Page 117 Authoring Fundamentals

3. Select Save and close to save changes or Cancel to discard them

Movies

Movie files can be added to your document from the content editing toolbar. All media objects used in your Studio documents must be stored in the Media Drive.

You can upload media at any time via the Media Manager or at the time you insert a media object into your document.

Instructions to upload the media object via the Media Manager can be found in the Upload Media to the Media Manager (step-by-step).

Instructions to upload the media object at the time of inserting the movie object element are included in the Inserting a movie file procedure.

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Page 118 Studio Editor User Guide Authoring Fundamentals

Insert a movie object

There are two ways you can insert a movie object in a document: 1) If the file is already uploaded to the Media Drive, you can select it from the menu 2) If the file needs to be uploaded, you can do so at the time you insert the Movie object

Inserting a movie file (step-by-step)

1. Place your cursor in the location where you want to add the file and select the Movie Object icon from the content editing toolbar

2. Choose the media object from the Select Media Resource pop-up window

Studio Editor User Guide Page 119 Authoring Fundamentals

a If the image needs to be uploaded to the Media Drive, select Upload Media in the selection window

b From the pop-up window that appears, browse and select the image to upload and select OK

3. Select the media object (2) and select OK (3)

Insert an embedded movie object

Movie objects from external sources such as Vimeo and YouTube can be embedded into your document and played in online courses. The image below is an example of an external movie object embedded into a document in Editor.

Embedded movie object authored in Studio

Studio will validate the code entered for YouTube and Vimeo videos to make sure they are correct. If a URL link to YouTube or Vimeo is entered, it will be converted to a valid embed code.

Page 120 Studio Editor User Guide Authoring Fundamentals

Adding an embedded movie object (step-by-step)

1. Place your cursor in the location where you want to add the file and select the Movie Object icon from the content editing toolbar

2. Select the External Movie tab (1) in the Choose Media pop-up window when it opens

3. Paste the embed code for the external movie into the available box (2) and select OK (3)

Studio Editor User Guide Page 121 Authoring Fundamentals

If you do not have an embed code to enter in this field for a YouTube or Vimeo video, you can enter the URL link for the video and Studio will convert it to a valid embed code.

Upload a Movie file to the Media Drive

All media objects used in your Studio documents must be stored in the Media Drive. You can upload media at any time via the Media Manager or at the time you insert a media object into your document.

Instructions to upload the media object via the Media Manager can be found in the Upload Media to the Media Manager (step-by-step).

Instructions to upload the media object at the time of inserting the movie object element are included in the Inserting a movie file procedure.

The following movie file types are currently supported in Studio Editor: .avi, .flv, .mov, .mp4, .wmv, .m1v/.mpeg-1, .m2v/mpeg-2, .mpeg, .mpg, .ogg, .ogv, and .webm

While Editor supports a number of different media formats, we recommend you use the following for maximum compatibility across outputs and devices:

 Audio: .mp3

 Video: .mp4 (H.264 encoding)  Images: .jpeg, .png, .svg

Change a movie's display dimensions

The height and width of the movie with regard to how it displays in a browser can be changed in the movie object properties pane.

Page 122 Studio Editor User Guide Authoring Fundamentals

Changing the display dimensions of a movie object (step-by- step)

1. Select the properties gear icon next to the movie file in the editing pane to activate the element properties pane

2. Enter the desired width and height values (in pixels):

Movie object properties - display dimensions (with annotation)

3. To save your changes, select Save and Close

Change the file used in a movie object

When you initially insert a movie object, you'll be asked to select the movie file to use at that time. If you need to change the movie file, it can be done within the properties pane for the movie object, as shown below:

Studio Editor User Guide Page 123 Authoring Fundamentals

Movie object properties - change movie file (with annotation)

Wrap text around a movie object

You can select how to wrap text around a movie object from the floating movie toolbar shown below. This toolbar is activated when a movie object is selected in the content editing pane.

Movie floating toolbar menu - wrap text

Specify movie display properties

You can specify how a movie displays in the browser via the following settings located in the movie element properties pane, as shown below: 1. Specify whether the movie automatically starts playing once it's displayed/launched in a browser 2. Specify whether or not to display movie controls (play/pause, etc)

Page 124 Studio Editor User Guide Authoring Fundamentals

Movie object properties - browser display settings

Specify text to display with a movie object

From the floating movie toolbar, you can add the following text objects to your movie:

 Movie Title

 Movie Introduction

 Instructions

 Movie Caption

 AV Script

Movie element floating toolbar

Studio Editor User Guide Page 125 Authoring Fundamentals

Adding narrative text to a movie object (step-by-step)

You can add narrative text, or a script, to a movie object for reference or Accessibility compliance. The following procedure illustrates how to add a narrative script to movie objects.

1. Select the AV Script tab from the movie object in the editing pane

2. Select the AV Script icon from the floating movie toolbar

a To enter scene-specific narration, select Scene from the +Insert dropdown menu in the content editing toolbar

3. Enter the text of the script in the rich text field provided

PDF Files

PDF files can be embedded in Studio documents as a child of Topic. When the Studio document is published, the entire PDF document will be published at the point in which it was inserted in Editor.

From the content editing toolbar, select PDF from the Insert+ dropdown menu and select the PDF file from the media manager.

Page 126 Studio Editor User Guide Authoring Fundamentals

Content editing toolbar (with annotation)

Edit PDF file embedded in a document

To edit the PDF file used in a Studio document, select Embedded PDF from the breadcrumbs at the bottom of the editor to activate the element properties pane and select Browse to change the file.

Embedded PDF element properties pane (with annotation)

Custom Notes

Custom notes are special call-out boxes that you can add to your documents when you want to call special attention to something about your content, such as warnings, tips, special instructions, etc.. You can add images to the custom note (such as a red exclamation point for a warning) as well as include a list or table to the text of the note.

Custom notes can be added to a document via the content editing toolbar.

Studio Editor User Guide Page 127 Authoring Fundamentals

The first image below is of a custom note authored in Studio Editor, and the second image is the same note displayed in a print preview:

Custom Note authored in Studio Editor

Print preview of a custom note

Why use a custom note?

While custom notes are certainly not required, they can greatly enhance your document, specifically when special attention needs to be called to a particular exercise or subject area. Custom notes are commonly used for tips, special notes, instructions, warnings and the like.

Page 128 Studio Editor User Guide Authoring Fundamentals

Insert a Custom Note

Custom notes can be added to a document via the content editing toolbar. You can use custom notes to call out special instructions or draw special attention to certain facts about a subject.

Inserting a custom note (step-by-step)

1. Place your cursor in the location where you want to add the note, and select Custom Note from the content editing toolbar

2. Choose an image to use for the custom note icon from the Select Media Resource pop-up window

a If the image needs to be uploaded to the Media Drive, select Upload Media in the selection window

Studio Editor User Guide Page 129 Authoring Fundamentals

b From the pop-up window that appears, browse and select the file to upload and select OK

3. Select the media object (2) and select OK (3)

4. Enter the text of your note in the rich text field

a You can also add a list or a table to the custom note by selecting the appropriate option on the content editing toolbar while the custom note is selected in the content editor.

Define the Layout of a custom note

You can define the layout of a custom note by managing the height and width of the object or selecting a specific theme to use for it. If you use an icon for the custom note, you can also manage its size as well as add LOM to it.

As shown below, you can add various layout properties to the custom note via the element properties pane. To activate the properties pane, select the gear icon next to the custom note element in the content editor.

 Custom Note Theme: select a theme from the dropdown menu to be applied to the custom note

 IsPopUp: select true from the dropdown menu if you want the custom note to display as a pop-up window; default option is false

 Dimensions | Width and Height: add these elements to manage the size of the custom note in relation to how it displays when published

 Filter Metadata: select target output and/or audiences for the custom note

Page 130 Studio Editor User Guide Authoring Fundamentals

Custom note element properties

Defining the properties of a custom note icon

If you use an icon for the custom note, you can manage its size in relation to how it displays when published. You can also add LOM to the icon.

As shown below, you can add layout properties for the custom note icon via the element properties pane. To activate this pane, select the gear icon associated with the custom note icon in the content editor

Studio Editor User Guide Page 131 Authoring Fundamentals

Custom note icon properties

Publishing a custom note for a targeted audience or output

Custom notes can be set up so that they are published only for specific audiences or outputs. For example, you may have a note that is only relevant to a classroom instructor and not for the students. You can set the properties of the custom note so that it only displays in an instructor guide.

Below is a display of the custom note properties pane where you set these parameters:

Page 132 Studio Editor User Guide Authoring Fundamentals

Custom note properties

Procedures

As a child of a Topic, Procedures allow you to add formatted step-by-step instructions for a task, leading to a desired result. These are the "how-to's" of a document, providing clear and succinct instructions to a user.

Typical components of a procedure include:

 Title and Intro paragraph

 One or more Step Groups

 Numbered steps property (yes/no options)

 Animated steps property - for online courses and production schedules (yes/no options)

 Step elements - Add text/instructions, supporting objects and sub- steps

In addition to entering text and substeps to each step, you may add other supporting objects such as images, videos, slides, etc.; allowed objects are active in the content editing toolbar.

Below is an example of a procedure authored in Studio Editor:

Studio Editor User Guide Page 133 Authoring Fundamentals

Procedure authored in Studio Editor (with annotation)

Shown below is an example of the same procedure previewed in a print output:

Page 134 Studio Editor User Guide Authoring Fundamentals

Procedure in print preview

Below is a description of the current menu options available in the floating Procedure toolbar:

Floating Procedure toolbar

Studio Editor User Guide Page 135 Authoring Fundamentals

Procedure Menu Options

Procedure menu Element Name Description Icon

Introduction (Optional) You may add an introduction element to any step group

Titled Block (Optional) Titled Para Block, can be added before or after a step group

Step Group Required to add steps to the procedure; included in a newly added procedure element

Step Group Title Optional

Step Contains an action block with a rich text block to add the written instruction for the step

SubStep A step within a step (optional and you can have more than one)

Response Block The expected result or action of performing the given step; can contain a description as well as an example

Page 136 Studio Editor User Guide Authoring Fundamentals

Procedure menu Element Name Description Icon

Demonstration Add a demonstration to the procedure

Internal Resource Add a resource pertaining to the procedure contained in the current document

External Resource Add a resource pertaining to the procedure not contained in the current document

Example (Optional) Example (e.g.

figure) related to the step

Icon Can be added to appear next to the entire

procedure, the introduction and/or a titled block

Procedure menu options

What is a Step Group?

A Step Group is the main building block within the procedure element. It is included in a new procedure element added to a document. It also contains procedure attributes which allow you to select whether or not the steps should be numbered and/or animated.

You can add more than one step group to a procedure element if you have two or more sets of steps that need to be followed pertaining to the procedure topic.

Studio Editor User Guide Page 137 Authoring Fundamentals

Each Step Group contains one Step element and a Step Group Title element by default. Additional steps can be added from the Procedure menu in the content editing toolbar.

Adding Step-by-Step Instructions to a document

You can add step-by-step instructions to a document in one of two ways:

Select the Procedure icon from the content editing toolbar:

OR select Procedure from the Add Structure dropdown menu:

A procedure element is added with a Title element and a Step Group element with one Step element, and the floating Procedure toolbar is activated.

Page 138 Studio Editor User Guide Authoring Fundamentals

Adding Steps

To add additional steps to your step group, select the appropriate icon from the floating Procedure toolbar:

Floating Procedure toolbar - Add Step icon (with annotation)

You can add figures, lists, etc to any action block within a Step element.

Adding Sub-steps to a Step in a procedure

To add a sub-step to a step, select the step from the step group and select the SubStep icon from the Procedure menu on the content editing toolbar:

Floating Procedure toolbar - Add SubStep icon (with annotation)

Formatting a procedure

In the Step Group element properties, you can select whether or not you want numbered steps. You also have the option to make the steps animated for a web output.

Studio Editor User Guide Page 139 Authoring Fundamentals

From the content editing pane, select the step group element within the procedure, and then select the properties gear icon.

Procedure Step Group properties (with annotation)

From within the properties pane, select True or False from the appropriate dropdown menus for each property.

Rearranging Steps (step-by-step)

If you need to reorganize any of the steps in your procedure, you can do so easily within the content editing pane.

1. Locate the step you wish to move

2. Select it so that it is highlighted in blue

3. Place your cursor over the highlighted blue portion of the step

Page 140 Studio Editor User Guide Authoring Fundamentals

4. Select the step and drag the green dotted line that appears to the desired position in the procedure

5. Select Move from the menu buttons that appear

Equations

Overview

Equations are authored in Studio using an equation editor. The Equation Editor allows Editors to author complex equations in Studio that are stored in MathML format for later processing. Editors may also author complex scientific diagrams with the Equation Editor. The Equation element is not a calculator, simply a means by which complex mathematical data can be authored and rendered.

The editor used in Studio is WIRIS editor. This editor is a mathematical WYSIWYG editor. More information about this editor may be found on their website. The user manual for WIRIS Editor can be found here.

The two images below represent an example of an equation authored in Studio and then published in a print output.

Equation authored in Studio

Studio Editor User Guide Page 141 Authoring Fundamentals

Equation published in print output

Insert an equation element (step-by-step)

MathML text can easily be pasted into the equation editor

1. Place your cursor in the location where you wish to add the element and select the Equation icon in the content editing toolbar

 The equation editor will open in a pop-up window

2. Author the equation

Page 142 Studio Editor User Guide Authoring Fundamentals

You may paste the MathML text if you have it available and the equation will automatically render in the window.

Modify an equation element

To edit an equation element, simply double-click on the element to open the equation editor.

To remove an equation element, select the menu icon to activate the element properties pane and select Delete from the Element Actions pane

Studio Editor User Guide Page 143 Authoring Fundamentals

Equation element actions pane (with annotation)

Insert an equation inline with text

Equations and formulas may be added alongside your rich text blocks. To insert an inline equation, select Inline Equation from the References dropdown menu in the content editing toolbar

Content editing toolbar (with annotation)

Please note: PowerPoint outputs will display the equation at the end of the text in a rich text block rather than directly inline with the text, so it is best to configure your inline equations so that they are at the end of a rich text block.

The following image provides an example of an inline equation authored in Studio Editor:

Page 144 Studio Editor User Guide Authoring Fundamentals

Inline Equation authored in Studio (with annotation)

Insert an equation inline with text (step-by-step)

1. Select Inline Equation from the References dropdown menu in the content editing toolbar

 The WIRIS equation editor will open in a pop-up window

2. Author the equation using the Equation Editor

Please note: if you have it, you can simply paste the MathML text into this box and the equation will automatically render.

3. To save the formula, select OK

Modify an inline equation

You can modify an inline equation simply by selecting it in the content editor.

When you select an inline equation in the content editor, an inline equation pop-up window appears. In this window, you can: 1. View the equation 2. Edit the equation - this will open the equation editor 3. Remove the equation from the text block

Studio Editor User Guide Page 145 Authoring Fundamentals

Inline equation pop-up edit window

Glossary

Overview

The Glossary of Terminology lists terms used in a particular domain of knowledge and the definitions for those terms. It is composed of Glossary Items (or Terms), and it can be authored as an individual document or added to a Single Source Project or Web Course.

Glossaries and glossary items for a document can be managed in the Glossary tab in the Content Editor.

This topic will go over:

 Glossary items (Terms)

 Creating a new glossary document

Page 146 Studio Editor User Guide Authoring Fundamentals

 Editing a glossary document

 Referencing a term from a glossary document in the current document

Glossary Items

In Studio Editor, "glossary items," or "inline terms," are used to provide definitions to terms used and/or introduced in your documents. In a document like a SSP or web course, these terms are typically linked to a string of text in a rich text block. In a printed document, a glossary can be printed at the end of the document that defines each of the terms, and in a web course, hovering over the term on a page displays the definition.

Terms can be added to a document in one of two ways:

 As a new inline term in a rich text block - the term remains native to the document

 Linked from a glossary document that has been added to the current document

Inline, or glossary, terms are elements you can add to a rich text block for words or phrases you may want to define within the text of a document. The images below illustrate an example of an inline term authored in Studio Editor, followed by the example previewed in print and web outputs.

Inline term authored in Editor

Studio Editor User Guide Page 147 Authoring Fundamentals

Inline term in print preview

Inline term in web preview with the term selected

Why use inline terms?

InLine Terms are particularly useful to help introduce new vocabulary to a mixed audience (in which some readers may be familiar with the term while others are not). Because they are not included in the main text of a document, those users who are unfamiliar with the term can select the blue underlined text (in a web course) to read more about the term, while more advanced readers can simply continue through the main content.

Please note: Print outputs must set the Print Publishing/Generate Glossary field to True to include InLineTerm definitions.

Page 148 Studio Editor User Guide Authoring Fundamentals

Adding an Inline/Glossary Term (step-by-step)

The text you wish to identify as an inline/glossary term must first be entered in the rich text block in your document.

1. Highlight the text you want to use for the term and select the Term icon from the content editing toolbar

2. In the pop-up window, enter the term and its definition and select OK

Create a Glossary Document (step-by-step)

1. From the Document Manager, select New Document > Glossary

2. Enter a name for the glossary document

 The new glossary document opens in the Content Editor

Studio Editor User Guide Page 149 Authoring Fundamentals

Edit a Glossary

If you add a glossary document to a current document in the Editor and wish to edit the glossary, you may do so within the current document as long as you have the glossary document checked out for editing. This can be done from the Glossary tab in the content editor. However, if the document is checked out by another user, or is not checked out by you, you will be unable to edit it.

Reference a term from a glossary document in the current document

If there are terms you want to include in your document that already belong to a public glossary document, you can add them to your document without the need to recreate them. When you add a public glossary to your document, you can access all of the glossary terms in the glossary document and easily link them to your current document in the Content Editor.

Add a glossary term from a glossary document to a current document (step-by-step)

Before attempting this procedure, please make sure you have done the following:

 Add the appropriate glossary document to your current document

 Make sure the desired term is included in the glossary document

1. Highlight the text you want to use for the term and select the Term icon from the content editing toolbar

2. In the pop-up window, type the term name in the Glossary Term field

 As you begin typing, a dropdown menu may appear suggesting existing glossary terms

Page 150 Studio Editor User Guide Authoring Fundamentals

3. From the dropdown menu, select the desired term

Note: If the term does not appear, check the glossary document to make sure the term is in the document

 The term and its definition will appear in the appropriate fields

4. Select OK

Spell Checker

Editor's spell check function allows you to check spelling for the entire current document. It contains a default dictionary based on current Locale. In order to run the spell checker, you must have the document checked out to you. To start Spell Checker, select the icon in the content editing toolbar. The spell checker is fairly straightforward to use.

When the Spell Checker is initiated, the Spell Check pop-up window appears, and the system will move through the document until a spelling error is found. When a potentially misspelled word is found, you will be

Studio Editor User Guide Page 151 Authoring Fundamentals presented with a list of suggestions from the default dictionary. Simply select one of the available options from the right side of the window: 1. Ignore Once - ignores this misspelling, but shows future misspellings that are the same as this one 2. Ignore All - ignores this misspelling through the remainder of this editing session for this document (specified by the session cookie) 3. Change Once - changes only the current misspelling to the highlighted suggestion 4. Change All - changes this misspelling and all future identical misspellings in this document to the highlighted suggestion

Spell Check window (with annotation)

The Reset button resets all "Ignore All" and "Change All" rules for the current document. Once the Spell Check is complete, a dialog box will be displayed. To exit Spell Check before it is finished, select Cancel to return to the document editor.

Cover Page for Web Course

Web courses authored in Studio Editor do not automatically include cover pages, though you can add a cover page to a web course as needed.

To add a cover page to a web course, simply select the Add Structure button in the editor and select CoverPage, as shown below:

Page 152 Studio Editor User Guide Authoring Fundamentals

Add Structure button - add Cover Page (with annotation)

When a cover page is added to a web course, a blank Title element is included. You can add a subtitle to the cover page as well as a Notice element. The Notice element can be used to enter text on the cover page such as a disclaimer or other important information.

Studio Editor User Guide Page 153 Authoring Fundamentals

This page intentionally left blank.

Page 154 Studio Editor User Guide

Lesson 2 Advanced Authoring

Cross References and Links

Cross References

Overview

Studio allows you to author two types of cross references in your documents: internal and external cross references.

An internal cross reference allows you to provide a link to a topic or procedure in your document or online course so learners can easily navigate to that area. An external cross reference allows you to provide a link to another lesson, topic or procedure from a different document in your document library for learners to access. In a web course, for example, if a user selects one of these links, a pop-up window will appear containing the contents of the referenced section. You can also navigate to the linked page from the pop-up window.

The following images illustrate an example of using an internal cross reference - first as it is authored in Studio Editor, followed by the example displayed in a web preview. External cross references appear the same as internal references.

Studio Editor User Guide Page 155 Advanced Authoring

Internal cross reference authored in Studio Editor

Internal cross reference in a web preview

Why should I use a cross reference in my document?

Cross references can be useful tools to have in your online courses for easy access to related content. You may not want a full step-by-step procedure included in the body of a lesson or topic, but you can make it available to the learner by adding a cross reference link to it.

They are also useful with PDF formats when the document is displayed in a PDF reader. When a user selects the link, the document jumps to the referenced topic.

Insert a Cross Reference from within the same document (step-by-step)

Be sure the text string you wish to use with the cross reference is already authored in the content editor.

1. Highlight the text you want to use to represent the link and select the Link icon from the content editing toolbar

Page 156 Studio Editor User Guide Advanced Authoring

2. Select the Current Document tab from the Insert Link window and select the object to link from the document outline

3. When the content loads in the right panel, select it and then select Update

Studio Editor User Guide Page 157 Advanced Authoring

Please note: In the above example, a lesson was selected from the left panel and then a topic from that lesson was selected in the right panel. The topic is the object being linked. This is confirmed in the breadcrumbs available in the Insert Link

window's right panel.

Insert a Cross Reference from a different document (step-by- step)

Be sure the text string you wish to use with the cross reference is already authored in the content editor. The cross referenced content must be in a document that is available in your Document Library.

1. Highlight the text you want to use to represent the link and select the Link icon from the content editing toolbar

Page 158 Studio Editor User Guide Advanced Authoring

2. Select the Document Library tab from the Insert Link window

3. Enter some relevant text in the Search bar, select an object type from the dropdown menu, and launch the Search

4. When content loads in the left panel, scroll to the object you wish to link and select it

5. When the content loads in the right panel, select the precise object you wish to link and then select Update

Studio Editor User Guide Page 159 Advanced Authoring

window's right panel.

Modify cross references

Cross reference links can be edited or deleted once created. Editors can change web links to internal or external cross references and vice versa.

Edit a cross reference link (step-by-step)

1. Select the cross reference link from the content editor to display the Inline Cross Reference window

Page 160 Studio Editor User Guide Advanced Authoring

2. Select Edit

3. Select a new target from the Insert Link pop-up window

When you select Edit, the Insert Link pop-up window will open, allowing you to change the cross-referenced object or modify the link entirely to a website address or an internal link to a document.

4. Select Update

Studio Editor User Guide Page 161 Advanced Authoring

Remove a cross reference link (step-by-step)

1. Select the cross reference link from the content editor to display the Inline Cross Reference window

2. Select Remove

 The highlighted text will become regular text and will no longer provide a cross reference

Glossary Items (Inline Terms)

Inline, or glossary, terms are elements you can add to a rich text block for words or phrases you may want to define within the text of a document.

Page 162 Studio Editor User Guide Advanced Authoring

The images below illustrate an example of an inline term authored in Studio Editor, followed by the example previewed in print and web outputs.

Inline term authored in Editor

Inline term in print preview

Inline term in web preview with the term selected

Studio Editor User Guide Page 163 Advanced Authoring

Why use inline terms?

Please note: Print outputs must set the Print Publishing/Generate Glossary field to True to include InLineTerm definitions.

Adding an Inline/Glossary Term (step-by-step)

The text you wish to identify as an inline/glossary term must first be entered in the rich text block in your document.

1. Highlight the text you want to use for the term and select the Term icon from the content editing toolbar

2. In the pop-up window, enter the term and its definition and select OK

Page 164 Studio Editor User Guide Advanced Authoring

Modifying an inline term

If you want to edit or remove an inline term: ◊ Select the highlighted text for the inline term in the content editing pane to activate the edit window

Modify Inline term pop-up menu

Studio Editor User Guide Page 165 Advanced Authoring

◊ Select Remove to remove the inline term association in the rich text block ◊ Select Edit to modify the text of the term or definition

Hot Text

Hot text elements are elements you can add to a rich text block for words or phrases you may want to call attention to within the text of a document. You can set them to display with either a click or a roll-over, which differentiates them from inline terms.

An example of an inline hot text element authored in Studio Editor is shown in the image below:

Inline Hot Text authored in Studio Editor (with annotation)

Inline Hot Text - web preview (with annotation)

Page 166 Studio Editor User Guide Advanced Authoring

Adding inline hot text (step-by-step)

The text you wish to identify as inline hot text must be entered in the rich text block in your document.

1. Highlight the text you want to use for the inline hot text and select the Hot Text icon from the References dropdown menu on the content editing toolbar:

2. In the pop-up window, select the trigger (i.e., rollover or click) from the dropdown menu, enter the text to be displayed at the trigger, and select OK

Studio Editor User Guide Page 167 Advanced Authoring

Modifying an inline hot text element

To modify inline hot text, select the highlighted text for the term in the content editing pane to activate the Hot Text pop-up menu and edit as desired:

Inline Hot Text pop-up edit menu

Linking to a Website

You can insert web links using the Insert Link feature. In interactive content, when a learner selects the web link, a new web browser will open navigating to the web address specified.

An example authored in Studio Editor is shown below, followed by previews in a print output and a web output:

Web link authored in Studio Editor

Page 168 Studio Editor User Guide Advanced Authoring

Web link previewed in a print output

Web link previewed in a web output

Insert a link to a website

Website links can be added to content when you wish to make a certain website available to a learner. When a learner selects the web link, a new web browser will open navigating to the web address specified.

Add a website link in a document (step-by-step)

1. Highlight the text you want to use to represent the link and select the Link icon from the content editing toolbar

2. Select Web Link from the Insert Link pop-up window

Studio Editor User Guide Page 169 Advanced Authoring

3. Enter the website address in the field provided and select Update

Modify a link to a website

You can modify a web link by activating the element's pop-up edit window shown in the image below:

From the web link pop-up edit window, you can: 1. View the website address 2. Edit the web link 3. Remove the web link

Page 170 Studio Editor User Guide Advanced Authoring

Web Link pop-up edit window

When you select Edit, the Insert Link pop-up window will open, allowing you to change the website address or modify the link entirely to an internal or external cross reference or an internal link to a document.

Internal Links to Documents

An internal link allows you to provide a link to selected types of documents located in the media library. In a web course, for example, if a user selects this link, a pop-up window will appear allowing the user to save a copy of the linked document to their computer.

Supported types include: .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .zip, .rar, .notebook, .dat, .tz

The following images illustrate an example of using an internal link, first as

Studio Editor User Guide Page 171 Advanced Authoring it is authored in Studio Editor, followed by an example of the internal link displayed in a web preview.

Internal link authored in Studio Editor

Internal link previewed in a web course

Why should I use an internal link in my document?

Internal links can be useful tools to have in your online courses for easy access to related documents, such as study aids, without the content of that document taking up space in the online course.

Page 172 Studio Editor User Guide Advanced Authoring

Adding an Internal Link (step-by-step)

Be sure the text string you wish to use with the internal link is already authored in the content editor.

1. Highlight the text you want to use to represent the internal link and select the Link icon from the the content editing toolbar

2. Select Media Library from the Insert Link pop-up window

3. Select the document to link and select OK

 The selected text will be highlighted in the content editor.

Studio Editor User Guide Page 173 Advanced Authoring

Modify an internal link

Internal links can be edited or deleted once created.

Editing Internal Links (step-by-step)

1. Select the highlighted text to display the Internal Link window

2. Select Edit

3. Select a new target

When you select Edit, the Insert Link pop-up window will open, allowing you to change the media reference or modify the link entirely to an internal or external cross reference or a website address.

4. Select OK

Deleting Internal Links (step-by-step)

1. Select the highlighted text to display the Internal Link window

2. Select Remove

 The highlighted text will become regular text and will no longer link to a media object

Numbering Figures and Tables

The Auto-Number feature counts elements in a uniquely labeled sequence. Auto-Numbers can be applied to text fields in a Table or Figure, such as a figure caption or table caption element. This automatically labels such elements as Figure 1, Figure 2, and so on, allowing authors to reference them elsewhere in the document.

Auto-Numbers consist of two "tokens" - a source token and a reference token. The source token is associated with the figure or table object itself, and the reference token identifies/is tagged/associated with the source and

Page 174 Studio Editor User Guide Advanced Authoring is located where the figure or table is referenced in a rich text block.

The following images illustrate an example of using an Auto-Number, first as it is authored in Studio Editor, followed by an example of the Auto- Number displayed in a web preview.

Auto-Number authored in Studio Editor

Studio Editor User Guide Page 175 Advanced Authoring

Auto-Number in a web preview

Setting the Auto-Number Source Token for a Figure or Table

To set a figure as a "source" object, place your cursor in the location of the figure or table caption where you want the Auto-Number added and select the Numbered Item icon from the References dropdown menu on the content editing toolbar

Content editing toolbar (with annotation)

An Auto-Number token is added to the caption, identifying the figure or table as a numbered item "source" object

Page 176 Studio Editor User Guide Advanced Authoring

reference token

source token

Auto-Number Tokens (with annotation)

Setting the Auto-Number Reference Token for a Figure or Table

To reference a numbered figure or table, place your cursor in the area (such as in a text block) you wish to add the reference and select the Numbered Item Reference icon from the References dropdown menu on the content editing toolbar

Content editing toolbar (with annotation)

In the pop-up window: 1. Select the object type from the dropdown: Figure or Table 2. Select a reference element from the list (Only those elements that already have a source token will be listed) 3. Select Update

Studio Editor User Guide Page 177 Advanced Authoring

Select Numbered Item Reference pop-up window

A reference token will be added to the text block like the one shown below:

Page 178 Studio Editor User Guide Advanced Authoring

reference token

source token

Auto-Number Tokens (with annotation)

Modify an Auto-Number reference token

An auto-number reference token may be modified to reference a different source token.

Editing Auto-Numbers (step-by-step)

1. Select the Auto-Number reference object to display the Auto- Number Token window

2. Select Edit

Studio Editor User Guide Page 179 Advanced Authoring

3. Select a new Auto-Number target

4. Select OK

Deleting Auto-Numbers (step-by-step)

1. Select the Auto-Number reference object to display the Auto- Number Token window

2. Select Remove

 The Auto-Number object will be removed from the text block

Special Notes and Styles

Citations

Citations can be added throughout any single source project authored in Studio Editor. Citations can be added to any rich text, including rich text in footnotes.

For a print rendition, citations are displayed at the end of the document in a Bibliography. In web courses, citations are displayed in a resource tab.

Page 180 Studio Editor User Guide Advanced Authoring

Please note: Studio Editor supports multiple citation endnote types. Each type must be added by a Studio Administrator via the Master Metadata List. For more information, please refer to the Studio Admin Guide.

The first image below is an example of a citation authored in Studio Editor, followed by an example of a web output preview with the citation indicator selected to display the pop-up window:

Citation authored in Studio Editor

Citation in web preview

Add a Citation (step-by-step)

Be sure the text string you wish to cite is already authored in the content editor.

1. Select/highlight the text and select Citation from the References dropdown menu on the content editing toolbar

Studio Editor User Guide Page 181 Advanced Authoring

2. Enter the text of your citation in the Citation pop-up window

3. (Optional) Select a citation type from the dropdown menu

4. Select Update to close the window and save the citation

 The citation text will be saved and the selected text in the rich text block will be highlighted, as shown in the example below:

Page 182 Studio Editor User Guide Advanced Authoring

Modifying a citation

Once a citation is added to a document, you can view, edit or remove it as needed.

Select the highlighted text in the content editing pane to activate the citation pop-up window, as shown below, and select the relevant action.

Citation pop-up edit menu

Footnotes

Footnotes can be added throughout any single source project authored in Studio Editor. For a print rendition, the footnote will display as you would expect for written documents. In a web course, footnotes are displayed as asterisks in the text of the document; to view the footnote, users simply select the asterisk and the footnote will display in a pop-up window.

The first image below is an example of a footnote authored in Studio

Studio Editor User Guide Page 183 Advanced Authoring

Editor. The second image is an example of the footnote previewed in a print output, and the third is an example of a web output preview with the footnote indicator selected to display the pop-up window:

Footnote authored in Studio Editor

Footnote in print preview

Footnote in web preview

Page 184 Studio Editor User Guide Advanced Authoring

Why should I use footnotes in my document?

Footnotes are particularly useful for providing reference information for quotes, studies, or any other content in which additional information does not need to be included in the text of the document.

Add a Footnote (step-by-step)

Be sure the text string you wish to footnote is already authored in the content editor.

1. Place the cursor next to the text you want to footnote, and select the Footnote icon References dropdown menu on the content editing toolbar

2. Enter the text of your footnote in the Edit Footnote window and select OK

 The footnote text will be saved and a cross symbol will denote the footnote object in the rich text block, as shown in the example below:

Studio Editor User Guide Page 185 Advanced Authoring

Modifying a footnote

Once a footnote is added to a document, you can view, edit or remove it as needed.

Select the footnote indicator in the content editing pane to activate the footnote pop-up window, as shown below, and select the relevant action.

Footnote pop-up edit menu

Info Tab

Contributors

A list of Contributors can be added to a document as shown in the image below. Various information can be provided for each Contributor.

Contributors in Print Preview

The Contributor fields include: 1. Name - Required field 2. Role - Selected from a dropdown menu of options

Page 186 Studio Editor User Guide Advanced Authoring

3. Email 4. Phone Number 5. Fax 6. Address 7. Website

Add a Contributor (step-by-step)

1. Select the Info tab at the top of the document in Editor

2. Select Contributors

3. Select the Add Contributor Button

Studio Editor User Guide Page 187 Advanced Authoring

4. Enter the contributor information in the fields provided

NOTE: The Name field is the minimum requirement to be able to save a contributor

5. Select Save Changes

Page 188 Studio Editor User Guide Advanced Authoring

Delete a Contributor (step-by-step)

1. Locate the Contributor you wish to delete

2. Select the downward arrow icon to view the dropdown menu

3. Select Delete

4. Select OK to delete the Contributor or Cancel to return to the Contributor List

Edit a Contributor (step-by-step)

1. Locate the Contributor you wish to edit

2. Select the downward arrow icon to view the dropdown menu

Studio Editor User Guide Page 189 Advanced Authoring

3. Select Update

4. Make the desired changes

5. Select Save Changes to keep your changes or Close to discard them

Page 190 Studio Editor User Guide Advanced Authoring

If you select anywhere outside the Contributor Information box while creating a new Contributor or editing an existing one, the information entered will be automatically saved.

The Copyright Block is designed to contain copyright-specific data. Copyright Blocks are similar to Para Block elements and can be populated with various child elements. Copyright block templates can be created and then added to documents based on that template. For information regarding creating templates, please refer to Working with Templates. The information authored in the Copyright Blocks are on the Credits page as shown below:

Studio Editor User Guide Page 191 Advanced Authoring

Child elements of Copyright Block include:

 Rich Text

 Figure

 List

 Table

 Filter Metadata

Other data such as Copyright Date and an ISBN number can be included in the overall Copyright page. The Copyright Date is chosen by selecting a day from a dropdown calendar. The ISBN can be typed or copied and pasted into the field provided.

Add Copyright Text (step-by-step)

1. Select the Info tab at the top of the document in Editor

Page 192 Studio Editor User Guide Advanced Authoring

2. Select the Add Copyright button to add a blank Copyright text element

 A new Copyright Text element will appear in the Copyright Folder

3. Alternatively, select a template from the Copyright Templates dropdown

Delete Copyright Text Element (step-by-step)

1. Locate the Copyright Text Block you want to delete

2. Hover over the properties icon

3. Select Delete

Studio Editor User Guide Page 193 Advanced Authoring

4. Select OK to delete the Copyright Text Block

Add Child Elements to Copyright Text (step-by-step)

1. Select the Copyright Text element to which you wish to add content

2. Select any area in the editor to insert a new child element

3. Select the icon of the desired child element from the content editing toolbar

Page 194 Studio Editor User Guide Advanced Authoring

 The new element will be added to the document

Margin notes

Margin notes can be added throughout a single source project authored in Studio Editor. An example of this is displayed below:

Margin note authored in Studio Editor

For a print rendition, as displayed below, the margin note will display as a "pinned" note on the page:

Margin note previewed as a print output

Studio Editor User Guide Page 195 Advanced Authoring

For a web course, margin notes are displayed as "text bubbles," as shown below:

Margin note previewed as a web output

Adding a margin note (step-by-step)

The following steps pertain to adding a margin note for a block of text. Before completing these steps, select the rich text element that will be associated with the margin note.

1. Select Margin Note from the +Insert dropdown menu in the content editing toolbar

 A new margin note element will be inserted above the rich text element

2. Enter the text of your margin note in the field provided

Most of the same inline elements supported in a traditional rich text element are available when authoring a margin note.

Page 196 Studio Editor User Guide Advanced Authoring

Modifying a margin note

To modify a margin note, simply select the margin note element in the content editing pane and modify the text as needed.

Page Breaks

The Page Break element is inserted to instruct publishing engines to insert a page break between elements. Once inserted, the content directly below the Page Break element will appear on the next page. A Page Break may be inserted when any child of Parablock is selected in the Content pane. This includes elements such as: Rich Text, Lists, Figures, and any other valid child of the Parablock element.

The image below is an example of the use of a Page Break. On the left is a Publishing preview of a Lesson with two Topics not using any Page Breaks. On the right is the same document with a single Page Break inserted after the Rich Text under Topic 1.

Preview of Document without Page Break (left) and with Page Break (right)

Studio Editor User Guide Page 197 Advanced Authoring

Add a Page Break (step-by-step)

1. Select any element inside Para Block (Rich Text, List, Table, etc.) where you wish to insert the Page Break

2. Select Page Break from the +Insert dropdown menu on the content editing toolbar

 A grey dashed line is visible immediately after the chosen element to indicate a page break

Move a Page Break (step-by-step)

1. Select the Page Break element

2. Select and drag the element

 A green dashed line will appear where the element will be placed

Page 198 Studio Editor User Guide Advanced Authoring

3. Drop the Page Break element

 A dialog will appear asking if you wish to Move, Copy, Link or Cancel the Page Break

4. Choose one of the options from the dialog

 The chosen action will be executed and the document updated

Studio Editor User Guide Page 199 Advanced Authoring

Program Code

The Program Code element is useful when authoring technical documents that include programming code throughout the text of the document. This element allows your code text to be displayed in a specific manner that will make it stand out from regular text.

An example of a program code element authored in Studio Editor is shown below, followed by the same example displayed in a print preview.

Program code authored in Studio Editor

Program code print preview

When to use a Code semantic tag versus when to use a program code element

The program code element is ideal when you need to display several lines of code at a time or if you want to separate a line of code from text blocks.

Page 200 Studio Editor User Guide Advanced Authoring

The Code semantic tag is useful if you want to include programming code within a block of text yet differentiate it in the paragraph so that it stands out from the regular text.

Inserting Program Code

To insert a program code object, select Code from the +Insert dropdown menu on the content editing toolbar

Insert program code element

Quote Blocks

Quote block elements are designed to automatically format quoted text that is longer than a couple of lines. Quote block elements format your text so that it is indented according to general writing standards. Use this element for lengthy quotes, and use the quote semantic tag for shorter quotes.

An example of a quote block authored in Studio Editor is shown below, followed by the same example in a print preview:

Quote Block element authored in Studio Editor

Studio Editor User Guide Page 201 Advanced Authoring

Quote block in print preview

Using a Quote Block versus an inline Quotation semantic tag

Quote semantic tags are designed more for quote strings that are less than two lines of text, while a quote block is designed to format a longer string of text so that it is indented properly. A quote tag's default setting is to italicize the selected text, while a quote block indents the entire text contained in the element.

Therefore, we recommend using quote semantic tags for shorter quotes and quote blocks for longer quotes.

Insert a Quote Block

To add a quote block to a document, select Quote Block from the +Insert dropdown menu on the content editing toolbar.

Insert a quote block

Page 202 Studio Editor User Guide Advanced Authoring

Rule Lines

Rule Lines allow you to insert lines in a document so users can insert notes or comments. When you insert a rule line element, there is a Number of Lines field in which to enter the number of lines you wish to print at that particular point in the document.

Rule lines element authored in Studio Editor

Studio Editor User Guide Page 203 Advanced Authoring

Rule lines previewed in a print output

Adding Rule Lines (step-by-step)

1. Place your cursor in the location where you want to add rule lines to your document

2. Select Rule Lines from the +Insert dropdown menu on the content editing toolbar

3. Open the Element Properties pane and enter the number of lines to add

Page 204 Studio Editor User Guide Advanced Authoring

Rule lines element authored in Studio Editor

 Every new Rule Lines element contains three (3) lines by default

4. Select Save and Close to save changes or cancel to discard them

Tabbed Content

The Tabs element organizes content in a tabbed interface, where content is presented when a tab is selected. Tabbed content is a web-specific feature in Editor.

The two images below illustrate an example of a Tabs element authored in Editor and then previewed in web:

Studio Editor User Guide Page 205 Advanced Authoring

Tabs authored in Editor

Tabs in web preview

Page 206 Studio Editor User Guide Advanced Authoring

Why use tabs in a document?

The tabs feature allows you to place more information on a page without losing usability. You can present different content contained within a single window, using tabs to navigate between them.

Create tabs (step-by-step)

1. Select Tabs in the +Insert dropdown menu on the content editing toolbar

Authoring tabs (with annotation)

2. Enter a Label and corresponding text for each tab

3. Select the Plus sign in the editing pane to add more tabs

Studio Editor User Guide Page 207 Advanced Authoring

Set display properties for tabs

The display properties you can set for tabbed content in a document are illustrated below: 1. Display dimensions: Enter height/width for the tabs area to display when published 2. Orientation: Select Vertical or Horizontal to set the placement orientation for the tabs 3. Filter Metadata: Select specific outputs and/or audiences to view the tabbed content 4. MustBeCompleted: True value requires learner to read content prior to continuing in the course; default value is blank or False

Tabs Element Properties (with annotation)

Delete a single tab (step-by-step)

This procedure explains how to delete a single tab from a Tabs element containing more than one tab child element.

To delete the entire element of tabbed content, please refer to Delete an entire Tabs element (step-by-step).

Page 208 Studio Editor User Guide Advanced Authoring

Delete a tab (with annotation)

1. Select the tab to delete in the editing pane

2. Select the menu icon associated with the tab to activate the element properties pane

3. Select Tab in the breadcrumbs

4. Select the Element Actions menu (if necessary)

5. Select Delete from Element Actions

Delete an entire Tabs element (step-by-step)

This procedure explains how to delete an entire element of tabbed content from a document.

If you want to delete a single tab within a Tabs element, please refer to Delete a single tab (step-by-step).

Studio Editor User Guide Page 209 Advanced Authoring

Delete a Tabs element (with annotation)

1. Select the Tabs element in the editing pane

2. Select the menu icon associated with the element to activate the element properties pane

3. Select Tabs in the breadcrumbs

4. Select the Element Actions menu (if necessary)

5. Select Delete from Element Actions

Authoring Assessments

Assessments Overview

Studio and Studio Desktop, combined, provide a healthy variety of question types to assess end-users. The different examination formats are found in the Web Course and Single Source Project templates, as well as the Topic element. The Single Source Project template can be published in print or web outputs. The Web Course template lets you publish web-specific content.

Page 210 Studio Editor User Guide Advanced Authoring

Studio currently supports the following assessment types (for all others, please refer to the Studio Desktop User Guide):

 Bin Drop

 Drag and Drop

 Essay Activity

 Fill in the Blank

 Image Map Assessment

 Matching Activity

 Matrix

 Multiple Choice Questions

 Select HotText

 Sequence Activity Content

Bin Drop

The Bin Drop assessment is used to test knowledge by allowing users to drag potential answers into one of several "bins" or drop zones in an image. It also provides feedback to learners when they answer correctly or incorrectly.

The Bin Drop assessment is similar to the Drag and Drop assessment; however, instead of establishing a one-to-one relationship between the dragged object and its target, Bin Drop lets you establish an all-in-one relationship between a dragged object and its target.

Studio Editor User Guide Page 211 Advanced Authoring

Bin Drop Assessment in Studio Editor

Important components of Bin Drop Assessment outlined below are: 1. Base Image - over which either text or other images will be dropped 2. Drag Objects - Text or Images, each of which must be dropped onto a specific location on the Base image 3. Distractor Objects - Text or Images, considered "wrong answers" to distract the learner with incorrect answer alternatives 4. Bins - one or more geometric shapes where Drag Objects can be dropped

Page 212 Studio Editor User Guide Advanced Authoring

Bin Drop Assessment Editor (annotated)

Other optional components of Bin Drop Assessment

Element Description

Enter a recommendation offered as a Advice guide for the learner; it is rendered below the question

Enter detailed information instructing the Instructions learner how the activity should be completed; it is rendered in italic font below the question

Studio Editor User Guide Page 213 Advanced Authoring

Element Description

Enter the question, which can include text, Question Stem media, tables and lists; assessments come with this component already but if it is deleted at any point it can be readded

The Bin Drop Assessment is authored using an editor window. This allows specification of the bins, the answer choices and the location as to where they should be placed on the Base Image.

Add a Bin Drop Assessment to a Topic (step-by-step)

1. Select the location in the topic to add the question

2. Select the Bin Drop Assessment icon from the content editing toolbar

 The Bin Drop Assessment element will be added to the page and a pop-up window will appear to select a Base Image

3. Select a base image in one of two ways:

1. Select an image already in the Media Drive

2. Upload a new image

 The Bin Drop Assessment Editor will appear for you to author the assessment

Change an Image Map Base Image (step-by-step)

1. Select the Bin Drop Assessment in the editing pane

2. Select the properties gear icon to activate the element properties pane

Page 214 Studio Editor User Guide Advanced Authoring

Make sure Bin Drop is selected from the breadcrumbs

3. Select Browse to choose an image file

4. Choose or change the base image in one of two ways:

1. Select an image already in the Media Drive

2. Upload a new image

5. Select Save and Close to keep the changes or Cancel to discard them

Studio Editor User Guide Page 215 Advanced Authoring

Add Bins (step-by-step)

The three Hot Spot types are outlined here and shown in the image below:

1. Square - when chosen, a square Hot Spot will be added that can be moved and resized

2. Circle - when chosen, a circle Hot Spot will be added that can be moved and resized

3. Polygon - when chosen, a Hot Spot can be created with however many sides you wish

Various bin types outlined in Editor

1. Select the Edit icon from the floating Bin Drop toolbar to activate the Bin Drop Assessment Editor

Page 216 Studio Editor User Guide Advanced Authoring

2. Select one of the three bin types to be added using the various icons in the editor. If you select polygon, follow the sub-steps below:

a Select to add a new side connected to the previous point

b Right-click to stop drawing the bin and connect the last side with the first

3. To move a bin: Select and hold the yellow circle and place it in the desired location in the editor

Studio Editor User Guide Page 217 Advanced Authoring

4. To edit the size of a bin: Select and hold one of the yellow squares and drag it to the desired size

5. Select OK to save changes or Cancel to discard them

Adding and Editing Text Option (step-by-step)

1. Select the Edit icon from the floating Bin Drop toolbar to activate the Bin Drop Assessment Editor

Page 218 Studio Editor User Guide Advanced Authoring

2. Select within a Bin to activate the Text Icons

3. Select the Text Icon or the Text Distractor Icon

4. Double-click the "Text" placeholder to make it editable

5. Type the name for the Bin Drop Text Option

6. Select any area outside the Text Option to save

7. To move a correct text option or distractor text: Select and hold the yellow circle and place it in the desired location in the editor

Studio Editor User Guide Page 219 Advanced Authoring

Note: Once a Text Option is added, its corresponding "correct" bin cannot be changed. Wherever you move the option, the dotted line attached to a correct Text Option will always remain in the center of the corresponding bin. To change the

relationship, you must delete the option and recreate it.

8. Select OK to save changes or Cancel to discard them

Adding and Editing Image Options (step-by-step)

1. Select the Edit icon from the floating Bin Drop toolbar to activate the Bin Drop Assessment Editor

Page 220 Studio Editor User Guide Advanced Authoring

2. Select within a Bin to activate the image icons

3. Select the Image Icon or Image Distractor Icon

4. Select a Bin Drop image in one of two ways:

 Select an image from the Media Drive

 Upload a new image

5. Select OK

6. To move a correct image option or distractor image: Select and hold the yellow circle and place it in the desired location in the editor

Studio Editor User Guide Page 221 Advanced Authoring

Note: Once an Image Option is added, its corresponding "correct" bin cannot be changed. Wherever you move the option, the dotted line attached to a correct Image Option will always remain in the center of the corresponding bin. To change the

relationship, you must delete the option and recreate it.

7. Select OK to save changes or Cancel to discard them

Delete Bin Drop Text or Image Options (step-by-step)

1. Select the Edit icon from the floating Bin Drop toolbar to activate the Bin Drop Assessment Editor

Page 222 Studio Editor User Guide Advanced Authoring

2. Select a Text or Image item so that the yellow circle appears

3. Select the red "X" to delete the item

Studio Editor User Guide Page 223 Advanced Authoring

Add Feedback to a Bin Drop Assessment (step-by-step)

You can author feedback messages that are presented in response to learners answering correctly or incorrectly. The feedback will appear after a learner submits their answer(s).

The two types of feedback include:

 Positive Feedback - displayed for correct answers

 Negative Feedback - displayed for incorrect answers

1. Select the Bin Drop Assessment in the editing pane

2. Select the properties gear icon to activate the element properties pane

Make sure Bin Drop is selected from the breadcrumbs

3. Scroll down to find the Feedback options if necessary

Page 224 Studio Editor User Guide Advanced Authoring

4. Enter Positive Feedback, Negative Feedback or Both

5. Select Save and Close to save changes or Cancel to discard them

Drag and Drop

The Drag and Drop assessment element is used to test knowledge by allowing users to drag potential answers over an image, to label or show proper association between elements in the test. Drag and Drop assessment provides feedback to the learner if they answer correctly or incorrectly.

Studio Editor User Guide Page 225 Advanced Authoring

Important components of Drag and Drop outlined in the below image are: 1. Base Image - over which either text or other images will be dropped 2. Drag/Drop Image - must be dropped onto the proper spot on the Base Image 3. Distracter Image - "wrong answer" image to distract the learner 4. Drag/Drop Text - must be dropped onto the proper spot on the Base Image 5. Distracter Text - "wrong answer" text to distract the learner

Drag and Drop Assessment editor (annotated)

Other optional components of Drag and Drop Assessment

Element Description

Enter a recommendation offered as a Advice guide for the learner. It is rendered below the question.

Enter detailed information instructing the Instructions learner how the activity should be completed. It is rendered in italic font below the question.

Page 226 Studio Editor User Guide Advanced Authoring

Element Description

Enter the question; can include text, Question Stem media, tables and lists. Assessments come with this component already but if it is deleted at any point it can be readded.

The Drag and Drop Assessment is created using an editor window. This allows specification of the answer choices as well as where they should be placed on the Base Image.

Add a Drag and Drop Assessment to a Topic (step-by-step)

1. Select the location in the topic to add your question

2. Select the Drag and Drop Assessment icon from the content editing toolbar

 The Drag and Drop Assessment element will be added to the page and a pop-up window will appear to select a Base Image

3. Select a base image in one of two ways:

1. Select an image already in the Media Drive

2. Upload a new image

 The Drag and Drop Assessment Editor will appear for you to author the assessment

Adding and Editing a Drag/Drop Text (step-by-step)

1. Select the Edit icon from the floating toolbar to activate the Drag and Drop Assessment Editor

Studio Editor User Guide Page 227 Advanced Authoring

2. Select the Drag/Drop Text Icon or the Text Distractor Icon

3. Type the name for the Drag/Drop Text

4. Select OK

5. To manage the Drag/Drop text:

a Move a correct text option or distractor text - select and hold the yellow circle and place it in the desired location in the editor

Page 228 Studio Editor User Guide Advanced Authoring

b Manage where the learner should place a correct Drag/Drop text option - select and hold the yellow square to drag it to the correct place on the base image

6. When you are finished authoring the assessment, select OK to save the changes or Cancel to discard them.

Adding and Editing a Drag/Drop Image (step-by-step)

1. Select the Edit icon from the floating toolbar to activate the Drag and Drop Assessment Editor

Studio Editor User Guide Page 229 Advanced Authoring

2. Select the Drag/Drop Image Icon or Image Distractor Icon

3. You can select a Drag/Drop image in two ways:

1. Select an image already in the Media Drive

2. Upload a new image

4. Select OK

5. To manage the Drag/Drop image:

a Move a correct image option or distractor image - select and hold the yellow circle and place it in the desired location in the editor

Page 230 Studio Editor User Guide Advanced Authoring

b Manage where the learner should place a correct Drag/Drop image option - select and hold the yellow square to drag it to the correct place on the base image

6. When you are finished authoring the assessment select OK to save the changes or Cancel to discard them

Delete Drag/Drop Text or Image (step-by-step)

7. Select the Edit icon from the floating toolbar

Studio Editor User Guide Page 231 Advanced Authoring

8. Select a Text or Image item so that the yellow circle appears

9. Select the Red 'X' to delete the item

Add Feedback to a Drag and Drop Assessment (step-by-step)

You can author feedback messages that are presented in response of the learner answering correctly or incorrectly. The feedback will appear after the learner submits their answer(s).

The two types of feedback include:

 Positive Feedback - displayed for correct answers

 Negative Feedback - displayed for incorrect answers

1. Select the Drag and Drop Assessment element

2. Select the Properties icon to activate the element properties pane

Page 232 Studio Editor User Guide Advanced Authoring

3. Select DragDrop from the breadcrumbs

4. Scroll down to find the Feedback options

5. Enter Positive Feedback, Negative Feedback or Both

6. Select Save and Close to keep the changes or Cancel to discard them

Studio Editor User Guide Page 233 Advanced Authoring

Essay Activity

The Essay Activity is designed to allow students to write an essay in answer to a question. It is used in both web and print outputs:

 Web - provides a text area in which learners can type answers

 Print - provides a number of blank lines on which the learners handwrite their answers

Essay Activity Authored in Studio Editor

Page 234 Studio Editor User Guide Advanced Authoring

Essay Activity in Web Course

The main components of the Essay Activity are outlined in the image below: 1. Question Stem - the question to which the student will provide an answer; this is typically simple text 2. Solution - the answer that will be printed in the Instructor guide; solution elements such as Rich Text, List, Table or Figure can be added directly into the assessment here

Studio Editor User Guide Page 235 Advanced Authoring

Question Stem

Solution

Essay Activity in Studio Editor (with annotation)

Other optional components of Essay Activity

Element Description

Enter detailed Instructions information instructing the learner how the activity should be completed; it is rendered in italic font below the question

Adding an Essay Activity Assessment (step-by-step)

1. Select the location in the document to add the question

2. Select the Essay Activity icon from the content editing toolbar

Page 236 Studio Editor User Guide Advanced Authoring

3. Enter the question and the corresponding solution in the spaces provided

Edit the number of Response Lines for an Essay Activity (step-by-step)

In the print version of the Essay Activity, the number of blank lines left for a student response can be changed as desired.

1. Select anywhere within the Essay Activity

2. Select the Element Properties icon to activate the element properties pane

3. Select Essay Activity from the breadcrumbs

4. Select the Response Lines dropdown menu and choose from 0-8 lines

Studio Editor User Guide Page 237 Advanced Authoring

5. Select Save and Close to keep the changes or Cancel to discard them

Fill in the Blank

The Fill-in Activity element lets you create questions with blank fields. In web outputs, blanks may be set to be typed in or chosen from a dropdown menu. You may set as many blanks as necessary and provide many correct responses for each blank.

Page 238 Studio Editor User Guide Advanced Authoring

Fill in the Blank Assessment in Studio Editor

Fill in the Blank Assessment in Web Course

Other optional components of Fill in the Blank Activity

Element Description

Enter a recommendation offered as a Advice guide for the learner; it is rendered below the question

May be inserted anywhere in the Fill In Figure content; often used to clarify the assessment question

Shown when the question is configured to Hint have more than one attempt and Hint is enabled

Studio Editor User Guide Page 239 Advanced Authoring

Element Description

Enter detailed information instructing the Instructions learner how the activity should be completed; it is rendered in italic font below the question

Used as a styling tool to design the Fill In Line Break the Blank question layout

Enter the question; can include text, Question Stem media, tables and lists; assessments come with this component already but if it is deleted at any point it can be readded

Adding a Fill in the Blank Assessment (step-by-step)

1. Select the location in the document to add the question

2. Select the Fill In Blank icon from the content editing toolbar

3. Enter desired text in the spaces provided for the Question Stem and Content Placeholder

Please note: By default, a newly added Fill in the Blank element will contain a Question Stem and a Content placeholder. Various Fill in the Blank Types can be added.

Authoring a Fill in the Blank Assessment

Once the assessment is added to the topic, one or more of the following Fill in the Blank types can be added by selecting them from the floating

Page 240 Studio Editor User Guide Advanced Authoring toolbar. Each type is numbered in the image below to match its corresponding type in the following list: 1. Dropdown - learner selects an answer from a list of dropdown choices, one or more of which may be considered correct 2. Text Match - learner enters text which is either checked against a pattern (validated) or is not (unvalidated) 3. Formula - learner enters a formula-based answer to a numeric question 4. Date - learner enters a date in the calendar as an answer for the exercise 5. Number Match - learner enters a number that is validated as being within an acceptable range of numbers

Fill in the Blank Types outlined

Each of the Fill in the Blank types outlined above are authored differently within Editor. Detailed procedures for adding and editing each type are described below. Before attempting these procedures, make sure you have completed the Adding Fill in the Blank Assessment procedure.

Insert Text Match Type (step-by-step)

1. Select anywhere within the Fill in the Blank Assessment

2. Select the Blank icon

3. Type the correct answer in the blank

Studio Editor User Guide Page 241 Advanced Authoring

4. Select anywhere outside the blank to save

Add Pattern for Text Match Type (step-by-step)

The pattern feature allows you to provide as many correct responses for each blank as desired. This is designed to accommodate the possibility of a learner entering a different variation of a correct answer. An example of a Fill in the Blank Assessment with multiple correct answers is show in the image below.

Fill in the Blank assessment with multiple correct answers authored in Studio Editor

1. Select within the Text-Match Element

2. Select the Pattern icon

3. Enter the new answer

4. Repeat as many times as desired for the question

Editing Pattern Properties for Text Match Type (step-by-step)

Pattern properties also allows you to Ignore Spaces, Case, Extra Words and Hyphens/Minuses. By default, if none of the pattern properties are

Page 242 Studio Editor User Guide Advanced Authoring changed, the learner's answer will have to match exactly to one of the answers provided in order to be marked correct.

1. Select within the Text-Match Element

2. Select the Blank on which you wish to edit the pattern

3. Select the Element Properties icon to activate the element properties pane

4. Edit the Pattern Ignore Limitations by setting each dropdown menu to True or False

5. Select Save and Close to keep the changes or Cancel to discard them

Insert Drop Down Type (step-by-step)

Add Dropdown Type (step-by-step)

1. Select anywhere within the Fill in the Blank Assessment

2. Select the Drop Down List icon

3. Select the Drop Down List

Studio Editor User Guide Page 243 Advanced Authoring

4. Enter the answer options in the blanks provided

5. To add or delete a blank, follow these Sub-steps:

a To ADD a blank, select the Drop Down List Option icon from the toolbar

b To DELETE a blank, select the Red 'X' located next to the blank

Note: If you have made changes to a blank you wish to keep, make sure you have selected somewhere outside the dropdown menu to save them prior to adding or deleting a box. If you do not, the changes you made will be lost.

Editing correct answers for Drop Down Type

Drop Down Type allows one or more of the answers to be considered correct. Once the dropdown options have been added, selecting or deselecting correct answers is very simple.

Page 244 Studio Editor User Guide Advanced Authoring

- Selecting or deselecting can be done by selecting the checkbox located next to each option. If the checkbox is selected, the answer will appear in the Fill-In Drop Down Element Blank. If it is then deselected, the answer will disappear from the blank.

- Once the option is visible in the Drop Down element, deselecting can also be done by selecting the small 'X' next to the name to change it back to incorrect

Insert Number Match Type (step-by-step)

Add Number Match Type (step-by-step)

1. Select anywhere within the Fill in the Blank Assessment

2. Select the Number Match icon

3. Enter the appropriate values in the following fields:

. From: minimum number value

. To: maximum number value

. Char limit: character limit

Studio Editor User Guide Page 245 Advanced Authoring

. Char size: character size

Insert Date Type (step-by-step)

Add Date Type (step-by-step)

1. Select anywhere within the Fill in the Blank Assessment

2. Select the Fill in Date icon

3. Select the Specify Date Blank

4. Select a date from the pop-up calender

Please note: You can also type a date by selecting inside the "Specify Date:" blank by entering it in the form of YYYY-MM-DD.

Adding Feedback to a Fill in the Blank Assessment (step-by- step)

You can author feedback messages that are presented in response of the learner answering correctly or incorrectly. The feedback will appear after the learner submits their answer(s).

The two types of feedback include:

 Positive Feedback - displayed for correct answers

 Negative Feedback - displayed for incorrect answers

1. Select the Fill in the Blank Assessment element

2. Select the Element Properties icon to activate the element properties pane

Page 246 Studio Editor User Guide Advanced Authoring

3. Select Fill-In Activity from the breadcrumbs

4. Scroll down to find the Feedback options

5. Enter Positive Feedback, Negative Feedback or Both

6. Select Save and Close to keep the changes or Cancel to discard them

Image Map Assessment

The Image Map Assessment is designed to test a learner's knowledge by defining clickable regions, called Hot Spots, on an image. The learner must then identify the correct Hot Spot.

This assessment type will not display text or images when a Hotspot is selected (as is the case of an Image Map), but rather just mark as correct or incorrect.

Studio Editor User Guide Page 247 Advanced Authoring

Image Map Assessment in Studio Editor

Image Map Assessment in Web Course

Page 248 Studio Editor User Guide Advanced Authoring

Other optional components of Image Map Assessment

Element Description

Enter a recommendation offered as a Advice guide for the learner; rendered below the question

Shown when the question is configured to Hint have more than one attempt and Hint is enabled

Enter detailed information instructing the Instructions learner how the activity should be completed; rendered in italic font below the question

Displayed on top of the Base Image Title

An Image Map Assessment is created using an editor window. This allows you to draw shapes ("HotSpots") anywhere over the Base Image. These shapes can be marked as correct or incorrect answers for the question.

Add an Image Map Assessment (step-by-step)

1. Select the location in the topic to add your question

2. Select the Image Map Assessment icon from the content editing toolbar

3. Select a Base Image in one of two ways:

1. Select an image already in the Media Drive

2. Upload a new image

Studio Editor User Guide Page 249 Advanced Authoring

Change the Bin Drop Base Image (step-by-step)

1. Select the Image Map Assessment in the editing pane

2. Select the gear icon to activate the element properties pane

3. Select Image Map from the breadcrumbs

4. Select Browse on the Image File element and choose a new image

5. Select Save and Close to keep the changes or Cancel to discard them

Page 250 Studio Editor User Guide Advanced Authoring

Add a Hot Spot (step-by-step)

The three Hot Spot types are outlined below:

1. Square - when chosen, a square Hot Spot will be added that can be moved and resized

2. Circle - when chosen, a circle Hot Spot will be added that can be moved and resized

3. Polygon - when chosen, a Hot Spot can be created with however many sides you wish

1. Select the Edit icon from the floating toolbar

2. In the Image Map Assessment Editor, select one of the Hot Spot types to add using the various icons in the editor.

For polygons, follow the sub-steps below:

a Select to add a new side connected to the previous point

b Right-click to stop drawing the Hot Spot and connect the last side with the first

3. To mark a Hot Spot as correct, select the HotSpot shape and check the checkbox that appears

Studio Editor User Guide Page 251 Advanced Authoring

4. To move a Hot Spot, select and hold the yellow circle and place it in the desired location in the editor

5. To edit the size of a Hot Spot, select and hold one of the yellow squares and drag to the desired size

Page 252 Studio Editor User Guide Advanced Authoring

6. When you are finished authoring the assessment select OK to save the changes or Cancel to discard them

Delete a Hot Spot (step-by-step)

1. Select the Edit icon from the floating toolbar

2. In the Image Map Assessment Editor, select a Hot Spot so that the yellow circle appears

3. Select the red "X" to delete the item

Studio Editor User Guide Page 253 Advanced Authoring

Add Feedback to an Image Map Assessment (step-by-step)

You can author feedback messages that are presented in response of the learner answering correctly or incorrectly. The feedback will appear after the learner submits their answer(s).

The two types of feedback include:

 Positive Feedback - displayed for correct answers

 Negative Feedback - displayed for incorrect answers

1. Select the Image Map Assessment element

2. Select the gear icon to activate the element properties pane

3. Select Image Map Assessment from the breadcrumbs

4. Scroll down to find the Feedback options

Page 254 Studio Editor User Guide Advanced Authoring

5. Enter Positive Feedback, Negative Feedback or Both

6. Select Save and Close to keep the changes or Cancel to discard them

Matching Activity

The Matching Activity allows students to match items from one column to items in a second column. Matches are made by clicking and drawing a link between terms.

Studio Editor User Guide Page 255 Advanced Authoring

Matching Activity Authored in Studio Editor

Matching Activity in Web Course

Page 256 Studio Editor User Guide Advanced Authoring

The main components of the Matching Activity are outlined in the image below: 1. Question Stem - instructions or a question that the learner will reference in choosing matches 2. Option - a single matching answer, consisting of a term and matching term. Keep in mind that when authoring the Matching Activity, a single row will have an item with the matching answer next to it. However, when publishing renders this in a web page, the term and matching answer will be automatically randomized and not appear next to each other.

Question Stem

Option

Matching Activity in Studio Editor (with annotation)

Other optional components of Matching Activity

Element Description

Enter a recommendation offered as a Advice guide for the learner; rendered below the question

Shown when the question is configured to Hint have more than one attempt and Hint is enabled

Studio Editor User Guide Page 257 Advanced Authoring

Element Description

Enter detailed information instructing the Instructions learner how the activity should be completed; rendered in italic font below the question

Add a Matching Activity Assessment (step-by-step)

1. Select the location in the document to add the question

2. Select the Matching Activity icon from the content editing toolbar

3. Enter the Instructions/question and options in the spaces provided

Add an option to a Matching Activity (step-by-step)

When a matching activity assessment is added to a document, it will contain four options by default. Follow the below procedure to add more options.

1. Select anywhere within the Matching Activity

2. Select the Option icon

3. Enter the Term and Answer

Page 258 Studio Editor User Guide Advanced Authoring

4. Select anywhere outside the activity to save

Remove an option from a Matching Activity (step-by-step)

When a matching activity assessment is added to a document, it will contain four options by default. Follow the below procedure to remove an option.

1. Select the option you wish to delete

2. Select the gear icon on either the Term or the Answer to activate the element properties pane

3. Select Option from the breadcrumbs

4. Select Delete

Studio Editor User Guide Page 259 Advanced Authoring

Add Feedback to a Matching Activity

You can author feedback messages that are presented in response of the learner answering correctly or incorrectly. The feedback will appear after the learner submits their answer(s).

The two types of feedback include:

 Positive Feedback - displayed for correct answers

 Negative Feedback - displayed for incorrect answers

1. Select the Matching Activity element

2. Select the gear icon to activate the element properties pane

3. Select Matching Activity Content from the element breadcrumbs

Page 260 Studio Editor User Guide Advanced Authoring

4. Enter Positive Feedback, Negative Feedback or Both

5. Select Save and Close to keep the changes or Cancel to discard them

Matrix

The Matrix assessment will display a table with rows of statements and category descriptions in column headers. A checkbox is rendered in every column header category for every statement. The learner will select the checkbox(es) that apply for every statement.

Studio Editor User Guide Page 261 Advanced Authoring

Matrix Assessment authored in Studio editor

Matrix Assessment in Web Course Output

The main components of the Matrix are outlined in the image below: 1. Question Stem 2. Instructions 3. Column Header 4. Statement

Page 262 Studio Editor User Guide Advanced Authoring

1 2 3

Matrix Assessment in Studio Editor (with annotation)

Other optional components of a Matrix Assessment

Element Description

Enter a Advice recommendation offered as a guide for the learner; rendered below the question

Instructions Enter detailed information instructing the learner how the activity should be completed; rendered in italic font below the question

Add a Matrix Assessment (step-by-step)

1. Select the location in the topic to add your question

Studio Editor User Guide Page 263 Advanced Authoring

2. Select the Matrix Assessment icon from the content editing toolbar

3. Enter the question in the space provided

Note: By default, when a Matrix Assessment is added, it will contain four statements and two columns. The Matrix Assessment can be authored to have more or less than the default.

Authoring a Matrix Assessment (step-by-step)

Different components can be added to the Matrix Assessment to create the desired question type. Selecting anywhere in the Matrix Assessment will enable various child elements that can be added.

The child elements of the Matrix Assessment outlined include: 1. Advice - enter a recommendation offered as a guide to action; it is rendered below the question 2. Instructions - enter detailed information on how the assessment should be completed 3. Column - enter the header field 4. Statement - enter a statement and the corresponding Correct Column number

Matrix child elements

Page 264 Studio Editor User Guide Advanced Authoring

Before attempting the procedures below, make sure you have completed the Adding a Matrix Assessment procedure.

Adding a Column

1. Select within the Matrix Assessment

2. Select the Column icon

3. Rename the column by selecting the name directly

4. Select anywhere outside of the column to save the changes

Deleting a Column

1. Locate the column you wish to delete

Studio Editor User Guide Page 265 Advanced Authoring

2. Select the list icon to activate the element actions menu in the properties pane

3. Select Delete

Adding a Statement

1. Select within the Matrix Assessment

2. Select the Statement icon

3. Rename the statement by selecting the name directly

Page 266 Studio Editor User Guide Advanced Authoring

4. Change the value of Correct Column by selecting the checkbox in the appropriate column

Note: If no column is chosen, Column 1 will be set as the Correct Column.

Deleting a Statement

1. Locate the Statement you wish delete

2. Select the list icon to activate the element actions menu in the properties pane

3. Select Delete

Studio Editor User Guide Page 267 Advanced Authoring

Add Feedback to a Matrix Assessment (step-by-step)

You can author feedback messages that are presented in response of the learner answering correctly or incorrectly. The feedback will appear after the learner submits their answer(s).

The two types of feedback include:

 Positive Feedback - displayed for correct answers

 Negative Feedback - displayed for incorrect answers

1. Select anywhere within the Matrix Assessment

2. Select the gear icon to activate the element properties pane

3. Select Matrix from the element breadcrumbs

Page 268 Studio Editor User Guide Advanced Authoring

4. Insert Positive or Negative Feedback or Both

5. Select Save and Close to keep the changes or Cancel to discard them

Control the randomization of answer options

You can control whether answer options remain in the order in which they are authored or randomized each time the question is rendered. This is done via the Preserve Choice Order option in the Matrix element properties pane shown below:

Matrix assessment element properties pane (with annotation)

Options available from the Preserve Choice Order dropdown menu:

 True - preserves the order of the answer options as the question was written

 False - randomizes the answer options

Multiple Choice Questions

A multiple choice question element, when added to your document, will contain by default a question stem, two question options, and a weight element. You may add other child elements, such as: additional question

Studio Editor User Guide Page 269 Advanced Authoring options, hints, and response-specific and/or positive/negative feedback. Questions can be added to a web course or SSP at the end of a lesson or within a topic.

Multiple choice questions can be any of the following types: 1. True/False 2. Multiple select (more than one answer is correct) 3. Standard multiple choice (only one answer is correct)

Multiple Choice Question Authored in Studio Editor

Page 270 Studio Editor User Guide Advanced Authoring

Multiple Choice Question in web preview

Multiple Choice Question in print preview

Authoring a Multiple Choice Question within a topic (step-by- step)

1. Select the location in the topic to add your question

2. Select the Multiple Choice icon from the content editing toolbar

3. Enter the question in the Multiple Choice Content field

Studio Editor User Guide Page 271 Advanced Authoring

4. Enter answer options in each of the Question Options fields

5. To add more Question Options, select the Option icon from the floating toolbar

6. To identify the correct answer, place your cursor on the appropriate question option element, and select the properties gear icon to activate the element properties pane

a In the IsCorrect dropdown, select True

Preserve the order of question options for a multiple choice question

The option to preserve the answer choices in a multiple choice question can be found in the element properties for the Multiple Choice Content element, as shown in the image below.

To save the order of the answer choices as they're authored in Studio, select True from the dropdown menu.

Preserve Choice Order property setting (with annotation)

Page 272 Studio Editor User Guide Advanced Authoring

Why use the Preserve Choice Order property setting?

You may wish to preserve the order of the answer choices in a multiple choice question if it is a True/False question or if the answers available include "All/None of the Above."

Enter response-specific feedback for an answer choice

You can set the question so that a response-specific comment is displayed for each of the answer choices in your multiple choice questions. The option to do so is located in the element properties pane of the Question Option element.

Question Option element properties (with annotation)

Enter feedback for correct or incorrect answers in a multiple choice question

You can set the question so that comments are displayed when a learner selects correct and/or incorrect answers. This option is located in the element properties pane of the Multiple Choice Content element.

Question Option element properties (with annotation)

Studio Editor User Guide Page 273 Advanced Authoring

Select HotText

The Select HotText assessment is similar to a multiple choice assessment, except the choices are inline selectable text embedded in a larger text block. Select Hot Text provides the learner with text that contains these inline highlighted words and asks them to select which of the highlighted words answer a proposed question.

Select Hot Text Assessment in Studio Editor

Select Hot Text in Web Course

The major components of a Select Hot Text Assessment are outlined below and shown in the following image.

 Question Stem - instructions or a question that the student will reference in choosing matches

 Select Text - a passage of text that may contain one or more highlighted pieces of text in a larger passage of text

 Option Choice - attached to each "Select Text" and indicates if this text is a correct selection or an incorrect selection; it also (optionally) provides feedback when the learner selects this text

Page 274 Studio Editor User Guide Advanced Authoring

Select Hot Text Assessment (annotated)

When taking the assessment in a web course, after making selections of hot text, selected items appear highlighted. After the learner submits their answers, the Hot Text Options will be highlighted a specific color depending on whether or not the answer was correct. Learners may also select hot text elements to view any assigned Response Feedback. An example of a completed Select Hot Text assessment is shown in the image below.

The highlighted colors include:

 Green - was selected by the learner and is a correct response

 Yellow - was NOT selected by the learner but is a correct response

 Red - was selected by the learner and is NOT a correct response

Select Hot Text after completion in Web Course

Studio Editor User Guide Page 275 Advanced Authoring

Other optional components of Select Hot Text

Element Description

Enter a recommendation offered as a Advice guide for the learner; rendered below the question

Shown when the question is configured to Hint have more than one attempt and Hint is enabled.

Enter detailed information instructing the Instructions learner how the activity should be completed; rendered in italic font below the question

Adding a Select HotText Assessment (step-by-step)

1. Select the location in the topic to add a Select Hot Text assessment

2. Select the Select Hot Text icon from the content editing toolbar

3. Enter the question text in the Enter Question Stem field

4. Enter the text passage in the Enter Content field

Creating Option Choices (step-by-step)

1. Highlight a specific word or phrase in the passage

2. Keeping the word or phrase highlighted, select Option Choice from the floating toolbar

Page 276 Studio Editor User Guide Advanced Authoring

3. In the pop up window, select True or False from the IsCorrect dropdown menu

4. Insert text for the Response FeedBack (optional)

5. Select OK to save the changes made or Cancel to discard them

Editing or Removing a Text option

Editing and Removing text options are very simple. For both actions, you simply select the option you wish to change and a pop-up window will appear. The pop-up shown in the image below has two options: Edit or Remove.

Studio Editor User Guide Page 277 Advanced Authoring

View Option Choice menu in Studio Editor

Actions taken with each selection:

 Edit - brings up the Edit Option Choice pop-up box where the option properties can be changed

 Remove - removes the highlight from the selected word or phrase; it will no longer be a viable option

Sequence Activity Content

The Sequence Activity assessment type renders a list that the learner must set in the correct order. The Sequence Step elements are authored in the correct sequence and the publishing template randomizes the order automatically. The learner rearranges the order of the steps by dragging and dropping each item in the intended order.

Page 278 Studio Editor User Guide Advanced Authoring

Question stem field

Sequence steps (authored in the correct order)

Sequence activity authored in Editor (with annotation)

Insert a Sequence Activity Assessment

To add a Sequence Activity, select the Sequence activity icon from the content editing toolbar:

Content editing toolbar - Sequence activity assessment(with annotation)

Author a Sequence Activity Assessment (step-by-step)

1. Select the Sequence Activity icon from the content editing toolbar

 A new sequence activity is added in the content editing pane with a Question Step and two Sequence Steps

2. Enter the question text in the Question Stem field

Studio Editor User Guide Page 279 Advanced Authoring

3. To add more Sequence Steps, select the Sequence icon from the floating toolbar

4. Enter text for each step in the correct sequential order

Delete a sequence step

To delete a sequence step, select Delete from the Element Actions pane located within the element properties pane for the element.

Sequence Step - Element actions pane (with annotation)

For detailed instructions, please see the Delete a Sequence Step (step-by- step) procedure.

Page 280 Studio Editor User Guide Advanced Authoring

Reorder sequence steps

To rearrange the order of the sequence steps, simply click on the leftmost area of the item you want to move (the blue shaded vertical line) and drag it to the new area. Any allowed area will display a green dashed line indicating it is okay to drop the item in that new location. When you release the mouse button to drop the item, select the Move option from the menu that appears at the top of the content editing pane. See the image below for an example:

Second, release the item to the new location and select MOVE First select this area of the element and drag it to the new location

Reorder a sequence step(with annotation)

Delete a Sequence Step (step-by-step)

Please note: You cannot delete the last two remaining sequence steps of a sequence activity. If you wish to delete a sequence activity assessment question, you may do so from within the Sequence Activity Content Element Actions pane.

Studio Editor User Guide Page 281 Advanced Authoring

Sequence Step - Element actions pane (with annotation)

1. Select the step element to delete from the content editing pane

2. From the breadcrumbs, select the Sequence Step tab

3. From the left side of the elements property pane, select the Menu icon

4. Select Delete from the list of Element Actions displayed

Web Assessment Behavior Options

When authoring assessments, you can include various parameters for a question block via the Web Activity Behavior options pane.

The Web Activity Behavior pane allows authors to capture various assessment settings relating to how online courses behave for learners. Settings include how questions appear, how many attempts learners may take, time limits and similar parameters. Web activity behaviors can be set for the entire course (cover page or container) or a question block. For information about enhanced scorecards, please refer to Enhanced Scorecards.

Page 282 Studio Editor User Guide Advanced Authoring

Web activity behavior options pane for a question block (with annotation)

Web activity behavior settings are organized into the following categories:

 Course Progress

 Questions

 Feedback

 Competency Definition

Web activity behavior options