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 define user-friendly URL links for topics

I've created a new HelpSmith project and compiled it as a web help system.

The URL link to the topic looks like:

http://127.0.0.1:8080/WebHelp/idh-topic10.html

How do I define a meaningful URL link for my topics (like you have in the sample help projects)?

27

Comments

How do I define a meaningful URL link for my topics

Defining filenames in a web help system

In HelpSmith, a topic has two identifiers which are numeric Context value and textual ID value. When you create a Web Help system, HelpSmith generates the filenames based on the textual IDs of topics.

Therefore, to change the default ID such as IDH_Topic10, you should edit properties of this topic:

  1. In the Project Manage pane, double-click on the topic.
  2. In the dialog, specify a new ID value.
  3. Click OK.

When you re-compile your help system, the topic will have a new filename. So it will also have the URL link as you need.

You can find more details on editing topic properties here.

17

Recommended format for ID values of topics

Please note that for ID values it is recommended to use the format like "How_to_Create_Help_File" as shown on the screenshot above.

By default, the SEO friendly topic file names option is enabled in the project's Web Help settings. With this option, HelpSmith will automatically generate SEO-friendly links based on the ID values by replacing the "_" character with "-".

10

Changing the ID value has worked, thank you!

3

Add a Comment

Please Login or Register or leave comments.

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