This topic describes how to integrate the application help with your Symbian application and test it on emulator and on the Symbian device.
The application help can be integrated and tested on the following platforms:
Open the bld.inf file of your Symbian application.
Edit the bld.inf file to export contents.zip, index.xml, keywords.xml, meta.xml and images to the c: drive of the emulator and
also other appropriate paths.
For example:
../help/xhtml/01/0x2002c37b/contents.zip \epoc32\winscw\c\resource\xhtml\01\0x2002c37b\contents.zip ../help/xhtml/01/0x2002c37b/index.xml \epoc32\winscw\c\resource\xhtml\01\0x2002c37b\index.xml ../help/xhtml/01/0x2002c37b/keywords.xml \epoc32\winscw\c\resource\xhtml\01\0x2002c37b\keywords.xml ../help/xhtml/01/0x2002c37b/meta.xml \epoc32\winscw\c\resource\xhtml\01\0x2002c37b\meta.xml ../help/xhtml/theme/icons/cshelphelloworld_button1.png \epoc32\winscw\c\resource\xhtml\theme\icons\cshelphelloworld_button1.png ../help/xhtml/theme/icons/qgn_cshelphelloworld_caution.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_caution.gif ../help/xhtml/theme/icons/qgn_cshelphelloworld_example.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_example.gif ../help/xhtml/theme/icons/qgn_cshelphelloworld_link_ref_popup.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_link_ref_popup.gif ../help/xhtml/theme/icons/qgn_cshelphelloworld_link_web.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_link_web.gif ../help/xhtml/theme/icons/qgn_cshelphelloworld_note.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_note.gif ../help/xhtml/theme/icons/qgn_cshelphelloworld_tip.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_tip.gif ../help/xhtml/theme/icons/qgn_cshelphelloworld_warning.gif \epoc32\winscw\c\resource\xhtml\theme\icons\qgn_cshelphelloworld_warning.gif
Save and close
the bld.inf file.
Build the Symbian
application to export the contents.zip, index.xml, keywords.xml, meta.xml, and images.
Run the emulator.
Launch the application help by selecting Menu > User Guide > App user guide topics > <help>.
Where <help> is the name of the application
help that you have created.
If you have added the help menu item as instructed in Launching a help topic from a Symbian application, you can view the specific help topic by launching the Symbian application and clicking the help menu item.
Perform the following steps to integrate and launch the application help on the Symbian device:
Open the .pkg file of your Symbian application.
Ensure that contents.zip, index.xml, keywords.xml, meta.xml and images are included in the .pkg file.
For example:
; all help content related files here till the end of this file. "../help/xhtml/01/0x2002c37b/contents.zip" -"!:\resource\xhtml\01\0x2002c37b\contents.zip" "../help/xhtml/01/0x2002c37b/index.xml" -"!:\resource\xhtml\01\0x2002c37b\index.xml" "../help/xhtml/01/0x2002c37b/keywords.xml" -"!:\resource\xhtml\01\0x2002c37b\keywords.xml" "../help/xhtml/01/0x2002c37b/meta.xml" -"!:\resource\xhtml\01\0x2002c37b\meta.xml" "../help/xhtml/theme/icons/cshelphelloworld_button1.png" -"!:\resource\xhtml\theme\icons\cshelphelloworld_button1.png" "../help/xhtml/theme/icons/qgn_cshelphelloworld_caution.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_caution.gif" "../help/xhtml/theme/icons/qgn_cshelphelloworld_example.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_example.gif" "../help/xhtml/theme/icons/qgn_cshelphelloworld_link_ref_popup.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_link_ref_popup.gif" "../help/xhtml/theme/icons/qgn_cshelphelloworld_link_web.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_link_web.gif" "../help/xhtml/theme/icons/qgn_cshelphelloworld_note.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_note.gif" "../help/xhtml/theme/icons/qgn_cshelphelloworld_tip.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_tip.gif" "../help/xhtml/theme/icons/qgn_cshelphelloworld_warning.gif" -"!:\resource\xhtml\theme\icons\qgn_cshelphelloworld_warning.gif"
Create and sign the SIS file for the Symbian application. For information on how to create and sign a SIS file, see Creating and Signing an Installation File.
Copy the SIS file to the Symbian device and then install it.
Launch the help by selecting Menu > User Guide > App user guide topics > <help>.