HelpSmith Logo
Making Help Authoring a Pleasure to Do
Free DownloadStart your free trial now
HelpSmith Topics
Making Help Authoring a Pleasure To Do

How to set SEO-friendly filenames for topics?

When I export my help project as a web help system, the filenames of my topics are named like "idh-topic10.htm".

I would like to set meaningful filenames that correspond to the titles of the topics, which is important for better indexing/ranking of the pages by search engines, etc.

For example:

If I have a topic named "User Interface", it should have the filename "user-interface.htm".

Does HelpSmith provide an option to have SEO-friendly filenames for topics?



Generation of topic filenames

When you compile a Web Help system, HelpSmith generates the filenames based on the textual IDs of the topics.

To edit the ID value of a topic:

  1. In the Project Manager pane, double-click on the topic that you need.
  2. In the dialog, in the ID box, set the desired value.
  3. Click OK.

Editing topic properties

Remark: The ID value should have the format like "My_Topic".


Does HelpSmith provide an option to have SEO-friendly filenames for topics?

For topic IDs, it is recommended to use the format like "My_Topic" (as shown on the screenshot above) since this format is compatible with the HTML Help (CHM) and Web Help systems.

SEO-friendly topic filenames in Web Help

In Web Help, HelpSmith can automatically replace the "_" character with the "-" character for SEO-friendly filenames. For example, if the ID value of a topic is "My_Topic", the filename generated for that topic will be "my-topic.htm".

Enabling/disabling this option:

By default, this option is enabled in a new help project, but you can enable/disable it here:

  1. On the Project tab, click Project Options.
  2. In the Project Options dialog, in the left sidebar, select the Web Help section.
  3. Check the option SEO friendly topic file names.
  4. Click OK.

Changing the file extension

If needed, you can also change the file extension (for example: .htm, .html, etc.) of the generated HTML files at:
Project tab|Project Options|HTML Export


Add a Comment

Please Login or Register or leave comments.

Hello World
Lorem ipsum dolor sit amet
Nickname or Email:
If you do not have an account, you can register.