home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / VISUAL_B / FERRAMEN / QD_HELP / QDHLPSRC.ZIP / TOPIC.QDH < prev   
Encoding:
Text File  |  1994-04-05  |  2.5 KB  |  84 lines
  1. //
  2. // /topic command
  3. //
  4.  
  5. /topic TOPIC_COMMAND
  6.  
  7.     /title The /topic command
  8.     /keywords /topic;commands
  9.     /browse commands,AUTO
  10.  
  11.     /para \fs40\b\i
  12.       The /topic command
  13.     /endpara
  14.  
  15.     /para \sa100
  16.       The /topic command has the following syntax:
  17.     /endpara
  18.  
  19.     /para 
  20.       /text \b\f3,/topic TOPIC_NAME [,BUILDTAG;BUILDTAG...] \line
  21.       topic commands... \line
  22.       /text \b\f3,/endtopic
  23.     /endpara
  24.  
  25.     /para \sb100
  26.       The topic command is used along with the /endtopic command to mark the
  27.       beginning and end of a help topic. Most other commands are placed inside
  28.       the /topic .. /endtopic pair.
  29.       The TOPIC_NAME is the internal name of the topic. The BUILDTAGs are
  30.       optional.  Buildtags allow you to select which portions of a help file
  31.       to build by specifying only topics with certain buildtags that are to
  32.       be built.  You specifiy the buildtags wanted in the [OPTIONS] portion 
  33.       of the .hpj file by setting the BUILD option. 
  34.     /endpara
  35.  
  36. /endtopic
  37.  
  38. //
  39. // /glossarytopic command
  40. //
  41.  
  42. /topic GLOSSARYTOPIC_COMMAND
  43.  
  44.     /title The /glossarytopic command
  45.     /keywords /glossarytopic;commands
  46.     /browse commands,AUTO
  47.  
  48.     /para \fs40\b\i
  49.       The /glossarytopic command
  50.     /endpara
  51.  
  52.     /para \sa100
  53.       The /glossarytopic command has the following syntax:
  54.     /endpara
  55.  
  56.     /para 
  57.       /text \b\f3,/glossarytopic TOPIC_NAME [,BUILDTAG;BUILDTAG...] \line
  58.       topic commands... \line
  59.       /text \b\f3,/endtopic
  60.     /endpara
  61.  
  62.     /para \sb100
  63.       The glossarytopic command is used along with the /endtopic command to mark the
  64.       beginning and end of a help topic. Most other commands are placed inside
  65.       the /topic .. /endtopic pair.
  66.       The TOPIC_NAME is the internal name of the topic. The BUILDTAGs are
  67.       optional.  Buildtags allow you to select which portions of a help file
  68.       to build by specifying only topics with certain buildtags that are to
  69.       be built.  You specifiy the buildtags wanted in the [OPTIONS] portion 
  70.       of the .hpj file by setting the BUILD option. 
  71.     /endpara
  72.  
  73.     /para \sb100
  74.       The only thing different about a glossarytopic and a regular topic is
  75.       that the glossary topic will automatically be put into the glossary
  76.       generated by QDHELP.  This means if you have a number of topics you
  77.       want to be in a glossary just put them into the QDH file as 
  78.       glossarytopics instead of regular topics and QDHELP will do the
  79.       rest for you.
  80.     /endpara
  81.  
  82. /endtopic
  83.  
  84.