Preview topics

Use the Writerside Preview tool window to preview the topic you are working on exactly the way it will be published.

By default, the preview shows the topic that is currently open in the editor, syncs the position in the preview to the position of the cursor in the editor, and instantly updates when you make changes to the content. If you are editing a topic file not in the current instance, a library file, a tree file, or any other file that cannot be previewed, the Writerside Preview tool window will show the previous topic that it was able to render.

Click to pin the current topic in the preview. In this pinned mode, you can edit other topic files without the preview switching from the pinned topic. You can click the name of the pinned topic in the Writerside Preview tool window toolbar to open it in the editor.

Click copy the link to the local preview if you want to share with someone who has access to the built-in web server on your machine. For more information, see Share preview link.

Click to search for words in the previewed topic. This can be useful when you include some content in a topic and need to make sure that it is in the output.

Click to refresh the preview. Usually, the preview should update automatically on every change in the previewed topic, but this button allows you to force an update in case it does not work.

Click to open buildprofiles.xml and customize the appearance of your documentation website. For more information, see Customize output.

To open the current topic and preview the whole help in your web browser, click Open in Browser.