Enabling WebHelp Plus Output

Enabling WebHelp Plus Output

Important WebHelp and WebHelp Plus are deprecated in Flare, which means that they are slated to be removed in a future version.

If you want to take advantage of the advanced server-side features of WebHelp Plus (i.e., automatic runtime project merging, faster search, server-side search, searching of non-XHTML files), you must enable WebHelp Plus output. This includes performing the following tasks: (1) installing Microsoft Internet Information Services (IIS) and ASP.NET, (2) setting up the WebHelp Plus target and generating/publishing, (3) configuring IIS on the production server, (4) starting Microsoft Indexing Service or Microsoft Windows Search (depending on the operating system), and (5) enabling WebHelp Plus search.

It is not necessary to install these in order to simply build WebHelp Plus output. However, if you want to be able to view and display WebHelp Plus output, the following steps are necessary. You must perform these steps on the machine that will be hosting the published WebHelp Plus output. If you want to view the output on your local machine to test the results, then you also need to perform these steps on your local computer, except for the procedure "Configuring IIS on Production Server."

For a complete scenario that illustrates these and other WebHelp Plus steps in a real-life situation, see WebHelp Plus Scenario.

Installing IIS and ASP.NET

The following steps show you how to install IIS and ASP.NET, depending on the operating system.

Windows 8

The following steps show you how to install IIS and ASP.NET 4.5 for Windows 8.

installing iis

  1. Open the Control Panel. On many computers, you can do this by clicking Start > Control Panel.
  2. Select Programs and Features.
  3. Click Turn Windows features on or off.
  4. Select Internet Information Services.
  5. Expand Internet Information Services > Web Management Tools > IIS 6 Management Compatibility.
  6. Click IIS Metabase and IIS 6 configuration compatibility.

installing asp.net 4.5

  1. Under Internet Information Services expand World Wide Web Services.
  2. Expand Application Development Features.
  3. Click the check box next to ASP.NET 4.5 to add a check mark.
  4. Click OK.

Windows 7

The following steps show you how to install IIS and ASP.NET for Windows 7.

installing iis

  1. Open the Control Panel. On many computers, you can do this by clicking Start > Control Panel.
  2. Select Programs and Features.
  3. Click Turn Windows features on or off.
  4. Select Internet Information Services.
  5. Expand Internet Information Services > Web Management Tools > IIS 6 Management Compatibility.
  6. Click IIS 6 Metabase and IIS 6 configuration compatibility.

installing asp.net

  1. Under Internet Information Services expand World Wide Web Services.
  2. Expand Application Development Features.
  3. Click the check box next to ASP.NET to add a check mark.
  4. Click OK.
  5. Click Start.
  6. In the search field enter run.
  7. Click Run. The Run dialog opens.
  8. In the Open field, copy and paste one of the following into the field, depending on whether you have a 32-bit or 64-bit system:

    32-bit

    C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis -i

    64-bit

    C:\WINDOWS\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis -i

  9. Click OK. A window opens, displaying the installation progress of ASP.NET. The window will close automatically when the installation finishes.

Windows Server 2012

The following steps show you how to install IIS and ASP.NET 4.5 for Windows Server 2012.

installing iis

  1. Open the Server Manager.
  2. Click Add roles and features. The Add Roles and Features Wizard opens.
  3. Click Next two times until you ge to the Server Roles page.
  4. Click the check box next to Web Server (IIS).
  5. In the dialog that opens click Add Features.

installing asp.net 4.5

  1. In the Add Roles Wizard click Next.
  2. Expand .NET Framework 4.5 Features and click ASP.NET 4.5.
  3. Click Next.
  4. At the Web Server Role (IIS) tab, click Next again.
  5. Expand Management Tools > IIS 6 Management Compatibility and click IIS 6 Metabase Compatibility.
  6. On the Confirm Installation Selections page of the wizard, click Install.
  7. After the installation is completed, the Installation Results page opens. Click Close.

Windows Server 2008 r2

The following steps show you how to install IIS and ASP.NET for Windows Server 2008 R2.

installing iis

  1. From the Start menu open the Server Manager dialog.
  2. Click Add roles. The Add Roles Wizard opens.
  3. Click Next.
  4. Click the check box next to Web Server (IIS).
  5. In the dialog that opens click Add Required Features.
  6. In the Add Roles Wizard click Next.
  7. Click Next again.
  8. On the "Select Role Services" page of the wizard, expand Management Tools > IIS 6 Management Compatibility and click IIS 6 Metabase Compatibility.
  9. On the Confirm Installation Selections page of the wizard, click Install.
  10. After the installation is completed, click Finish.

installing asp.net

  1. In the Server Manager dialog, expand Roles.
  2. Select Web Server IIS.
  3. In the Role Services section, click Add Role Services.
  4. Click the check box next to ASP.NET to add a check mark.
  5. Click Next.
  6. Click Install.
  7. Click Close.
  8. In the search field enter run.
  9. Click Run.The Run dialog opens.
  10. In the Open field, copy and paste one of the following into the field, depending on whether you have a 32-bit or 64-bit system:

    32-bit

    C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis -i

    64-bit

    C:\WINDOWS\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis -i

  11. Click OK.

    A window opens, displaying the installation progress of ASP.NET. The window will close automatically when the installation finishes.

