home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Professional / OS2PRO194.ISO / os2 / progs / help / helpdemo.hdf < prev    next >
Text File  |  1993-09-27  |  6KB  |  124 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. ;******************************************************************************
  16. ;                                  overview                                   *
  17. ;******************************************************************************
  18. .entry overview
  19.  
  20. This is the first line of the overview topic in the help demo database.
  21. The previous line did not have any ~link~link~, while this one does.
  22.  
  23. Press the Enter key to view the link topic help page.
  24.  
  25. .end-entry
  26.  
  27.  As can be seen, the only link available from the overview page is a topic
  28.  called link. In the next section we will define the link topic, and
  29.  include 2 links in it. One to the previous link (overview), and an
  30.  additional one - somewhere else.
  31.  
  32. ;******************************************************************************
  33. ;                                    link                                     *
  34. ; notice that this topic's title will be different then the topic name        *
  35. ; because of the use of the .TITLE keyword.                                   *
  36. ; notice also that the topic is defined by .topic and .end-topic which are    *
  37. ; the same as the .entry .end-entry keywords                                  *
  38. ;******************************************************************************
  39. .topic link
  40. .title This is the 2nd screen
  41.  
  42. .paragraph
  43. Welcome to the link help page, since this is a demo help database, we 
  44. know that you arrived to this page from the ~overview~overview~ page, 
  45. by pressing the link hot-link. In this page we will demonstrate the 
  46. ability to include 2 different names (or more) that will take us to the 
  47. same link.
  48. .end-paragraph
  49.  
  50. Example :
  51.  
  52. Related Topics : ~Topic~Topic~
  53.                  ~General~overview~
  54. .end-topic
  55.  
  56.  In the above section we defined 3 links, that are linked to 2 topics, we
  57.  showed that we can reach the same topic from more then one spot in the 
  58.  same topic, using different names.
  59.  
  60.  We will now define the third and final page in the helpdemo database, this
  61.  topic is called topic. Notice that if we did not include this one, the
  62.  helpC help compiler would have told us that there is a link defined,
  63.  that is not defined as a topic.
  64.  
  65. ;******************************************************************************
  66. ;                                    Topic                                    *
  67. ;******************************************************************************
  68. .entry Topic
  69.  
  70. .paragraph
  71. Well.. it seems as if you succeeded to reach this point by yourself, 
  72. this is the 3rd page of the HELPDEMO help database. From this 
  73. help page you can go to the ~previous~link~ help page, or to the 
  74. ~entry~overview~ help page. 
  75. .end-paragraph
  76.  
  77. Have fun using the help compiler and help engine ..
  78.  
  79. Notice - this line demostrates the use of a ~~ in a text page.
  80. (Please refer to the HELPDEMO.HDF file an example .. )
  81.  
  82. .paragraph
  83. There are more pages you can get to from here - One of these links is defined 
  84. in a ~.INCLUDE~include~ file. Please refer to the helpC documentation for 
  85. HDF syntax.
  86.  
  87. Notice how you get a ~Popup~popupLink~ here!.
  88.  
  89. .end-paragraph
  90.  
  91. .end-entry
  92.  
  93. ;******************************************************************************
  94. ;                                  .include                                   *
  95. ; here we add a new topic from a 2nd file that is included 2nddemo.hdf        *
  96. ;******************************************************************************
  97. .include 2NDDEMO.HDF
  98.  
  99. ;******************************************************************************
  100. ;                                   .popup                                    *
  101. ; here we demonstrate the definition of a popup topic screen                  *
  102. ; we also demonstrate the conditional defines .ifdef/.else/.endif             *
  103. ;******************************************************************************
  104. .popup popupLink
  105. .title A POPUP Screen
  106.  
  107. This is a Popup screen, No links can be defined in this screen, you have to 
  108. .ifdef native
  109. press F3 to close this popup, F6 to cycle between windows.
  110. .else
  111. press enter to return to the calling help screen.
  112. .endif
  113.  
  114. .end-popup
  115.  
  116. ;******************************************************************************
  117. ;                                .attrdefaults                                *
  118. ; here we set default attributes to the helpdemo database, we set the default *
  119. ; font to 3. Notice that the default attributes are defined after some topics,*
  120. ; but will be effective for all the topics.                                   *
  121. ; notice that we also set italic to be on by default.                         *
  122. ;******************************************************************************
  123. .attrdefaults font 3 italic on bold on
  124.