Home

Html Help 2 Registration Toolkit QuickStart

Html Help 2 Registration Toolkit QuickStart
Submitted by sharpplus on Tuesday, October 10, 2006 - 06:30

Html Help 2 Registration Toolkit QuickStart

NDoc generates class libraries documentation from .NET assemblies and the XML documentation files generated by the C# compiler. NDoc can generate the Visual Studio .NET Help format (HTML Help 2).


There are the four steps to take in order to integrate the HTML Help 2 file you generated into Visual Studio.NET 2003 , Borland Delphi 2005 and etc.
  1. Create HTML Help 2 using NDoc
  2. Registering the Help File using RegH2
  3. Register html help 2 as plugin
  4. Register html help 2 as merge topic.
///
///
public class ActionCollection : CollectionBase
{
private ActionList _ActionList;

{
this._ActionList=ActnList;
}

///
///
public Action this[int Index]
{
get
{
return (Action) List[Index];
}
set
{
List[Index]=value;
}
}

///
///
///
///
public int IndexOf(Action AAction)
{
return List.IndexOf(AAction);
}

///
///
///
///
public bool Contains(Action Action)
{
return List.Contains(Action);
}

///
///
///
///
public int Add(Action Action)
{
int i = List.Add(Action);
Action.ActionList=this._ActionList;
_ActionList.HookIdle();

}

///
///
///
public void Remove(Action Action)
{
if ((Action.Site != null) && (Action.Site.Container != null))
{
Action.Site.Container.Remove(Action);
}

List.Remove(Action);
Action.Dispose();
}
}

Step 1: Create HTML Help 2 using NDoc

Next set the Documentation Type to 'VS.Net2003'. then change the extra properties like PluginNamespace, CollectionNamespace, etc.
Before you build the help file, you have to install Microsoft Html Workshop and Microsoft Visual Studio .NET Help Integration Kit (VSHIK2003). Finally, Build the help file using Documentation | Build menu.
Step 2: Registering the Help File using RegH2


1. Set HelpType to Plugin, then input the PluginNamespace
6. Finally , Save to the configuration to Plugin.rh2 file which can be used to register and unregister the file by RegH2Cmd.exe


Step 3: Register html help 2 as Merge Topic
RegH2Cmd.exe is a command line version register utility which can be redistributed as a part of installation, usage:
1. Register: RegH2Cmd -r Plugin.rh2
2. Set the ParentNamspaces to ms.vscc.2003 and borland.bds3 which correspond to integration target VS2003 and Delphi 2005. 4. Add the Query Filter to Filter List.
Step 4: Register html help 2 as plugin
Using RegH2.exe to create the registration configuration file which is GUI program.3. Add the html help 2 files generated by NDoc.5. Now, you can push the register button to register the help and invoke the Document Explorer to see the result. 2. Unregister: RegH2Cmd -u Plugin.rh2
Run NDoc(http://ndoc.sourceforge.net) , New a project , Add ActionList.dll and Actlst.xml to project.

1. Set HelpType to Merge, then input the Merge Topic Url.

2. Set the ParentNamspaces to ms.vscc.2003 and borland.bds3 which correspond to integration target VS2003 and Delphi 2005.

3. Add the html help 2 files generated by NDoc.
4. Add the Query Filter to Filter List.
5.Now, you can push the register button to register the help and invoke the Document Explorer to see the result.
6. Finally , Save to the configuration to Plugin.rh2 file which can be used to register and unregister the file by RegH2Cmd.exe

Poll

Syndicate
Syndicate content

(C) Copyright 2004-2007, SharpPlus Software Corp.