Project file .cshlp

The project file defines the location of all resources used by the project and the target help file name.

A CS Help project file starts with a XML prologue. The prologue enables the project file to be viewed in an XML enabled browser.

The prologue is defined as follows:

<?xml version="1.0"?>

• indicates the XML version used.

<?xml:stylesheet href="/cshlpcmp/xsl/CSHproj.xsl" title="CS Help project" type="text/xsl"?>

• specifies the location of the XSL style sheet used to allow viewing of the proofing XML files in a browser.

<!DOCTYPE cshproj SYSTEM "/epoc32/tools/cshlpcmp/dtd/CSHproj.dtd">

• defines the document type and specifies the location of the DTD used to validate the source XML.

CS Help XML documents are preceded by an XML prologue followed by the content of the document. The start of the project file is indicated by a cshproj tag. The cshproj tag contains helpfileUID, directories and files tags. The body of a project file is defined by;

<cshproj>
<helpfileUID>the uid of the generated help file</helpfileUID>
<directories>
 directories used by the project
</directories>
<files>
 The files that are used in the project
</files>
</cshproj>

The helpfileuid tag contains the UID of the help file to be generated. This is used so that Symbian OS can merge help files even if they have the same name.

<helpfileUID>UID</helpfileUID>

Note

This UID is not the same as the UID used in the source RTF file—which belongs to the application

Arguments

Tag name Description helpfileUID The UID of the help file to generate.

The directories tag gives the directories that are used by the CS Help tool chain.

<directories>                                  
<input>input-directory</input>
<output>output-directory</output>
<graphics>base-graphics-directory</graphics>
<working>working-directory</working>
</directories>

Notes:

• If any file name or directory is specified as a relative path, such as ..\graphics\, or \help\agenda\, then it is resolved against the drive and directory which was current when the cshlpcmp command was issued.

• All directories must be specified with a trailing \.

Arguments

Tag name Description input The directory containing all source files, except mbm graphics files. output The target output directory in which the help file will be generated. Any directory may be specified. Typically \epoc32\winscw\c\resource\help is used, so that Help databases can be viewed using an emulator. graphics The directory containing the mbm graphics files. An arbitrary number of graphics directories may be specified. An individual graphic is searched using the order specified in the project file. working Directory for storage of temporary files created during CS Help conversion. If not specified, temporary files are generated in the same directory as the project file. Temporary files are not deleted after the CS Help compiler is run.

See also

Graphics

The files tag contains the file names of the files that are used and created by the tool chain.

<files>
<source>
<file>source-file1.rtf</file>                      
<file>source-file2.rtf</file>
</source>   
<destination>output-file.hlp</destination> 
<customization>customisation-file.xml</customization>     
</files> 

Arguments

Tag name Description file The rich-text source file/s to be compiled, which are located in input-directory. One or more source files may be specified. The order of specification is irrelevant. The application name for each source file must, however, be unique. The file extension must be specified. destination Specifies the name which is assigned to the generated help file. It is created in output-directory. The file extension must be specified. customization Specifies the name of the customization file which defines how CS Help interprets styles in the rich-text source file. If not defined, CS Help uses a default customisation file. The file extension must be specified.

• The source tag may contain multiple file tags which correspond to the source .rtf files to process.

• If any file name or directory is specified as a relative path, such as ..\graphics\, or \help\agenda\, then it is resolved against the drive and directory which was current when the CS Help command was issued.

• Source files must have .rtf extension.

See also

Customisation file— .xml, Command line syntax— CS Help compiler