Windows Server 2008

The following steps show you how to install IIS and ASP.NET for Windows Server 2008.

installing iis

  1. From the Start menu open the Server Manager dialog.
  2. Click Add roles. The Add Roles Wizard opens.
  3. Click Next.
  4. Click the check box next to Web Server (IIS).
  5. In the dialog that opens click Add Required Features.
  6. In the Add Roles Wizard click Next.
  7. Click Next again.
  8. On the "Select Role Services" page of the wizard, expand Management Tools > IIS 6 Management Compatibility and click IIS 6 Metabase Compatibility.
  9. On the Confirm Installation Selections page of the wizard, click Install.
  10. After the installation is completed, click Finish.

installing asp.net

  1. In the Server Manager dialog, expand Roles.
  2. Select Web Server IIS.
  3. In the Role Services section, click Add Role Services.
  4. Click the check box next to ASP.NET to add a check mark.
  5. Click Next.
  6. Click Install.
  7. Click Close.

Windows Server 2003

The following steps show you how to install IIS and ASP.NET for Windows Server 2003.

installing iis via the manage your server dialog

  1. From the Start menu open the Manage Your Server dialog.
  2. Click Add or remove a role.The Configure Your Server Wizard opens.
  3. Click Next.
  4. Select Application server (IIS, ASP.NET) and click Next.
  5. Click Enable ASP.NET and click Next.Your selections are summarized.
  6. Click Next.The Windows Components Wizard opens, displaying the status of the installation.
  7. After the installation is completed, click Finish.

installing iis via the control panel

  1. Open the Control Panel. On many computers, you can do this by clicking Start > Control Panel.
  2. Double-click Add or Remove Programs.The Add or Remove Programs window opens.
  3. Click Add/Remove Windows Components.The Windows Components Wizard opens.
  4. In the list of components select Application Server and then click Details.The Application Server Dialog opens.
  5. Click the check box next to Internet Information Services (IIS) to add a check mark.
  6. In the Windows Component Wizard, "Application Server" should now be selected. Click Next.
  7. Click Finish.

installing asp.net

  1. Click Start > Run.The Run dialog opens.
  2. In the Open field, copy and paste one of the following into the field, depending on whether you have a 32-bit or 64-bit system:

    32-bit

    C:\WINDOWS\Microsoft.NET\Framework\v4.0.30319\aspnet_regiis -i

    64-bit

    C:\WINDOWS\Microsoft.NET\Framework64\v4.0.30319\aspnet_regiis -i

  3. Click OK.

    A window opens, displaying the installation progress of ASP.NET. The window will close automatically when the installation finishes.

    Note ASP.NET pages by default are prohibited in IIS. Therefore, you must set these pages to be allowed if you are running Windows Server 2003. To do this: (1) In Internet Information Services (IIS) Manager, select Web Service Extensions from the left pane; (2) in the right pane, make sure that ASP.NET v4.0.30319 is set to Allowed. If it is not, select it and click the Allow button.

Setting Up a WebHelp Plus Target

The following steps show you how to set up your WebHelp Plus target for server-based output.

How to Set Up the Webhelp Plus Target

  1. In Flare, open the WebHelp Plus target.The Target Editor opens.
  2. Select the Publishing tab.
  3. In the Indexing Service Catalog Name field, type the catalog that you are using for the output. In most cases, this will be Web, which is the default value. However, if you or someone in your company (e.g., network administrator) creates a custom catalog, you need to enter that name in the field.

    What is a catalog? Microsoft Indexing Service stores all of its index information in catalogs. A catalog comprises index information and stored properties for a particular group of file system directories. If Internet Information Services (IIS) is installed, the Indexing Service also creates a web catalog, which contains an index of IIS, the default virtual server of the World Wide Web.

    Note This step is necessary only for Windows Server 2003.

  4. Click Save the active file. to save your work.
  5. Generate the target.
  6. Publish the output to any location on the web server. If you want to use the default location that was created after you installed IIS, you can publish the output to C:\Inetpub\wwwroot. If you do this, you can use the "Default Web Site" folder that you will encounter when performing the next set of steps (i.e., configuring IIS on the production server).

    If you are working on your local machine for testing purposes, you do not need to publish the output. You can simply view your WebHelp Plus output. When you view WebHelp Plus output on your local computer, Flare creates a special folder called "MCPreview" within your "C:\Inetpub\wwwroot" folder, and it places a copy of your WebHelp Plus output files in it. This enables you to test the advanced features of WebHelp Plus on your local machine.

Configuring IIS on Production Server

The following steps show you how to configure IIS, depending on the operating system. These steps are necessary only for the server where you will be publishing the final output. It is not necessary to perform these steps on your local computer for testing WebHelp Plus output.

