Using the topic editor
The Topic Editor is the main workspace in HelpNDoc where you write and format the content of your documentation. It works much like a standard word processor: simply select a topic in the table of contents, then start typing and editing its content.
Most familiar word-processing operations are available directly from the ribbon, the editor's right-click menu, or using standard keyboard shortcuts. You can select and edit text, undo or redo changes, cut or copy content, paste content from other applications, and format text and paragraphs.
Copying and pasting content
HelpNDoc provides several copy and paste options to make it easier to exchange content with other applications and documentation tools.
Copy copies the selected content to the clipboard using the standard clipboard formats supported by the Topic Editor. This is generally the best option when moving content between HelpNDoc topics or pasting it into compatible word-processing applications.
Copy as Markdown converts the selected content to Markdown before placing it on the clipboard. By default, pictures are included directly in the Markdown as inline Base64-encoded images, making the copied Markdown self-contained. To copy the Markdown without embedding pictures as Base64 data, hold the CTRL key while using the Copy as Markdown action.
Paste inserts the clipboard content using the most appropriate format automatically, preserving formatting and other supported elements whenever possible.
Paste as text inserts only the textual content of the clipboard and discards its original formatting.
Paste as Markdown interprets Markdown-formatted clipboard content and converts it into formatted Topic Editor content. This is useful when bringing content into HelpNDoc from Markdown editors, source repositories, AI tools, and other Markdown-based workflows.
Paste Special gives you more control over how clipboard content is inserted. The available choices depend on the formats currently stored in the clipboard, allowing you to select the representation that best suits your needs. For example, the same clipboard content might be available as formatted text, plain text, or an image.
Formatting and organizing topic content
The Topic Editor provides additional tools for controlling how each topic looks and behaves. See the following topics for more information:
- Topic kind explains the different types of topics, including normal topics, empty topics, external URLs, and external files.
- Headers and footers explains how to configure the header and footer displayed for individual topics.
- Font properties covers font faces, sizes, colors, styles, effects, and advanced character formatting.
- Paragraph properties covers alignment, indentation, spacing, tabs, borders, backgrounds, and pagination options.
- Working with styles explains how to apply reusable styles to keep formatting consistent throughout a project.
- Working with lists explains how to create bulleted and numbered lists, organize nested list levels, and customize their appearance and numbering.
- Working with hyperlinks explains how to create links to topics, web addresses, e-mail addresses, files, and other supported targets.
- Working with tables explains how to insert, edit, format, reorganize, and convert tables.
- Working with pictures explains how pictures are added through the library and how their appearance and properties can be customized in a topic.
- Working with the image map editor explains how to define interactive areas within pictures and link them to other content.
- Working with references explains how to insert format-aware cross-references to other topics in your documentation.