To get your documentation from your .NET project into Help+Manual you just need to import it with the Sandcastle option. You can do this either by creating a completely new Help+Manual project, or you can add it to an existing project. Once you have created a project for your .NET documentation you can also update it by re-importing into the same project again.
1.Select New Project in the menu.
2.Select Sandcastle documentation file in the Import existing documentation section in the lower half of the page.
3.Enter the name and path for your new Help+Manual project and configure the other settings as you would for an empty new project.
4.Click on Continue with Options and select your assemblies, comment files and any dependent assemblies. The comments file is the XML documentation file you configure in your .NET project. You can choose multiple files in each category. You can also set a topic status to be set for your imported topics.
5.Click on Import. Help+Manual will then run Sandcastle in the background, generate the project and import it to a Help+Manual project. Depending on the size of your programming project this may take a while. The time this takes depends on Sandcastle and the speed of your computer, not on Help+Manual.
6.When the process is finished your Sandcastle project will appear in Help+Manual for editing. You can then edit and publish it just like any normal Help+Manual project:
|
You can also update your source code documentation to the Help+Manual project you created from an earlier version.
Open the Help+Manual project and select Import in the menu instead of New Project. All the other steps are the same as described above. New topics chapters will be added to the end of the existing TOC. Updates to existing topics and chapters will be handled depending on the conflict management settings you configure for "changed topics". If you opt to overwrite the existing topics the earlier versions will be replaced.
|