Change the Initial Tab View in WWH

By default, a WebWorks Help 5.0 helpset opens and displays the Table of Contents tab. It is possible to configure your project to display one of the other tabs when the helpset is launched, and there are a few options:

Format Override

1. To ensure that the desired tab is displayed each time a user launches the output, you can perform an override on the JavaScript responsible for this behavior. The file you'll want to override is located here by default: C:\Program Files\WebWorks\ePublisher Pro\Formats\WebWorks Help 5.0\Files\wwhelp\wwhimpl\common\scripts\help.js

2. Perform the override (copy it into the appropriate subfolder in your project directory) and open it in a text editor, such as NotePad.

3. At the top of the file, you'll see the following declaration: this.mInitialTabName = null;

this.mInitialTabName = "search";

4. Save help.js and regenerate your output to apply the changes.

URL Parameters

You can also specify the initial tab that is shown by changing the way you call your helpset. If your website or application launches the WWH helpset via a browser URL, you can add an argument to that call to designate a particular tab. For example: ../helpset/myhelp/index.html?tab=index

WebWorks Help SDK

If you are using the WebWorks Help SDK (or API) to connect an application with your output, you can use special functions within the SDK to specify the initial tab. The details are documented within the SDK package. For more information on the WebWorks Help SDK, please see our Wiki area here: http://wiki.webworks.com/DevCenter/Projects/WebWorksHelp/WebWorksHelpSDK


CategorySolutionsOutputWebWorksHelp

LaurenLever/@Solutions/Output/WebWorks Help 5.0/Change Inital Tab View (last edited 2009-06-02 19:40:50 by LaurenLever)