Editing a Manual in Course Manager by Skytap

Once you add a Manual to a course, use the rich text editor on the Edit Manual page to customize your Manual.

manual rich text editor

For more information about using the buttons and keyboard shortcuts in the rich text editor, click on a topic below.

Contents

Formatting text

You can apply the following formats to text using the rich text editor:

  • Bold – To use bold formatting, select the text and click bold (Bold), or just click bold (Bold) and begin typing. Click bold (Bold) again to stop using bold formatting.

  • Italic – To use italic formatting, select the text and click italic (Italic), or just click italic (Italic) and begin typing. Click italic (Italic) again to stop using italic formatting.

  • Underline – To use underline formatting, select the text and click underline (Underline), or just click underline (Underline) and begin typing. Click underline (Underline) again to stop using underline formatting.

  • Strikethrough – To use strikethrough formatting, select the text and click strikethrough (Strikethrough), or just click strikethrough (Strikethrough) and begin typing. Click strikethrough (Strikethrough) again to stop using strikethrough formatting.

  • Superscript – To use superscript formatting, select the text and click superscript (Superscript), or just click superscript (Superscript) and begin typing. Click superscript (Superscript) again to stop using superscript formatting.

Changing text color

To change text color using the rich text editor
  1. Select the text or move the cursor where you want to start using the new color.
  2. Click text color (Text Color).
  3. Choose a color from the color picker, or type a HEX Color code and click OK.

    color picker

    To return to the default font color, click clear formatting (Clear Formatting) in the color picker.

Changing paragraph format

To change the paragraph format using the rich text editor
  1. Select the paragraphs or move the cursor to the paragraph that you want to change.
  2. Click paragraph format (Paragraph Format).
  3. Choose from one of the following paragraph formats:

    • NormalNormal is the default paragraph format, which should be used for most content.
    • Heading (1-4) – Headings are used to create structure for your content. There are four heading levels. Heading 1 is the most prominent heading, and Heading 4 is the least prominent.
    • Code – The Code format can be used to distinguish a block as code by applying a light gray background and monospace font.

    Notes

    • For normal or heading formats, press Shift+Enter to insert a line break and keep the current paragraph format, or press Enter to insert a paragraph break and return to the normal format.
    • For code format, press either Shift+Enter or Enter to insert a line break and keep the current code format.
    • To exit code format, press Enter at the end of the last line of a section that uses the code format, and then press Enter again.

    Headings are displayed in a table of contents for lab end users on the Manual tab in the Learning Console. For more information about using the table of contents, see Using the table of contents.

Inserting block quotes

Use a block quote to indicate an extended quotation.

To insert a block quote using the rich text editor
  1. Select the paragraphs or move the cursor to the paragraph that you want to format as a quote.
  2. Click quote (Quote).
  3. Select Increase from the drop-down menu.

    Notes

    • To increase or decrease the indentation of your block quote, click Increase or Decrease in the block quote drop-down menu.
    • When you get to the end of a line in a block quote, press Shift+Enter to insert a line break and keep the block quote format, or press Enter to insert a paragraph break and return to the normal format.

Changing text alignment

To align text using the rich text editor
  1. Select the paragraphs or move the cursor to the paragraph that you want to align.
  2. Click align left (Align Left), align justify (Align Justify), align center (Align Center), or align right (Align Right).

Inserting lists

To insert a list using the rich text editor
  1. Select the paragraphs or move the cursor to the paragraph that you want to convert to a list.
  2. Click ordered list (Ordered List) or unordered list (Unordered List). To choose a different style list marker, click down arrow (Down Arrow) next to the list button and choose a style.

    Notes

    • To add additional list items, press Enter at the end of a line in your list.
    • To move to a new line without adding another list item, press Shift+Enter.
    • To stop adding additional list items, move to an empty line containing a list marker. Then, press Enter or click the appropriate list button again.
    • To remove list formatting, select the applicable text or place the cursor within a list item. Then, click the appropriate list button again.
    • To create a nested list, press Tab in an empty line containing a list marker. This line is indented and has a different list marker. After you type the nested list item, press Enter to move to the next line of the nested list. Press Enter again to remove the additional indentation and return to the original list.

Inserting a callout

Use a callout to highlight important content.

