This is used to convert project files created with Steven Smetsers' SandcastleGUI tool to the help file builder project file format.
Most SandcastleGUI project properties have equivalents in the help file builder and are converted to the matching property and value. The information converted from the following old project properties may need attention after conversion:
AssemblyDir - The specified folder is added as a wildcard documentation source which may not be appropriate. If necessary, change it to include only the required assemblies and XML comments files or split it into individual entries in the Documentation Sources project node. Add all dependency assemblies to the References project node so that they are not documented.
Given that solutions and projects are supported as documentation sources, you may find it easier to add them as documentation sources instead of the assemblies, comments, and references that they contain. When a solution or project is used, these items are imported from them automatically at build time.
Logo - This controls the logo that appears in the topic headers. The image will be added to the project file but will not be set as the logo. In order to do this, use the Transform Component Arguments property page to define the logo filename and its other options such as width, height, alternate text, and placement.
The converter places the logo file in the root folder of the project. In order for it to work with the transformation component arguments, you must create a folder called .\Icons in your project and move the logo image file there. Be sure to set the BuildAction property on the logo image file to Content so that it is included properly in the help file when it is built.
DocDir - All files and subfolders in the indicated folder are added to the project recursively as file items with default build actions based on the file extensions. You can add a site map to the project and edit it to set the order and layout of the additional content items.
The help file builder contains full support for conceptual content that uses Microsoft Assistance Markup Language (MAML) to create additional non-API topics such as How-Tos, walkthroughs, etc. You may want to consider switching any additional HTML content to conceptual content to take advantage of its features. See the Conceptual Content topic for more information.
The following project properties are not converted:
OutputDir - The output directory is left at its default for the help file builder (a .\Help subfolder beneath the project folder). You can specify a different location if needed.
Namespaces - By default, all namespaces and members will be documented. To adjust which items are not documented, you can use the Visibility Category Properties to exclude groups of items and/or the API Filter Property for finer control over which items are excluded.
CodeHighlighting - By default, the custom code block component is included in all builds to colorize code based on the language. To alter its settings, do the following:
Select the Components category of project properties.
Double click on the Code Block Component in the list on the left to add it to the project to allow overriding the defaults.
Select the component in the right-hand list and click the Configure button.
In the configuration dialog, alter the settings as needed. If the default settings are to your liking, you can remove the component and the default instance will be used.
The Code Block Component offers a significant number of options beyond what was available in SandcastleGUI including the ability to colorize many other languages, add line numbering and collapsible regions, and to import code from working source code files. See the Code Block Component documentation for more information on what you can do with it.
TOC - There are some project properties and plug-ins that can be used to customize the table of contents in various ways. See the documentation for the Root Namespace Container and Root Namespace Title properties as well as the Hierarchical Table of Contents Plug-In and the Table of Contents Exclusion Plug-In.