Instructions File Import

Prev Next

Overview

The Instructions File Import feature allows users to import content from Word, RTF, and Markdown files directly into the Instructions Editor. This feature streamlines the workflow for lab authors and other users who frequently use these formats for creating and sharing content.

Instructions File Import Tool-Round 1.gif

Workflow and Steps

1. Import into Instructions Sets:

  • Begin a new instruction set or open an existing instruction set.

  • Place your cursor at the position where you want the imported content to be inserted.

  • Click Import from file(s) image.png.

  • The Import from file(s) modal window opens, allowing you to add content.
    image.png

  • Add content by dragging and dropping files into the Upload files(s) box or by clicking the Upload file(s) box to select files.

image.png

2. Arrange Files:

  • Organize file in any desired order using the modal window's drag-and-drop functionality.

image.png

Tip: To automatically separate each imported file onto its own page in Lab Instructions, select the Separate each file by a page break checkbox.

Tip: All media is presented inline by default, but can be updated to render as a pop-up. Select the Render media as pop-ups the user can open by clicking a link checkbox to switch media from inline display to a pop-up.

3. Import Content:

  • After arranging the files, click Insert.
    The content is converted into Markdown and inserted at the current cursor position.

4. Display Converted Content:

  • The converted Markdown content is displayed in the editor for further editing. A preview option is available to view the Markdown rendering.

Error Handling:

  • The system handles unsupported formats or conversion errors.
  • User-friendly error messages are displayed, and errors are logged for further analysis.

Suggestions for Use

  • Streamline Workflows: Enable users to import Word and RTF documents directly into the Markdown editor, reducing the need for external tools and simplifying the conversion process.
  • Improve User Experience: Save time and effort for subject experts and technical writers, allowing them to focus on content creation.
  • Enhance Productivity: Provide a seamless experience for users, allowing them to focus on creating and editing content without worrying about format conversions.