To insert a callout using the rich text editor
  1. Select the paragraphs or move the cursor to the beginning of an empty line that you want to format as a callout.
  2. Click warning (Warning) or info (Info).

    To exit callout format, hover just below the callout block, and click break (Break).

Inserting copyable text

Use copyable text to make it easier for lab end users to paste content from the Manual in the Learning Console into their VMs. For information about using copyable text for lab end users, see Using copyable text.

To insert copyable text using the rich text editor
  1. Select the text or move the cursor where you want to insert copyable text.
  2. Click copyable text (Copyable Text).

    Notes

    • If you select multiple paragraphs and insert copyable text, each paragraph becomes a separate copyable text block.
    • To exit copyable text format, move the cursor to the end of the copyable text block, and click copyable text (Copyable Text).
    • To remove copyable text formatting, select the copyable text and click copyable text (Copyable Text).

Inserting a command

Use a command to allow lab end users to execute an interactive or system command in their VM by clicking a button or inline link in the Manual in the Learning Console. Commands can be used to open a file in a VM, run an application in a VM, or check the state of a VM to confirm that a user has performed specific tasks. You can block lab end users from moving forward in the Manual until they execute or successfully execute a command. For information about using commands for lab end users, see Using commands.

Notes

  • The CMHelper app must be installed on at least one VM in a lab end user's Skytap environment for the user to be able to execute interactive commands. For information about installing CMHelper, see Installing CMHelper on a VM.
  • The CMSysHelper app must be installed on at least one VM in a lab end user's Skytap environment for the user to be able to execute system commands. For information about installing CMSysHelper, see Installing CMSysHelper on a VM.
  • You can prevent lab end users from clicking commands in the Manual if the required CMHelper or CMSysHelper isn't available by enabling CMHelper and CMSysHelper presence tracking. This setting can be enabled by default using your account settings or for an individual course, event, or on-demand lab using Course Manager tags. CMHelper and CMSysHelper presence tracking should be enabled only if:
    • CMHelper version 1.1.9 or newer is in use for interactive commands.
    • CMSysHelper version 1.0.2 or newer is in use for system commands.
  • CMHelper version 1.1.9 or newer and CMSysHelper version 1.0.2 or newer keep VMs active while commands are running.
  • When a lab end user interacts with commands in the Manual, Course Manager displays these actions on the lab end user's Activity page and the event Activity Summary page.
To insert a command using the rich text editor
  1. Select the text or move the cursor where you want to insert the command.
  2. Click command (Command).
  3. Complete the following fields, and then click Insert:

    command details

    Click Help to open this help page in a new tab.

    • Command to execute – Enter the command that should be executed in the VM when the lab end user clicks the command in the Manual.
    • Display text – Enter the display text for the command.

      Notes

      • If you select text before you insert the command, Display text defaults to the selected text.
      • If you select multiple lines of text, Display text includes only the first line of the selected text.
    • (Optional) Description – Enter the text that displays when the lab end user hovers over the command in the Manual.

      Notes

    • (Optional) Target VM name – Enter the Skytap name of the VM to target when executing the command. To target multiple VMs that include a common string in their Skytap name, type the common string as the Target VM name.

      Notes

      • If you leave Target VM name blank for an interactive command, the command is executed in every VM in the lab end user's Skytap environment that has CMHelper available for use.
      • If you leave Target VM name blank for a system command, the command is executed in every VM in the lab end user's Skytap environment that has CMSysHelper available for use.
    • (Optional) Timeout (seconds) – Enter the number of seconds to wait before terminating the command if it hasn’t yet completed.

      Notes

      • To disable the command timeout, set Timeout (seconds) to 0.
      • If you set a non-zero command timeout, the command will terminate after the timeout period only if:
        • CMHelper version 1.1.9 or newer is in use for interactive commands.
        • CMSysHelper version 1.0.2 or newer is in use for system commands.
      • When you choose a Notify command behavior and set a non-zero command timeout:
        • The command will display a failure notification to the lab end user if it terminates due to a timeout (unless the command was designed to succeed if it terminates).
        • If Course Manager loses connection with CMHelper or CMSysHelper before the command terminates or completes:
    • Command behavior – Select the command’s notification and blocking behavior. You can display an alert dialog box to notify the lab end user whether or not the Command to execute succeeds, and you can block the lab end user from moving forward in the Manual until they execute or successfully execute a command. Choose from one of the following command behaviors:

      Command behavior Display an alert dialog box Block the lab end user until they execute the command Block the lab end user until they successfully execute the command
      Don’t notify and don’t block      
      Don’t notify and block until pressed    
      Notify and don’t block    
      Notify and block until pressed  
      Notify and block until successful  

      Notes

      If you choose any Notify command behavior:

      • The title and content of the alert dialog box include the text from Description.
      • The command output and Command to execute display in the Result Data field on the lab end user's Activity page and the Last Result Data field on the event Activity Summary page after the command terminates or completes.
    • Command availability – Choose from one of the following command availability options:
      • Always – The lab end user can always click the command.
      • Until pressed – The lab end user can click the command until they execute it.
      • Until successful – The lab end user can click the command until they successfully execute it.

        Until successful is available only if you choose a Notify command behavior.

    • Command type – Choose whether the Command to execute is an Interactive command or a System command. For more information, see Choosing between interactive and system commands.
    • Display style – Choose whether the command displays as a Button or Inline link.
    • (Optional) Switch to VM – Select to display the VM that receives and accepts the command when it is executed.

      Notes

      • Switch to VM is available only for interactive commands.
      • If CMHelper version 1.1.9 or newer is in use, Switch to VM works even if Target VM name is blank.
      • If multiple VMs in the lab environment receive and accept the command, any one of these VMs may display.
