helpdemo.hdf

Hypertext Help Development Kit c源代码

;******************************************************************************
;                                  HELPDEMO                                   *
;******************************************************************************

 these lines are remark lines, only lines that appear between the help
 definitions directives are processed by the help compiler, or lines that
 start with a period and a reserved command such as .include or .linkcolor

 The next section defines a topic called overview. You must have a
 topic like that in your database, it is the entry point of the 
 help database, when the help engine displays the first page of
 the database.

 Notice - If you want to use this database in a WWW server (By compiling to the
 HTML target), please change the .rootnode and .rootpath parameters at the end
 of this docuemnt!

;******************************************************************************
;                                  overview                                   *
;******************************************************************************
.entry overview

This is the first line of the overview topic in the help demo database.
The previous line did not have any ~link~link~, while this one does.

Press the Enter key to view the link topic help page.

.end-entry

 As can be seen, the only link available from the overview page is a topic
 called link. In the next section we will define the link topic, and
 include 2 links in it. One to the previous link (overview), and an
 additional one - somewhere else.

;******************************************************************************
;                                    link                                     *
; notice that this topic's title will be different then the topic name        *
; because of the use of the .TITLE keyword.                                   *
; notice also that the topic is defined by .topic and .end-topic which are    *
; the same as the .entry .end-entry keywords                                  *
;******************************************************************************
.topic link
.title This is the 2nd screen

.paragraph
Welcome to the link help page, since this is a demo help database, we 
know that you arrived to this page from the ~overview~overview~ page, 
by pressing the link hot-link. In this page we will demonstrate the 
ability to include 2 different names (or more) that will take us to the 
same link.
.end-paragraph

Example :

Related Topics : ~Topic~Topic~
                 ~General~overview~
.end-topic

 In the above section we defined 3 links, that are linked to 2 topics, we
 showed that we can reach the same topic from more then one spot in the 
 same topic, using different names.

 We will now define the third and final page in the helpdemo database, this
 topic is called topic. Notice that if we did not include this one, the
 helpC help compiler would have told us that there is a link defined,
 that is not defined as a topic.

;******************************************************************************
;                                    Topic                                    *
;******************************************************************************
.entry Topic

.paragraph
Well.. it seems as if you succeeded to reach this point by yourself, 
this is the 3rd page of the HELPDEMO help database. From this 
help page you can go to the ~previous~link~ help page, or to the 
~entry~overview~ help page. 
.end-paragraph

Have fun using the help compiler and help engine ..

Notice - this line demostrates the use of a ~~ in a text page.
(Please refer to the HELPDEMO.HDF file for an example .. )

.paragraph
.ifdef w31
~ronp~ronpict;right~There are more pages you can get to from here - One of these links is defined
.else
There are more pages you can get to from here - One of these links is defined 
.endif
in a ~.INCLUDE~include~ file. Please refer to the helpC documentation for 
HDF syntax.

Notice how you get a ~Popup~popupLink~ here!.

.ifdef w31
And try the ~Sound~trash~ here!.
.endif

.end-paragraph

.ifdef w31
Click ~Here~clockapp~ to see the time.
.endif

.end-entry

;******************************************************************************
;                                  .include                                   *
; here we add a new topic from a 2nd file that is included 2nddemo.hdf        *
;******************************************************************************
.include 2NDDEMO.HDF

;******************************************************************************
;                                   .popup                                    *
; here we demonstrate the definition of a popup topic screen                  *
; we also demonstrate the conditional defines .ifdef/.else/.endif             *
;******************************************************************************
.popup popupLink
.title A POPUP Screen

This is a Popup screen, No links can be defined in this screen, you have to 
.ifdef native
press F3 to close this popup, F6 to cycle between windows.
.else
press enter to return to the calling help screen.
.endif

.end-popup

;******************************************************************************
;                                .attrdefaults                                *
; here we set default attributes to the helpdemo database, we set the default *
; font to 3. Notice that the default attributes are defined after some topics,*
; but will be effective for all the topics.                                   *
; notice that we also set italic to be on by default.                         *
;******************************************************************************
.attrdefaults font 3 italic on bold on

.ifdef w31
;******************************************************************************
;                                   .sound                                    *
; here we define a sound object that will be uses in the "Sound" link         *
;******************************************************************************
.sound trash tada.wav
.graphic ronpict ronp.bmp
.application clockapp clock.exe
.endif 


;******************************************************************************
;                                     WWW                                     *
;                                                                             *
; Notice - This section is relevant ONLY of you want to compile HELPDEMO for  *
;          a WWW server!                                                      *
;                                                                             *
; Replace .ROOTNODE with your server's IP address                             *
; Replace .ROOTPATH with the file's path on the hypertext server              *
;******************************************************************************
.ifdef www

.rootnode 127.0.0.2

.rootpath ""

.endif