ScreenSteps Help

Overview of the ScreenSteps Editor

Updated on

Top Elements

  1. Back to Chapter: Returns you to the table of contents, in the chapter where the article is located.
  2. Article Associations: Shows where the article belongs, including its manual and chapter.
  3. All Changes Are Saved: Confirms that your changes have been saved. Changes in the article editor are saved automatically.
  4. Preview: Opens a draft preview of your changes on the published site so you can review the article before publishing.
  5. Publish: Publishes the article.

Article Outline, Title, and Collaboration

  1. Outline Opener: Opens the article’s outline view.
  2. Article Title: Displays the article title. Select the pencil icon to edit it, then click outside the title field to save the change automatically.
  3. Author Initials: Shows the initials of authors who are currently in the editor. When more than one author is present, you will see multiple sets of initials.
  4. Comments Icon: Opens the comments sidebar so you can review comments that people have left.

Editor Menus

The menu bar provides access to exporting, revision history, editing commands, content insertion, formatting, and Clarify tools.

File Menu

Use the File menu to export content, work with revisions, or switch between an article and a workflow.

  1. Export to Clipboard: Copies the article content to your clipboard so you can paste it into another system.
  2. Export to PDF: Exports the article as a PDF.
  1. Revision History: Save Current Revision: Saves a specific revision without requiring you to publish the article.
  2. Revision History: Open Revision History: Opens the article’s revision history.
  1. Convert to Workflow: Converts an article into a workflow, making questions and checkpoints available.
    Or...
    Convert to Article: Converts a workflow back into an article.

Edit Menu

Use the Edit menu to undo changes, select or copy content, split content into a separate article, and find or replace text.

  1. Undo: Reverses an editing action.
  2. Redo: Reapplies an action that you undid.
  3. Select All: Selects all content in the article.
  4. Create New Article from Selection: Cuts the selected content from the current article and creates a new article containing that content in the same chapter.
  5. Copy Document: Copies the document to your clipboard.
  6. Find and Replace: Finds text within the article and allows you to replace it.

View Menu

Use Collapse Content Blocks and Expand Content Blocks to collapse or expand the article’s content blocks.

The View menu also includes Show Blocks.

Insert Menu

  1. Step: Insert a step content block.
  2. Image: Insert an image (image will be inserted where the cursor is).
  3. Video: Insert a video you've saved on or record a new video from scratch.
  4. Table: Insert a table.
  5. Link: Insert a link.
  6. Attachment: Insert an attached document/file.
  7. Comment: Insert a comment (which is an internal comment for other authors).
  8. Foldable Section: Insert a foldable section.
  9. Block Quote: Insert text that is styled as a Block quote.
  10. Code block: Insert text that is styled as a code block.
  11. HTML snippet: Insert HTML such as embed code or other HTML text.

Format

Use the Formatting menu to change the appearance and structure of your content.

  1. Text formatting: Bold, italic, underline, strikethrough, superscript, subscript, and code
  2. Font: Font color and font background color
  3. Headings: Heading styles
  4. Content styles: Modify the style of the text to pre-formatted style of Normal, Introduction, Info, Alert, Tip, Warning, and Prompt
  5. Checklist: This allows you to create checklists which act as foldable sections as well.
  6. Bulleted list 
  7. Numbered list 
  8. Indentation: Increase indent and decrease indent
  9. Remove Format 

Tools

The Tools menu includes Clarify Check, Clarify Assistant, Clarify Create, and Clarify Transform.

Clarify Check 

Compares content in the current article with other articles in ScreenSteps to identify potential duplicates and potential conflicts.

Clarify Assistant 

Opens a free-form prompt box where you can describe what you want it to do.

You can use it to create content from scratch or work with selected content. For example, you can ask it to draft an overview article about a particular topic, translate selected text into another language, or revise content according to your instructions.

Clarify Create 

Helps you create article content from information you provide, including:

  • Voice recordings and audio files
  • Pasted text, such as a transcript from a video recording
  • PDFs and Word documents
  • Use it to turn information from outside ScreenSteps into article content.

Clarify Transform 

Provides built-in prompts for transforming existing content in your ScreenSteps article.

GoalAvailable transformations
Change the type of contentMake content actionable or foundational
Shorten contentSummarize
Change the formatConvert to a table, numbered list, bulleted list, or paragraph
Organize branching informationConvert to a decision tree
Improve accessibilityApply the available accessibility prompts

 

Editor Toolbar

  1. Undo, Redo, and Clarify Shortcuts

    The first group of toolbar controls includes Undo, Redo, Clarify Assistant, Clarify Create, and Clarify Transform.

  2. Clarify Assistant

    Opens a free-form prompt box where you can describe what you want it to do.

    You can use it to create content from scratch or work with selected content. For example, you can ask it to draft an overview article about a particular topic, translate selected text into another language, or revise content according to your instructions.

  3. Clarify Create

    Helps you create article content from information you provide, including:

    • Voice recordings and audio files
    • Pasted text, such as a transcript from a video recording
    • PDFs and Word documents
    • Use it to turn information from outside ScreenSteps into article content.
  4. Clarify Transform

    Provides built-in prompts for transforming existing content in your ScreenSteps article.

    GoalAvailable transformations
    Change the type of contentMake content actionable or foundational
    Shorten contentSummarize
    Change the formatConvert to a table, numbered list, bulleted list, or paragraph
    Organize branching informationConvert to a decision tree
    Improve accessibilityApply the available accessibility prompts
  5. Headings

    Lets you choose normal text or a heading style.

  6. Text, Headings, and Content Styles

    Select the text you want to format, then use the toolbar controls to apply your changes.

    ControlWhat it does
    BoldApplies the selected text formatting.
     Italic Applies the selected text formatting.
    UnderlineApplies the selected text formatting.
    Font Changes the text color or background color behind the text.
    Subscript Applies subscript formatting.
    SuperscriptApplies superscript formatting.
    Paragraph / Content StylesModify the style of the text to pre-formatted style of Normal, Introduction, Info, Alert, Tip, Warning, and Prompt
  7. Hyperlinks

    Use the hyperlink control to connect readers with related content inside or outside ScreenSteps.

    Link destinationHow you can use it
    Another ScreenSteps articleLink to a related article using ScreenSteps’ built-in article linking system.
    A manual or chapterDirect readers to a manual or chapter in ScreenSteps.
    An external resourceLink to a resource outside ScreenSteps.
    A heading in the current articleDirect readers to a specific section—for example, when creating a table of contents within the article.
  8. Comments

    Use the toolbar’s comment control to add a comment to specific content.

  9. Steps

    Inserts a step content block.

  10. Images

    Inserts an image.

  11. Tables

    Inserts a table.

  12. Lists, Indentation, and Removing Formatting
    ControlWhat it does
    ChecklistFormats content as a checklist.
    Bulleted ListFormats content as a bulleted list.
    Numbered ListFormats content as a numbered list.
    Increase IndentIncreases the indentation of the selected content.
    Decrease Indent / OutdentDecreases the indentation of the selected content.
    Remove FormatRemoves formatting from the selected content.
  13. Track Changes

    Toggle Track Changes on to track edits as you work. Deleted content appears in red. Added content appears in green.

Previous Article How to Manually Change Colors in a Table
Next Article How to link to a heading within the same article