Share via

Modifying the Documentation

  • Article
Retired Content

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

The Help 1.0 format includes a viewer with the content in a single .chm file. This means you can redistribute a single file that architects and developers can open and view; users do not have to install the Help content or a separate viewer.

The Composite Application Guidance for WPF provides documentation as compiled Help files, which is delivered in Help 1.0 (.chm) format.

To modify the Composite Application Guidance documentation

  1. Decompile the existing content to create the original source files.
  2. Modify existing content (or add new content).
  3. Recompile the Help project.

The following sections describe the tools and procedures that you can use to extend the Composite Application Guidance for WPF documentation.

Help 1.0

To modify the Help 1.0 documentation, you must have HTML Help Workshop installed.

To decompile the Composite Application Guidance.chm file

  1. Launch HTML Help Workshop.
  2. On the File menu, click Decompile. The Decompile .CHM File dialog box appears.
  3. In the Destination folder box of the Decompile .CHM File dialog box, type the name of an empty folder. HTML Help Workshop creates the source files in this directory.
  4. In the Help file name box, type CompositeGuidanceWPF.chm.
  5. Click OK. HTML Help Workshop decompiles the .chm file.

You can edit the existing HTML files to modify the existing content. You can also create new HTML files for new content. The software factory documentation uses specific HTML for the header and footer of each topic. To create a new topic, it is recommended that you copy an existing HTML file, and then edit the copy. After you prepare your content, you must create a new Help 1.0 project and compile your .chm file.

To create and build a new Help 1.0 project

  1. Launch HTML Help Workshop.
  2. On the File menu, click New.
  3. In the New dialog box, click Project in the list of items, and then click OK. The New Project Wizard appears.
  4. Make sure the Convert WinHelp project check box is not selected, and then click Next.
  5. Enter the name and location of your new project file, and then click Next.
  6. Select two of the options for existing content (HTML Help table of contents and HTML files), and then click Next.
  7. Enter the name and location of the file CompositeGuidanceWPF.hhc, and then click Next.
  8. Click Add.
  9. In the Open dialog box, browse to the folder named Html that is a subdirectory of the destination folder for the decompiled .chm file. Select all the files, and then click OK.
  10. If you created a new topic, add it to the table of contents.
  11. Click Next, and then click Finish. HTML Help Workshop creates the project file.
  12. On the File menu, click Compile.
  13. In the Create a compiled file dialog box, enter the location and name of the file that you specified in step 5. Click Compile.
Retired Content

This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This page may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.