The source files for a CS Help example project and its associated application are included with this documentation. A second CS Help project is provided to demonstrate how styles and formatting should be used.
The project files used in the examples have a .cshlp
extension so that they can be used with the CS Help compiler GUI. Project files can
also however use the extension .xml
for use with the command line
compiler only.
The example project ShapesProj.cshlp
is used to
demonstrate context sensitive help for a hypothetical application. The
application consists of three controls—a square view, a circle view and a
dialog, for example as seen below:
A CS Help project has been created to provide a topic for each of
the three controls. The project files are stored in the directory
examples\ToolsAndUtilities\CsHelp\project\
. They include the
project file ShapesProj.cshlp
, the source rtf
file
Shapes.rtf
, and the customisation file Custom.xml
.
The CS Help files are compiled to a releases
sub-directory.
The example project CsHelp.cshlp
is provided to show
how styles and formatting should be used.
Its project files are also stored in the directory
examples\ToolsAndUtilities\CsHelp\project\
. They include the
project file CsHelp.cshlp
, the source rtf file
CsHelp.rtf
, and the customisation file
Custom.xml
.
The project file CombinedProj.cshlp
shows how both the
topics from CsHelp.rtf
and Shapes.rtf
can be combined
into a single CS Help file.