To edit or remove a command
  1. Click the command.
  2. Click one of the following:

    • edit command (Edit Command) to edit the command.
    • remove (Remove) to remove the command.

Choosing between interactive and system commands

Interactive commands
  • Can be executed only by lab end users who are signed in to the target VM.
  • Can be executed only when the CMHelper app is running on the target VM. CMHelper runs as a process in a user session, with the privileges of that user.
  • Can’t be executed in VMs that don’t have a graphical user interface.
System commands
  • Can be executed by lab end users regardless of whether they are signed in to the target VM.
  • Can be executed only when the CMSysHelper app is running on the target VM. CMSysHelper runs as an OS service, with privileges at the system level.
  • Can be executed in VMs regardless of whether they have a graphical user interface.

Inserting a question

Use a question to allow lab end users to answer a multiple choice or short answer question in the Manual in the Learning Console. Questions can be used to assess comprehension or completion of lab content. You can block lab end users from moving forward in the Manual until they answer or correctly answer a question. For information about using questions for lab end users, see Using questions.

When a lab end user answers questions in the Manual, Course Manager displays these actions on the lab end user’s Activity page and the event Activity Summary page.

To insert a question using the rich text editor
  1. Select the text or move the cursor where you want to insert the question.
  2. Click question (Question).
  3. Complete the following fields, and then click Insert:

    question details

    Click Help to open this help page in a new tab.

    • Question type – Choose from one of the following question types:

      • Multiple choice – The lab end user chooses one from multiple answer choices.
      • Short answer (exact) – The lab end user enters the answer in a text box, and the answer is case-sensitive.
      • Short answer (case-insensitive) – The lab end user enters the answer in a text box, and the answer isn’t case-sensitive.

      Question type displays in the Result Data field on the lab end user’s Activity page and the Last Result Data field on the event Activity Summary page.

    • Blocking – Choose from one of the following blocking behaviors:

      • Don’t block – Don’t block the lab end user from moving forward in the Manual if they don’t answer the question.
      • Block until answered – Block the lab end user from moving forward in the Manual until they answer the question.
      • Block until correct – Block the lab end user from moving forward in the Manual until they correctly answer the question.

      If you choose Block until answered, the lab end user has only one attempt to answer the question and sees the correct answer after this attempt.

    • Prompt – Enter the question prompt.

      Notes

      • If you select text before you insert the question, Prompt defaults to the selected text.
      • If you select multiple lines of text, Prompt includes only the first line of the selected text.
      • Prompt displays in the Activity Name field on the lab end user's Activity page and the event Activity Summary page.
    • Answer – Enter the correct answer for short answer questions or the answer choices for multiple choice questions.

      Notes

      • For multiple choice questions, you must list each answer choice on a separate line and place an asterisk before the correct choice.
      • The correct answer displays in the Result Data field on the lab end user's Activity page and the Last Result Data field on the event Activity Summary page.
