home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / hdk11a.zip / HELPDEMO.HDF < prev    next >
Text File  |  1994-01-08  |  7KB  |  169 lines
  1.  
  2. ;******************************************************************************
  3. ;                                  HELPDEMO                                   *
  4. ;******************************************************************************
  5.  
  6.  these lines are remark lines, only lines that appear between the help
  7.  definitions directives are processed by the help compiler, or lines that
  8.  start with a period and a reserved command such as .include or .linkcolor
  9.  
  10.  The next section defines a topic called overview. You must have a
  11.  topic like that in your database, it is the entry point of the 
  12.  help database, when the help engine displays the first page of
  13.  the database.
  14.  
  15.  Notice - If you want to use this database in a WWW server (By compiling to the
  16.  HTML target), please change the .rootnode and .rootpath parameters at the end
  17.  of this docuemnt!
  18.  
  19. ;******************************************************************************
  20. ;                                  overview                                   *
  21. ;******************************************************************************
  22. .entry overview
  23.  
  24. This is the first line of the overview topic in the help demo database.
  25. The previous line did not have any ~link~link~, while this one does.
  26.  
  27. Press the Enter key to view the link topic help page.
  28.  
  29. .end-entry
  30.  
  31.  As can be seen, the only link available from the overview page is a topic
  32.  called link. In the next section we will define the link topic, and
  33.  include 2 links in it. One to the previous link (overview), and an
  34.  additional one - somewhere else.
  35.  
  36. ;******************************************************************************
  37. ;                                    link                                     *
  38. ; notice that this topic's title will be different then the topic name        *
  39. ; because of the use of the .TITLE keyword.                                   *
  40. ; notice also that the topic is defined by .topic and .end-topic which are    *
  41. ; the same as the .entry .end-entry keywords                                  *
  42. ;******************************************************************************
  43. .topic link
  44. .title This is the 2nd screen
  45.  
  46. .paragraph
  47. Welcome to the link help page, since this is a demo help database, we 
  48. know that you arrived to this page from the ~overview~overview~ page, 
  49. by pressing the link hot-link. In this page we will demonstrate the 
  50. ability to include 2 different names (or more) that will take us to the 
  51. same link.
  52. .end-paragraph
  53.  
  54. Example :
  55.  
  56. Related Topics : ~Topic~Topic~
  57.                  ~General~overview~
  58. .end-topic
  59.  
  60.  In the above section we defined 3 links, that are linked to 2 topics, we
  61.  showed that we can reach the same topic from more then one spot in the 
  62.  same topic, using different names.
  63.  
  64.  We will now define the third and final page in the helpdemo database, this
  65.  topic is called topic. Notice that if we did not include this one, the
  66.  helpC help compiler would have told us that there is a link defined,
  67.  that is not defined as a topic.
  68.  
  69. ;******************************************************************************
  70. ;                                    Topic                                    *
  71. ;******************************************************************************
  72. .entry Topic
  73.  
  74. .paragraph
  75. Well.. it seems as if you succeeded to reach this point by yourself, 
  76. this is the 3rd page of the HELPDEMO help database. From this 
  77. help page you can go to the ~previous~link~ help page, or to the 
  78. ~entry~overview~ help page. 
  79. .end-paragraph
  80.  
  81. Have fun using the help compiler and help engine ..
  82.  
  83. Notice - this line demostrates the use of a ~~ in a text page.
  84. (Please refer to the HELPDEMO.HDF file for an example .. )
  85.  
  86. .paragraph
  87. .ifdef w31
  88. ~ronp~ronpict;right~There are more pages you can get to from here - One of these links is defined
  89. .else
  90. There are more pages you can get to from here - One of these links is defined 
  91. .endif
  92. in a ~.INCLUDE~include~ file. Please refer to the helpC documentation for 
  93. HDF syntax.
  94.  
  95. Notice how you get a ~Popup~popupLink~ here!.
  96.  
  97. .ifdef w31
  98. And try the ~Sound~trash~ here!.
  99. .endif
  100.  
  101. .end-paragraph
  102.  
  103. .ifdef w31
  104. Click ~Here~clockapp~ to see the time.
  105. .endif
  106.  
  107. .end-entry
  108.  
  109. ;******************************************************************************
  110. ;                                  .include                                   *
  111. ; here we add a new topic from a 2nd file that is included 2nddemo.hdf        *
  112. ;******************************************************************************
  113. .include 2NDDEMO.HDF
  114.  
  115. ;******************************************************************************
  116. ;                                   .popup                                    *
  117. ; here we demonstrate the definition of a popup topic screen                  *
  118. ; we also demonstrate the conditional defines .ifdef/.else/.endif             *
  119. ;******************************************************************************
  120. .popup popupLink
  121. .title A POPUP Screen
  122.  
  123. This is a Popup screen, No links can be defined in this screen, you have to 
  124. .ifdef native
  125. press F3 to close this popup, F6 to cycle between windows.
  126. .else
  127. press enter to return to the calling help screen.
  128. .endif
  129.  
  130. .end-popup
  131.  
  132. ;******************************************************************************
  133. ;                                .attrdefaults                                *
  134. ; here we set default attributes to the helpdemo database, we set the default *
  135. ; font to 3. Notice that the default attributes are defined after some topics,*
  136. ; but will be effective for all the topics.                                   *
  137. ; notice that we also set italic to be on by default.                         *
  138. ;******************************************************************************
  139. .attrdefaults font 3 italic on bold on
  140.  
  141. .ifdef w31
  142. ;******************************************************************************
  143. ;                                   .sound                                    *
  144. ; here we define a sound object that will be uses in the "Sound" link         *
  145. ;******************************************************************************
  146. .sound trash tada.wav
  147. .graphic ronpict ronp.bmp
  148. .application clockapp clock.exe
  149. .endif 
  150.  
  151.  
  152. ;******************************************************************************
  153. ;                                     WWW                                     *
  154. ;                                                                             *
  155. ; Notice - This section is relevant ONLY of you want to compile HELPDEMO for  *
  156. ;          a WWW server!                                                      *
  157. ;                                                                             *
  158. ; Replace .ROOTNODE with your server's IP address                             *
  159. ; Replace .ROOTPATH with the file's path on the hypertext server              *
  160. ;******************************************************************************
  161. .ifdef www
  162.  
  163. .rootnode 127.0.0.2
  164.  
  165. .rootpath ""
  166.  
  167. .endif
  168.  
  169.