Navigation: Editing Project Options > Web Help >

Web Help: General Options

Send comments on this topic.



1.On the Project tab, in the Project group, click Project Options.

2.In the Project Options dialog, in the left sidebar, click Web Help.

3.Change the parameters that you need.

4.Click OK.


Below is a description of the parameters in this section.



Allows you to define a custom title to use in the Web Help system. By default, the help project's general title is used.



Allows you to define custom copyright information to use in the Web Help system. By default, the help project's general copyright information is used.


Google Analytics Tracking ID

Specifies the Tracking ID that allows you to integrate the Web Help system with the Google Analytics service. Google Analytics allows you to get reports of your user audiences and traffic sources.


Create Google Sitemap

If selected, HelpSmith will generate a Google Sitemap file during the compilation of the Web Help system. A sitemap file is used to provide better indexing and ranking of the whole help system in Google.


Web Help URL

Specifies the URL location of the Web Help system on a web server. The URL is required to generate the Google Sitemap file properly.


Create Index

Specifies whether to create the keyword Index in the Web Help system.


Lower case for file names

If selected, HelpSmith will automatically convert all the filenames and directories used within the Web Help system into the lower case.

This option is useful to prevent potential access problems on UNIX-based servers that have a case-sensitive file system.


Note: If you activate this option on an existing help project for the first time, you may need to clear your Web Help output folder and re-compile the help project.


SEO friendly topic file names

Allows you to generate SEO-friendly filenames for help topics in Web Help.

HelpSmith uses topic IDs to name topic files. If this option is selected, the "_" characters in the filenames will be replaced with hyphens ("-"). Since these filenames can be used for linking to the Web Help system from a website, this option allows you to have URLs which are better for indexing by search engines.


Insert Mark of the Web (for Internet Explorer)

Use this option to disable the Internet Explorer's security warning bar by mapping the Web Help system's HTML content to a more restrictive Internet Zone. Inserting the Mark of the Web (MOTW) is recommended for HTML pages that will be viewed from a CD, HTML pages that run from the local computer, and for Web pages that include frames.



Specifies the style of tabs in the navigation pane in the Web Help system.


Default topic template

Allows you to set the default template that will be applied to the help topics when you compile the Web Help system.

Note that individual topics can override this setting and either use a different template or use no template.

Copyright © 2007-2024