To edit or remove a question
  1. Click the question.
  2. Click one of the following:

    • edit question (Edit Question) to edit the question.
    • remove (Remove) to remove the question.

Inserting a page break

Use page breaks to break a Manual into manageable segments for lab end users. When you insert a page break in a Manual, users see the content after the page break on a new page in their Manual in the Learning Console. They can then track their progress by marking pages in the Manual as done. For information about using a Manual with multiple pages for lab end users, see Using a Manual with multiple pages.

When a lab end user interacts with pages in the Manual, Course Manager displays these actions on the lab end user’s Activity page and the event Activity Summary page.

To insert a page break using the rich text editor
  1. Move the cursor where you want to insert the page break.
  2. Click page break (Page Break).

Inserting a table

To insert a table using the rich text editor
  1. Move the cursor where you want to insert the table.
  2. Click insert table (Insert Table).
  3. Use the grid to select the table dimensions.

    table dimensions

    Notes

    • To adjust the width of a table, click and drag the left or right edge of the table.
    • To adjust the width of a column in a table, click and drag the left or right edge of the column.
To access additional design options or remove a table
  1. Select one or more cells in the table.
  2. Click one of the following:

    • table header (Table Header) to add a header row to the top of the table. Click table header (Table Header) again to remove an existing table header.
    • remove table (Remove Table) to remove the table.
    • row (Row) and choose an option from the drop-down menu to insert a row above the selection, insert a row below the selection, or delete the row or rows that contain the selection.
    • column (Column) and choose an option from the drop-down menu to insert a column above the selection, insert a column below the selection, or delete the column or columns that contain the selection.
    • table style (Table Style) and choose an option from the drop-down menu to add a dashed border to all cells in the table or shade alternate rows of the table.
    • cell (Cell) and choose an option from the drop-down menu to merge or split cells. If multiple cells are selected, you can merge the cells. If one cell is selected, you can vertically or horizontally split the cell.
    • cell background (Cell Background) to change the background color of your selection. Choose a color from the color picker, or type a HEX Color code and click OK.

      color picker

      To restore the default background color, click clear formatting (Clear Formatting) in the color picker.

    • vertical align (Vertical Align) and choose an option from the drop-down menu to apply top, middle, or bottom alignment to the selection.
    • horizontal align (Horizontal Align) and choose from one of the following drop-down menu options to horizontally align the selection:

      • align left (Align Left)
      • align center (Align Center)
      • align right (Align Right)
      • align justify (Align Justify)
    • cell style (Cell Style) to change the border of the selected cells. Choose Highlighted from the drop-down menu to apply a red border. Choose Thick from the drop-down menu to apply a thick border. Choose the drop-down menu item again to remove an existing cell style.

For information about using links in the Manual in the Learning Console for lab end users, see Using links.

  1. Select the text or move the cursor where you want to insert the link.
  2. Click insert link (Insert Link).
  3. Enter the link URL in the URL field and the text that you want to display in the Text field. Then click Insert.

    link details

  1. Click the link.
  2. Click one of the following:

    • open link (Open Link) to open the link in a new tab.
    • edit link (Edit Link) to edit the link URL or display text.
    • unlink (Unlink) to remove the link.

Inserting special characters

To insert a special character using the rich text editor
  1. Move the cursor where you want to insert the special character.
  2. Click special characters (Special Characters).
  3. Select a category in the header row, and then select a special character.

    special characters details

Inserting a video

You can embed a video that is hosted on a service like YouTube or Vimeo in your Manual to create a more interactive experience. For information about using videos in the Manual in the Learning Console for lab end users, see Using videos.

To insert a video using the rich text editor
  1. Move the cursor where you want to insert the video.
  2. Click insert video (Insert Video).
  3. To insert a video using the URL, click by url (By URL), paste the video URL in the box displayed, and then click Insert. To insert a video using the embedded code, click embedded code (Embedded Code), paste the video embedded code in the box displayed, and then click Insert.

    Notes

    • You can typically find the embedded code for a video by navigating to the video URL in a browser, clicking share, and then finding the embed option.
    • When you insert a video using the embedded code, paste only the code that is wrapped in an iframe.
To replace or remove a video
  1. Click the video.
  2. Click one of the following:

    • replace (Replace) to replace the current video with a new one. You can insert the new video using the URL or embedded code.
    • remove (Remove) to remove the video.

