home *** CD-ROM | disk | FTP | other *** search
/ Media Share 9 / MEDIASHARE_09.ISO / progmisc / hlpdk30.zip / HELPDEMO.HDF < prev    next >
Text File  |  1993-04-10  |  4KB  |  87 lines
  1. ;******************************************************************************
  2. ;                                  HELPDEMO                                   *
  3. ;******************************************************************************
  4.  
  5.  these lines are remark lines, only lines that appear between the help
  6.  definitions directives are processed by the help compiler.
  7.  
  8.  The next section defines a topic called overview. You must have a
  9.  topic like that in your database, it is the entry point of the 
  10.  help database, when the help engine displays the first page of
  11.  the database.
  12.  
  13. ;******************************************************************************
  14. ;                                  overview                                   *
  15. ;******************************************************************************
  16. .entry overview
  17.  
  18.  This is the first line of the overview topic in the help demo database.
  19.  The previous line did not have any ~link~link~, while this one does.
  20.  
  21.  Press the Enter key to view the link topic help page.
  22.  
  23. .end-entry
  24.  
  25.  As can be seen, the only link available from the overview page is a topic
  26.  called link. In the next section we will define the link topic, and
  27.  include 2 links in it. One to the previous link (overview), and an
  28.  additional one - somewhere else.
  29.  
  30. ;******************************************************************************
  31. ;                                    link                                     *
  32. ; notice that this topic's title will be different then the topic name        *
  33. ; because of the use of the .TITLE keyword.                                   *
  34. ; notice also that the topic is defined by .topic and .end-topic which are    *
  35. ; the same as the .entry .end-entry keywords                                  *
  36. ;******************************************************************************
  37. .topic link
  38. .title This is the 2nd screen
  39.  
  40.  Welcome to the link help page, since this is a demo help database, we
  41.  know that you arrived to this page from the ~overview~overview~ page, 
  42.  by pressing the link hot-link. In this page we will demonstrate the
  43.  ability to include 2 different names (or more) that will take us to the 
  44.  same link.
  45.  
  46.  Example :
  47.  
  48.  Related Topics : ~Topic~topic~
  49.                   ~General~overview~
  50. .end-topic
  51.  
  52.  In the above section we defined 3 links, that are linked to 2 topics, we
  53.  showed that we can reach the same topic from more then one spot in the 
  54.  same topic, using different names.
  55.  
  56.  We will now define the third and final page in the helpdemo database, this
  57.  topic is called topic. Notice that if we did not include this one, the
  58.  helpC help compiler would have told us that there is a link defined,
  59.  that is not defined as a topic.
  60.  
  61. ;******************************************************************************
  62. ;                                    Topic                                    *
  63. ;******************************************************************************
  64. .entry Topic
  65.  
  66.  Well.. it seems as if you succeeded to reach this point by yourself,
  67.  this is the 3rd page of the HELPDEMO help database. From this
  68.  help page you can go to the ~previous~link~ help page, or to the
  69.  ~entry~overview~ help page.
  70.  
  71.  Have fun using the help compiler and help engine ..
  72.  
  73. Notice - this line demostrates the use of a ~~ in a text page.
  74. (Please refer to the HELPDEMO.HDF file an example .. )
  75.  
  76.  There is one more page you can get to from here - this link is defined
  77.  in a ~.INCLUDE~include~ file. Please refer to the helpC documentation for
  78.  HDF syntax.
  79.  
  80. .end-entry
  81.  
  82. ;******************************************************************************
  83. ;                                  .include                                   *
  84. ; here we add a new topic from a 2nd file that is included 2nddemo.hdf        *
  85. ;******************************************************************************
  86. .include 2NDDEMO.HDF
  87.