The regular start file is used when you call the start file of the project, such as newproject.htm.  This start file supports the following methods:

• Map numbers.
• Topic id's.
• Relative path to a file in the project.
• Relative path to a file in the project folder but not in the project.

This start file supports the following options:

• Specifying the window you want to use.
• Specify whether you want the help to open in a separate popup.

The regular start file is very flexible since you can use windows (RoboHelp > Project Set-up > Windows) to determine how your help will look: showing or hiding the navigation pane, showing or hiding the toolbar and setting the browser dimensions. I assume you are familiar with windows. One note: Always deselect Use Default Browser Settings in the window definition or the window will not work in Firefox. If you do not want to use a window definition at all but just open the help, consider using the _csh start file.

This start file supports two methods of calling the WebHelp. The first method is the regular method that is used by the default RoboHelp JavaScript API and my custom APIs. The other method is an internal method that the WebHelp uses when you call the WebHelp using the regular method: When you call the help using the regular method, the WebHelp reads the window definition and other settings and redirects using the internal method.

Calling WebHelp

Say that we have a fictitious context sensitive WebHelp project published on http://localhost/newproject.htm. The file newproject.htm is the start file of the project. In this section I will show you how to create a URL to call this WebHelp project.

Default method

To trigger the context sensitivity, add #< after the path of the project start file:

http://localhost/newproject.html#<

After these characters, you can specify the options. You have to separate multiple options with >>. You can use the following options:

Note the following:

• If you use the option cmd, you cannot use context sensitivity. The project will always open the default topic even if you specify an id and a window.
• You can only specify a window if you use id, str, url or topicurl.
• You may define the options in any order you want.
• The Firefox default popup blocker blocks the help popup for WebHelp. If you support Firefox, consider setting newwnd=false.

For example, if you want to call the topic with map number 3 without creating a popup, use the following URL:

http://localhost/newproject.htm#<id=3>>newwnd=false

Another example: if you want to call the topic with topic id MyTopic in a popup and using the window NoNavPane1, use the following URL:

http://localhost/newproject.htm#<str=MyTopic>>wnd=NoNavPane

Using a window and not opening in a popup

When you use a window defintion, you may expect to be able to use >>newwnd=false to open the help in the same browser window:

http://localhost/newproject.htm#<str=MyTopic>>wnd=NoNavPane>>java=true (RoboHelp 7)
http://localhost/newproject.htm#<str=MyTopic>>wnd=NoNavPane>>newwnd=false (RoboHelp 8 and above)

to open the help in the same browser window. In RoboHelp 8 and 9, you can't just use >>newwnd=false because of a small bug in WebHelp. To fix this bug, you need to modify the file whcsh_home.htm as follows:

1. Open whcsh_home.htm in a text editor or HTML editor.
2. Go to the function SwitchURL();
3. Find the second instance of if(gsWindow) on line 210 (RoboHelp 8).
4. Change the if statement if(gsWindow)to if(gsWindow &&  gsNewWnd == "true"):

else
{
  if(gsWindow && gsNewWnd == "true")//This line has been changed
  {
    var nTop=getSValue(oWnd.sBTop,screen.height);
    var nLeft=getSValue(oWnd.sBLeft,screen.width);
    var nWidth=getSValue(oWnd.sBWidth,screen.width);
    var nHeight=getSValue(oWnd.sBHeight,screen.height);
    window.resizeTo( nWidth , nHeight);
    window.moveTo(nLeft , nTop);
  }
  document.location=sURL;
}

5. Save changes and close whcsh_home.htm.

You can now use a window defintion and open the help in the browser window instead of opening in a popup.

Internal method

To trigger the context sensitivity, add # or #>> after the path of the project start file:

http://localhost/newproject.htm#
http://localhost/newproject.htm#>>

Then add the relative path to the topic you want to open:

http://localhost/newproject.htm#mydir/mytopic.htm

The difference between # and #>> is that the first method expects a relative path to a topic. If you do not want to specify a topic, you must add #>> after the URL. If you only add a hash, the WebHelp will think that the first option you specify is a relative path to a topic. This means that the >> directly after the # is optional when you specify a relative path.

Note: If you do not specify a relative path, the project opens the default topic.

After specifying the relative path, you can specify the options. You have to separate multiple options with >>. You can use the following options:

For example:

http://localhost/newproject.htm#mydir/mytopic.htm>>cmd=1,pan=2
http://localhost/newproject.htm#>>mydir/mytopic.htm>>cmd=1,pan=2

Note: When you want to call the relative path, you must specify the relative path before you specify any options. Otherwise the help will not open the correct topic.

This method for context sensitivity uses the following files:

• Start file
• whstart.js
• whcsh_home.htm
• whcshdata.htm

• 1. This is not a default RoboHelp window. You need to create all windows yourself in the RoboHelp project.