Authoring - Renaming projects

The project name is a unique string included in the Urls to using the content in help and documentation systems. It can easily be renamed. However, do this with care because if the content is already active then probably people or applications are already using the HelpServer Urls. If you change the project name, then those Urls are no longer valid. There are two options to correct this.

Next steps explain how to rename a project.

Renaming a project

Popup the menu of the project folder and select 'Project > Rename'.

Assigning a new project name

Enter a new, unique project name and click 'OK'. Consider the project name guidelines.

If you specify a project name, consider the following guidelines.

The name must be unique within the entire HelpServer system.


Keep the name meaningful but avoid using long names.


If the name consists of multiple words, use a '_'  (underscore) or a '-' (hyphen) instead of blanks.


The project name cannot contain '.' (dot).


Translation is not applicable.


A message box can popup as a reminder.

Project name guideline

Rename correctly performed

A message box will confirm that the rename is correctly performed. The new project name is immediately active and all aliases are correctly processed and ready to be used. You don't have to publish anything. Should you have applied versioning then the new name is also active in older (inactive) versions of the project.

New project name is immediately active

See also Revalidating URLs after renaming a project


 About HelpServer
 Starting up and logging on
 The basic working principles
 Using the content in help and documentation systems
 Formatting the content
 Searching and replacing text
 Reusing content with shares
 Navigating with hyperlinks
 Navigating with pointerpaths
 Using bookmarks and jumps
 Duplicating content with clones
 Using tables
 Including media files
 Navigating to web pages
 Using embedded chunks
 Including html code
 Navigating with menus
 Using snippets
 Spelling checking
 Using the view mode
 Creating an index
 Creating a FAQ
 Creating a glossary
 Team authoring
 Working with projects
 Maintaining files
 Maintaining aliases
 Renaming projects
 Reorganizing projects
 Determining the activation type
 Setting up structured authoring
 Generating file based output
 Creating printed output
 Importing files and folders
 Loading files in the project gallery
 Converting legacy content
 Including legacy content in real time
 Transferring objects between installations
 Customizing the look and feel
 User accounts
 Working with templates
 Working with metadata
 Workflow management
 Using event exits
 Appendix A: The URL parameters
 Appendix B: The object indicators
 Appendix C: Play Javascript