|XML Help||Lotech Solutions (www.lotechsolutions.com)|
Topic status automatically displays here - do not remove.
Unfortunately, there is no simple method to integrate an XML Help solution into the VS.NET IDE. You need to create a separate Microsoft Installation file (MSI) which consists of numerous manually created and interrelated XML files, then hack that installation file using the Windows Installer SDK Orca program.
This topic expects that you have already created an XML Help project and compiled it into an XML Help solution.
To integrate an XML Help solution into VS.NET
To create a separate Help install project
We've also got to install \\Syd-file2\Technology\Tools\NUnit V2.0.1\Nunit.msi to build locally and run unit tests.
To download and install Windows Installer SDK
If prompted, accept the 'Microsoft Web Installer' ActiveX license agreement.
The 'Confirm Install Selections' page displays.
The 'Platform SDK Installation Wizard — Web Page Dialog' displays containing the license terms.
The installation location request page displays.
Click the Continue button.
The dialog displays the download and installation progression.
The 'SDK Update Catalog' page displays, checks your locally installed components, and displays the result.
You should see that "Windows Installer SDK" is in the list, and marked with Installed.
The Windows Installer SDK adds new Windows Start menu items under Start | Programs | Microsoft Platform SDK August 2002. Select Platform SDK Documentation to view the online help for the product.
To install Orca
This procedure expects that you have already downloaded and installed the Windows Installer SDK.
The Orca Installation Wizard will display.
The Orca.exe program is accessed through the Windows Start menu under Start | Programs | Orca and is also added to the right-click context sensitive menu item Edit with Orca in Windows Explorer.
To use Orca to edit collection install and merge files
This procedure expects that you have already installed Orca.
The Orca installation database table editor program will display.
Scroll down the left side to view the list of installation database tables in the open MSI file. You could click in any cell displayed in the right pane to edit the contents (should you wish to do so).
This copies the contents of the cell to the clipboard for later use.
There are four fields for this table, each consisting of a name-value pair. Select each field in-turn from the list, and enter its respective value in the textbox within the frame labelled "Column". (Intuitive isn't it?) The following table lists the value for each field required to get your XML help collection integrated properly into VS.NET:
<CorporateID> = Required placeholder for a unique ID for the Corporation supplying the collection being merged
<HelpProductName> = Required placeholder for the name of the collection being merged
<LanguageID> = Required placeholder for the number of the language of the collection
<CollectionIDNumber> = Required placeholder for the number copied from the project MSI file in the earlier step
<DescriptiveText> = Optional placeholder for a descriptive text string about collection being merged
The File_Collection field uses the number you copied from the project MSI file in an earlier step of this procedure. Simply click the Paste button.
To do something else
Pre-requisites go here
More blurb goes here
Wrap up conclusion goes here
Lotech Solutions' Tips, Tricks, and Procedures | What is XML Help | How to navigate around the VS dotNET IDE
Copyright Lotech Solutions. All rights reserved.