Windows Server 2003

  1. Open the Control Panel. On many computers, you can do this by clicking Start > Control Panel.
  2. Double-click Administrative Tools.The Administrative Tools dialog opens.
  3. Double-click Internet Information Services.The Internet Information Services dialog opens.
  4. Find your output folder and right-click the Service subfolder. Then select Properties.The Service Properties dialog opens.
  5. Select the Virtual Directory tab.
  6. Next to the Application name field, click the Create button.

    Note If this button has already been selected, it will display as "Remove" instead. In this case, you do not need to click the button.

  7. In the Execute Permissions drop-down, make sure Scripts only is selected. It should already be selected by default.
  8. Click OK.

Windows Server 2008 and 2008 r2, Windows 2012, Windows 7, and Windows 8

  1. Open the Control Panel.
  2. Select System and Security.
  3. Select Administrative Tools. The various operating systems have different ways to find this option.
  4. Open the Internet Information Services (IIS) Manager.
  5. Expand the node with the computer name.
  6. Expand the Sites folder.
  7. Expand the website folder corresponding to the one that you published.
  8. Find your output folder and right-click the Service subfolder. Then select Convert to Application.
  9. Make sure the application pool is using the .NET 4 framework.
    1. In the dialog click Select.
    2. From the drop-down select an application pool that is using the .NET 4 framework.
    3. Click OK.
  10. Click OK.

Starting Microsoft Indexing Service

The following steps show you how to start the Microsoft Indexing Service on machines that are running Windows Server 2003. This procedure is not necessary for the other operating systems.

Windows Server 2003—How to Start Microsoft Indexing Service

  1. Open the Control Panel. On many computers, you can do this by clicking Start > Control Panel.
  2. Double-click Administrative Tools.The Administrative Tools dialog opens.
  3. Double-click Computer Management.The Computer Management dialog opens.
  4. Expand Services and Applications.
  5. Right-click Indexing Service.
  6. In the context menu, click Start. The Indexing Service is now started.

Starting Microsoft Windows Search

The following steps show you how to start the Microsoft Windows Search on machines that are running Windows Server 2008. This procedure is not necessary for the other operating systems.

Windows Server 2008—How to Start Microsoft Windows Search

  1. From the Start menu open the Server Manager dialog.
  2. Click Add roles.The Add Roles Wizard opens.
  3. Click Next.
  4. Click the check box next to Files Services.
  5. Click Next twice.
  6. Click the check box next to Windows Search Service.
  7. Click Next twice.
  8. Click Install.
  9. Click Close.

Enabling WebHelp Plus Search

The following steps show you how to enable WebHelp Plus search. These steps must be done for each catalog that you are using on the server (or on your local machine, if you are viewing WebHelp Plus output on your computer for testing purposes).

  1. Navigate to the output folder for the WebHelp PlusHTML5 target on the server or on your local machine.

    If you are enabling WebHelp PlusHTML5 on your local machine, you can quickly find the output folder by doing the following.

    1. Open the Project Organizer.
    2. Double-click the Targets folder.
    3. Right-click on the target and select Open Output Folder.
  2. In the output folder, double-click the Service folder.
  3. Double-click the folder labeled Console.ConfigureSearch.
  4. Double-click ConfigureSearch.exe. A window appears very briefly and then disappears.
  5. Create a folder called "AutoMergeCache" at the root of the site. Then you must set security preferences on the AutoMergeCache folder so the application can create and update files.
    1. Right-click on the root folder and choose Explore to open Windows Explorer.
    2. Right-click on AutoMergeCache and choose Properties.
    3. On the Security tab click the Edit button.
    4. Click Add.
      1. Type Everyone and click Check Names, making sure it gets underlined.
      2. Click OK.
    5. Make sure Everyone is highlighted and check the option for Full Control.
    6. Click Apply.
    7. Click OK to exit the Permission dialog.
    8. Click OK to exit the Properties dialog.

Testing WebHelp Plus Search

The following steps are optional for testing WebHelp Plus search (for Microsoft Windows Search).

  1. In IIS right-click on the directory where your WebHelp Plus project is published to and choose Explore.
  2. In the upper-right corner of the window you will see a Search input box. Perform a search for a term that is commonly found in your project.
  3. If you see results, your project is ready to go live.

What’s Noteworthy?

Note If you want to test WebHelp Plus on your local computer, the advanced search features of WebHelp Plus are not operable.

What’s Next?

After enabling WebHelp Plus output, you may want to do any of the following.

  • View the Output You can view the WebHelp Plus output on the server as well as on your local machine. This is a necessary step if you are testing the output on your local machine. See Viewing WebHelp Plus Output.
  • Merge Multiple Outputs at Runtime If you want to merge multiple outputs so that they appear as one big Help system to end users, you can do so easily with WebHelp Plus. The outputs from the different projects will be merged at runtime when users open the Help. See Runtime Merging Output Using WebHelp Plus.
  • Add Non-XHTML Files for Searching When end users perform a search in your online output, you can ensure that non-XHTML files (e.g. PDF, DOC, XLS) are included in that search. See Including Non-XHTML Files in WebHelp Plus Search.