Topic aliases allow you to define alternative URLs for a topic. This feature is used by the default HTML template in HelpNDoc to automatically create URL alias redirects, so that visitors accessing an alias are redirected to the topic's main URL. They can be defined from the topic properties panel.

Managing aliases

You can manage aliases for a topic through the List editor dialog:

  • Add - Create a new alias for the current topic.
  • Rename - Edit the selected alias.
  • Delete - Remove an alias from the list.
  • Move up / Move down - Reorder aliases if necessary.

Each alias is stored as a text entry (e.g., intro.html, intro/index.html, introduction/index.html). A topic may have multiple aliases defined, and all will redirect to the main topic URL when the HTML documentation is published.

Use cases

  • Maintain backward compatibility when topic URLs change.
  • Provide multiple entry points to the same topic for usability.
  • Simplify transitions from older documentation structures to new ones.