Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



How to convert an Aleppo help project to a CS help project

  1. Invoke the converter specifying an Aleppo project file: alp2csh AleppoProjectFile.alp


The project file

  1. Open the generated XML project file AleppoProjectFile.alp.xml—it is located in the same directory as the old Aleppo project file.

  2. Enter the help file's UID between the <helpfileUID> tags in the CS Help project file. This field is missing because there is no UID associated with an Aleppo project file.


Example

An XML project file AleppoHelp.alp.xml generated from an Aleppo project file is shown below:

<?xml version="1.0"?>
<!DOCTYPE cshproj PUBLIC "/EPOC32/tools/cshlpcmp/dtd/CSHproj.dtd" "SYSTEM">
<?xml:stylesheet href="/EPOC32/tools/cshlpcmp/xsl/CSHproj.xsl" title="CS-Help project" type="text/xsl"?>
<cshproj>
  <helpfileUID><!--Insert UID here--></helpfileUID>
  <directories>
    <input>\aleppo\projdir\</input>
    <output>\aleppo\projdir\releases\</output>
    <graphics>\aleppo\projdir\</graphics>
    <working>\aleppo\projdir\temp\</working>
  </directories>
  <files>
    <source>
      <file>AleppoHelp</file>
    </source>
    <destination>AleppoHelp.hlp</destination>
    <customization>\aleppo\projdir\uk.alc</customization>
  </files>
</cshproj>

[Top]


The rtf source file

  1. Replace the old Aleppo word template with the cshelp.dot template. Alternatively, simply cut the entire Aleppo rtf file and past it into a file generated using the new template.

  2. Select Style Check from the EPOC menu to remove any Aleppo styles which are no longer supported. The hypertext anchor style does not exist in CS Help and needs to be removed.

  3. Add a UID for the help file (Category UID) style.


See also

How to configure a rtf source file

[Top]


The customisation file

The generated XML customisation file uk.alc.xml does not need any extra configuration.

[Top]


The order file

The order file is not converted—it is not possible to specify topic order in CS Help.