Editing Topics
| The Block-based Topic Editor is currently in the beta stage; the functionality is subject to change and will be continuously improved. |
When creating topics in ClickHelp, you can choose between two content editors: the Block-based Topic Editor and the Advanced Topic Editor. This topic highlights the differences between the editors and helps you decide which editor best suits your needs by comparing their key features and providing recommendations on when to use each.
Overview of Editors
Advanced Topic Editor. A versatile WYSIWYG editor with advanced customization options, including HTML editing, which makes it ideal for complex documentation with specific design and layout requirements.
Block-based Topic Editor. A simplified editor that offers an intuitive, block-oriented approach, focusing on ease of use and essential formatting features. No HTML knowledge is required, making it an accessible choice for creating straightforward, visually consistent content.
Key Features Comparison
|
Feature
|
Block-based Topic Editor
|
Advanced Topic Editor
|
|---|---|---|
| Editing Mode | Visual block-based editing | WYSIWYG editing |
|
HTML Source Editing
|
Not supported
|
Supported
|
| Formatting Options | Basic (bold, italics, lists) | Full formatting capabilities |
| Image Insertion | Supported | Supported |
|
Video Insertion
|
Only from Storage
|
Online and from Storage
|
| Table Creation | Basic tables | Advanced table features |
| Global Find & Replace | Find only | Find & Replace |
| Font Customization | Not supported | Supported |
|
Right-to-Left (RTL)
|
Supported | Supported |
When to Use the Block-based Topic Editor
The Block-based Topic Editor is designed for users looking for a straightforward way to create content with minimal formatting needs. We recommend using this editor when:
- You want simple, clean content without advanced styling.
- You do not need custom HTML or complex formatting.
Examples of suitable content for the Block-based Topic Editor include knowledge base topics, internal guides, and FAQs where simplicity is key.
| Since the Block-based Topic Editor is in the beta stage, some advanced features, like full Find & Replace, font customization, and embedded custom code, are not yet available but may be added in future updates. |
When to Use the Advanced Topic Editor
The Advanced Topic Editor remains the preferred choice for users who require greater control over the layout and styling of their content. Consider using it if:
- You need custom HTML or specific formatting beyond basic styles.
- Your documentation requires detailed styling and layout adjustments.
- You work with complex elements or need a wider range of styling options, such as custom fonts.
Examples of content best suited for the Advanced Topic Editor include external-facing product documentation, technical manuals, and branded materials where custom styling and detailed layout control are necessary.
Summary
Choose the editor that best aligns with your documentation needs:
- Block-based Topic Editor: Best for straightforward, accessible content with basic formatting needs.
- Advanced Topic Editor: Best for detailed, branded, and highly customized content requiring HTML and advanced styling.
If you’re still unsure, start with the Block-based Topic Editor for simpler content and select the Advanced Topic Editor for topics that need more complex formatting.