Adding to the WiX Documentation
WiX documentation is compiled into the file WiX.chm as a part of the WiX build process.
What the WiX help compiler does
The WiX help compiler does the following:
-
Parses the file TOC.xml to determine the table of contents to construct in the CHM file and determine what HTML files to include in the CHM file.
-
Recursively includes the contents of the Images directory in the WiX source tree.
-
Parses .xsd schema files referenced in TOC.xml and generates help topics for the attributes and elements that are annotated in the .xsd files.
How to add a new topic to WiX.chm
Adding a new topic to WiX.chm requires the following steps:
-
Add a new HTML file with the contents of the new topic to the WiX source tree.
-
Add any relevant images to the Images sub-directory in the WiX source tree.
-
Add a reference to the new HTML file to TOC.xml in the desired location in the table of contents.
Help topics may contain links to external Web pages, and may also contain relative links to
other help topics or attributes or elements defined in one of the .xsd schema files.