Change topic title
By default, Writerside uses the same topic title in all help instances where you add this topic. It also renders the topic title for the corresponding TOC entry.
As your content evolves, you may want to change the topic title to better reflect its current content.
Right-click a topic in the Writerside tool window and select Edit Title.
Specify the topic title and click OK.
The main topic title is defined in the title attribute of the root <topic> element. In a Markdown topic, the H1 header # is considered the topic title.
Override topic title for help instance
If you reuse a topic in multiple help instances, you may want to adjust the title for a specific instance. For example, add a related technology name or some important keywords to make it more discoverable.
Right-click a topic in the Writerside tool window and select Edit Title.
Under Advanced Settings, specify a title for the current instance and click OK.
This will add the following line to the topic:
Override TOC title
If the topic title is long and contains many important keywords, you can set a shorter title to use for the corresponding TOC entry. The main topic title will remain the same.
Right-click a topic in the Writerside tool window and select Edit Title.
Under Advanced Settings, specify a TOC title and click OK.
This will add the toc-title attribute to the corresponding <toc-element> in the .tree file of the current instance:
Change web page name
By default, the name of the web page generated from a topic is the same as the topic file name. It is important both for your readers and SEO that the URL reflects the content of the web page.
Either change the topic file name or use the
<web-file-name>element to set a custom name of the web page for the topic:<web-file-name>document_almost_everything.html</web-file-name>Add a redirect from the previous topic URL to this topic to prevent 404 errors in links that point to the old URL.
Change topic file name
You may want to change the name of the topic file to ensure that it properly reflects the content. This topic file name is used as the web page name by default. Your readers and search engines rely on the name in the URL. Relevant file names also make navigation easier for authors in your documentation project.
Select a topic in the Writerside tool window and press Shift+F6.
In the Rename dialog, specify the new name for the topic file.
Click Refactor to automatically update all references to this topic in your project.
You can also click Preview to first review all changes that will happen in a dedicated tool window, and click Do Refactor if they look good.
The Rename refactoring will also update the topic ID, which must be the same as the topic file name.
Add a redirect from the previous topic URL to this topic to prevent 404 errors in links that point to the old URL.