Plan Availability | All plan types |
Permissions | General Access: Add, edit, and delete Callouts in SmartDocs. |
Related Reading |
Overview
The SmartDoc Callout feature helps highlight important information in your documents. Whether you're providing warnings, best practices, or notes, Callouts make key details stand out visually.
When to Use SmartDoc Callouts
Callouts can improve your document’s readability and clarity in several ways. Use them to:
Add Warnings: Emphasize critical safety protocols or important considerations.
Highlight Best Practices: Showcase "pro tips" or recommendations in your documentation.
Insert Disclaimers: Alert readers to recent updates or changes in the content.
Emphasize Success/Error Conditions: Make testing procedures or conditional outcomes more noticeable.
Separate Notes: Distinguish supplemental information from the main document content.
Using SmartDoc Callouts
Adding a New Callout
Follow these steps to add a Callout:
Use the Slash Command:
Type
/at the start of a new line or after a space.Type "callout" or scroll to the Advanced section to locate it.
Click Insert Callout.
Ready for Input:
A Callout will be added to your document, defaulting to the "Info" type.
Your cursor will automatically focus in the Callout container, allowing you to start adding content immediately.
Setting the Callout Type
SmartDoc Callouts offer six different types, each with a unique visual style. To change the type:
Click the Callout Type Icon:
Select the icon corresponding to the desired type from the Callout toolbar.
Dynamic Updates:
The icon and background color will adjust automatically.
Tip: You can update the Callout type at any time.
Embedding Content in a Callout
Callouts are versatile and allow for:
Formatted Text: Use bold, italics, or other text formatting.
Tables: Embed data directly within the Callout.
Images and Mentions: Include visuals and @mentions to enhance the content.
Example: A Callout can combine text formatting, a table, and a mention, making it highly flexible for various use cases.
Editing a Callout
Edit Content:
Click anywhere in the Callout to make changes to the text or embedded elements.
Change Type:
Update the Callout type by selecting a different icon from the toolbar.
Reminder: Save the record to ensure your edits are preserved.
Deleting a Callout
If a Callout is no longer needed:
Click on the Callout to select it.
Click the Trash Can Icon (hovering will display a "Delete" tooltip).
Tip: Accidentally deleted a Callout? Use Control-Z to undo the deletion and restore it intact.
Practical Use Cases and Scenarios
1. Highlighting Critical Instructions
Scenario: A safety manual requires clear warnings about hazardous materials.
Solution: Use a Callout to add a visually distinct warning.
Outcome: Improved safety awareness and compliance.
2. Sharing Best Practices
Scenario: A training document includes tips for optimizing workflows.
Solution: Add "Pro Tip" Callouts to highlight actionable recommendations.
Outcome: Enhanced learning and adoption of best practices.
3. Distinguishing Notes from Main Content
Scenario: A project update includes supplemental notes alongside core details.
Solution: Use a Callout to separate notes and make them easy to identify.
Outcome: Cleaner and more organized communication.