Inserting an image

For information about using images in the Manual in the Learning Console for lab end users, see Using images.

To insert an image using the rich text editor
  1. Move the cursor where you want to insert the image.
  2. Click insert image (Insert Image).
  3. To upload an image, click upload image (Upload Image), and then click the Drop image box to select an image using the file browser or drag an image into the box. To insert an image using the image URL, click by url (By URL), paste the image URL in the box displayed, and then click Insert.

    Notes

    • When you upload an image, the image is hosted in Course Manager.
    • For more information about viewing all uploaded images in a specific Manual, see Viewing Manual attachments.
    • To insert additional instances of an uploaded image without hosting multiple copies of the image in Course Manager:
      1. Click the uploaded image.
      2. Press Ctrl+C (or +C for macOS) to copy the image.
      3. Move the cursor where you want to insert the copy of the image.
      4. Press Ctrl+V (or +V for macOS) to paste the image.
To access additional designs options or replace or remove an image
  1. Click the image.
  2. Click one of the following:

    • replace (Replace) to replace the current image. Upload a new image or type a URL to use an image from the internet.
    • align (Align) and choose from one of the following drop-down menu options to horizontally align your image:

      • align left (Align Left)
      • none (None)
      • align right (Align Right)
    • remove (Remove) to remove the image.
    • insert link (Insert Link), paste the link URL in the URL box, and then click Insert to create a linked image.
    • display (Display) and choose the appropriate option from the drop-down menu to display the image inline or break the text around the image.
    • alternative text (Alternative Text), type or paste alternative text in the Alternative Text box, and then click Update to show alternative text for screen readers or if the image doesn’t load.
    • change size (Change Size), type new dimensions in pixels in the Width and Height boxes, and then click Update to change the size of your image. To preserve the original aspect ratio of the image, type auto in one of the boxes.

      image change size details

    Notes

    • If you replace or remove an image in a Manual, and that image is hosted in Course Manager, the image isn't removed from Course Manager as long as it is referenced in any current published Manual, any current draft Manual, or any Manual being accessed by a lab end user.
    • To resize an image while preserving the original aspect ratio, click the image and drag one of the corners.

Uploading a file

For information about using files in the Manual in the Learning Console for lab end users, see Using files.

To upload a file using the rich text editor
  1. Move the cursor where you want to insert the file.
  2. Click upload file (Upload File).
  3. Click the Drop file box to select a file using the file browser, or drag a file into the box.

    Notes

    • When you upload a file, the file is hosted in Course Manager. It is displayed in the Manual as an inline link.
    • For more information about viewing all uploaded files in a specific Manual, see Viewing Manual attachments.
    • To insert additional instances of a file without hosting multiple copies of the file in Course Manager:
      1. Select the uploaded file link.
      2. Press Ctrl+C (or +C for macOS) to copy the file link.
      3. Move the cursor where you want to insert the copy of the file.
      4. Press Ctrl+V (or +V for macOS) to paste the file link.
  1. Click the link.
  2. Click one of the following:

    • open link (Open Link) to open the link in a new tab.
    • edit link (Edit Link) to edit the link URL or display text.
    • unlink (Unlink) to remove the link.

    If you edit or remove an uploaded file link in a Manual, the file isn’t removed from Course Manager as long as it is referenced in any current published Manual, any current draft Manual, or any Manual being accessed by a lab end user.

Switching to code view

To view and edit the HTML for content in the rich text editor, click code view (Code View). Click code view (Code View) again to switch back to the rich text editor.

Inserting a placeholder

Use a placeholder to personalize content for each recipient.

To insert a placeholder using the rich text editor
  1. Select the text or move the cursor where you want to insert the placeholder.
  2. Click insert placeholder (Insert Placeholder).
  3. Select one of the available placeholders from the drop-down menu. Course Manager inserts the corresponding placeholder code.

Keyboard shortcuts

Rich text editor effect Windows keyboard shortcut macOS keyboard shortcut
Bold Ctrl+B +B
Italic Ctrl+I +I
Underline Ctrl+U +U
Strikethrough Ctrl+S +S
Increase quote indentation Ctrl+ +
Decrease quote indentation Ctrl+Shift+ +Shift+
Insert link Ctrl+K +K
Insert image Ctrl+P +P