home *** CD-ROM | disk | FTP | other *** search
/ Black Box 4 / BlackBox.cdr / w3_apps / qdhelp.arj / QDHELP.QDH < prev    next >
Encoding:
Text File  |  1992-01-24  |  29.8 KB  |  1,276 lines
  1. //
  2. // This is the index to this help file
  3. //
  4.  
  5. /topic INDEX
  6.  
  7.     /title Quick and Dirty Help
  8.     /browse index,AUTO
  9.  
  10.     /para \sa300
  11.         /text \b\i\fs40,Quick and Dirty Help 
  12.     /endpara
  13.  
  14.     /para \fi300\sa300
  15.         Welcome to the Quick and Dirty way to build help files for Windows 3.0.
  16.         With  Quick and Dirty Help (QDHELP) you use any ascii editor to generate 
  17.         help files for Windows 3.0. 
  18.         The ascii file you generate is input to the QDHELP program
  19.         which outputs a file in rich text format (RTF).  This is the
  20.         format needed by the
  21.         /popuplink Microsoft,MICROSOFT
  22.         Help Compiler.
  23.         What this means is that you do not need to purchase Microsoft
  24.         WORD or some other word processor that generates RTF to be
  25.         able to make help files for your Windows 3.0 applications.
  26.         The remainder of this help file contains information on the 
  27.         syntax used by the QDHELP program input file along with 
  28.         some hints and tips on using QDHELP.
  29.     /endpara
  30.  
  31.     /para \sa100
  32.         /text \b,Pick a Index any Index!
  33.     /endpara
  34.  
  35.     /para \li200
  36.         /link COMMANDS,Quick and Dirty Help Commands
  37.     /endpara
  38.  
  39.     /para \li200
  40.         /link RUNNING,Running Quick and Dirty Help
  41.     /endpara
  42.  
  43.     /para \li200
  44.         /link HINTS,Hints and Tips
  45.     /endpara
  46.  
  47.     /para \li200
  48.         /link ERRATA,Errata
  49.     /endpara
  50.  
  51. /endtopic
  52.  
  53. //
  54. // the microsoft popup topic
  55. //
  56.  
  57. /topic MICROSOFT
  58.  
  59.     /title Microsoft
  60.     /keywords Microsoft;Gates;Word
  61.     
  62.     /para 
  63.         Microsoft is the software company that wants you to 
  64.         to contribute big $$$ to Bill Gates retirement fund
  65.         by purchasing thier word processing program WORD.
  66.     /endpara
  67.  
  68. /endtopic
  69.     
  70. //
  71. // commands availble in quick and dirty help program
  72. //
  73.  
  74. /topic COMMANDS
  75.  
  76.     /title Quick and Dirty Help Commands
  77.     /keywords commands
  78.     /browse index,AUTO
  79.                
  80.     /para \sa300
  81.         /text \b\i\fs40,Quick and Dirty Help Commands
  82.     /endpara
  83.  
  84.     /para \sa300
  85.         Below you will find a list of the commands found in the 
  86.         QDHELP system.  
  87.         Commands must be the first non 
  88.         /popuplink WHITESPACE,white space
  89.         characters 
  90.         found on a line.  
  91.     /endpara
  92.  
  93.     /para \sa100
  94.         /text \b,Command Index
  95.     /endpara
  96.  
  97.     /para \li200
  98.         /link INCLUDE_COMMAND,/include file-name
  99.     /endpara
  100.  
  101.     /para \li200
  102.         /link TOPIC_COMMAND,/topic  /endtopic command
  103.     /endpara
  104.  
  105.     /para \li200
  106.         /link TITLE_COMMAND,/title title string
  107.     /endpara
  108.  
  109.     /para \li200
  110.         /link KEYWORD_COMMAND,/keywords keyword1[;keyword2...]
  111.     /endpara
  112.  
  113.     /para \li200
  114.         /link BROWSE_COMMAND,/browse num1,num2
  115.     /endpara
  116.  
  117.     /para \li200
  118.         /link PARA_COMMAND,/para .. /endpara
  119.     /endpara
  120.  
  121. /endtopic
  122.  
  123. //
  124. // white space popup
  125. //
  126.  
  127. /topic WHITESPACE
  128.  
  129.     /title WhiteSpace
  130.     /keywords space;whitespace
  131.     
  132.     /para 
  133.         Whitespace are non printable characters found in a text
  134.         file such as tab,space.  For the purposes of QDHELP the
  135.         ONLY recognized whitespace characters are space and tab.        
  136.     /endpara
  137.  
  138. /endtopic
  139.  
  140.     
  141. //
  142. // /include command
  143. //
  144.  
  145. /topic INCLUDE_COMMAND
  146.  
  147.     /title The /include command
  148.     /keywords /include;commands
  149.     /browse commands,AUTO
  150.  
  151.     /para \sa300
  152.         /text \fs40\b\i, The /include command
  153.     /endpara
  154.  
  155.     /para \sa300
  156.         The /include command has the following syntax
  157.     /endpara
  158.  
  159.     /para \sa150 
  160.         /text \b\f3,/include FILE-NAME
  161.     /endpara
  162.  
  163.     /para \sa150
  164.         The include command is used to include files into a .qdh file.
  165.         The file to include is the only parameter on the line following
  166.         the include command.  Any file name is ok.  If the file can not
  167.         be found and does not have a extension then the filename.qdh
  168.         will be tried.  If both fail an error is reported and the program
  169.         terminates.
  170.     /endpara
  171.  
  172.     /para \sa150
  173.         /text \b,Example:
  174.     /endpara
  175.  
  176.     /para
  177.         \/include filename.qdh
  178.     /endpara
  179.  
  180. /endtopic
  181.  
  182. //
  183. // /topic command
  184. //
  185.  
  186.  
  187. /topic TOPIC_COMMAND
  188.  
  189.     /title The /topic command
  190.     /keywords /topic;commands
  191.     /browse commands,AUTO
  192.  
  193.     /para \sa300
  194.         /text \fs40\b\i, The /topic command
  195.     /endpara
  196.  
  197.     /para \sa300
  198.         The /topic command has the following syntax
  199.     /endpara
  200.  
  201.     /para 
  202.         /text \b\f3,/topic TOPICNAME
  203.     /endpara
  204.     /para
  205.         topic commands...
  206.     /endpara
  207.     /para \sa300
  208.         /text \b\f3,/endtopic
  209.     /endpara
  210.  
  211.     /para
  212.         The topic command is used in pairs with the /endtopic command to mark the
  213.         begin and end of a help topic. All other commands are placed inside
  214.         the /topic .. /endtopic pair. The following commands are valid inside  
  215.         the /topic command. 
  216.         /popuplink TITLE_COMMAND,/title
  217.         ,
  218.           /popuplink KEYWORD_COMMAND,/keywords
  219.         ,
  220.             /popuplink BROWSE_COMMAND,/browse
  221.         and
  222.         /popuplink PARA_COMMAND,/para .. /endpara
  223.         More information is available on each of these commands in this
  224.         help library.
  225.     /endpara
  226.  
  227. /endtopic
  228.  
  229.  
  230. //
  231. // title command
  232. //
  233.  
  234. /topic TITLE_COMMAND
  235.     /title The /title command
  236.     /keywords /title;commands
  237.     /browse commands,AUTO
  238.  
  239.     /para \sa300
  240.     /text \b\i\fs40,The /title command
  241.     /endpara
  242.  
  243.     /para \sa150
  244.         The /title command has the following syntax
  245.     /endpara
  246.  
  247.     /para \sa150
  248.         /text \b\f3,/title title string
  249.     /endpara
  250.  
  251.     /para \sa150
  252.         The title command is used to set the text string which
  253.         will be displayed as the title of the topic during a
  254.         successful keyword search. 
  255.     /endpara
  256.  
  257.     /para \sa150
  258.         /text \b,Command Placement
  259.     /endpara
  260.  
  261.     /para
  262.         This command must be placed after the /topic command
  263.         but before any /para command.
  264.     /endpara
  265.  
  266. /endtopic
  267.  
  268. //
  269. // keyword command
  270. //
  271.  
  272. /topic KEYWORD_COMMAND
  273.     /title The /keyword command
  274.     /keywords /keyword;commands
  275.     /browse commands,AUTO
  276.  
  277.     /para \sa300
  278.     /text \b\i\fs40,The /keyword command
  279.     /endpara
  280.  
  281.     /para \sa150
  282.         The /keyword command has the following syntax
  283.     /endpara
  284.  
  285.     /para \sa150
  286.         /text \b\f3,/keyword keyword1[;keyword2...]
  287.     /endpara
  288.  
  289.     /para \sa150
  290.         The keyword command is used to set the keywords that 
  291.         will find this topic in a help keyword search.  An 
  292.         example might look like keyword;KEYWORD;command for
  293.         a topic that dealt with the keyword command!
  294.     /endpara
  295.  
  296.     /para \sa150
  297.         /text \b,Command Placement
  298.     /endpara
  299.  
  300.     /para
  301.         This command must be placed after the /topic command
  302.         but before any /para command.
  303.     /endpara
  304.  
  305. /endtopic
  306.  
  307. //
  308. // browse command
  309. //
  310.  
  311. /topic BROWSE_COMMAND
  312.  
  313.     /title The /browse command
  314.     /keywords /browse;commands
  315.     /browse commands,AUTO
  316.  
  317.     /para \sa300
  318.     /text \b\i\fs40,The /browse command
  319.     /endpara
  320.  
  321.     /para \sa150
  322.         The /browse command has the following syntax
  323.     /endpara
  324.  
  325.     /para \sa150
  326.         /text \b\f3,/browse browsename,browsenum or AUTO
  327.     /endpara
  328.  
  329.     /para \sa150
  330.         The browse command is used to set the browse sequence
  331.         numbers used by the Windows 3.0 help window to determine
  332.         what order to browse thru the help topics in.
  333.     /endpara
  334.  
  335.     /para \sa150
  336.         The browsename is the name of the browse catagory that
  337.         the browsenum is part of.  For example you may have one
  338.         category called commands and one called examples. In this
  339.         case the order of the browsenum values is only valid in
  340.         reference to the browsename that number is associated 
  341.         with. The browsename is just any name you find suitable
  342.         for your purposes.  When in help and you are viewing
  343.         a topic that is in a browsename category, if the user
  344.         hits the forward browse key he/she will be moved to the
  345.         topic which is in the same browsename category and has
  346.         the next highest number for browsenum. The reverse browse
  347.         key will move to the same browsename category with the
  348.         next lowest browsenum.
  349.     /endpara
  350.  
  351.     /para \sa150
  352.         /text \b,READ THIS...
  353.         If instead of a number you put the string AUTO in the browsenum
  354.         place QDHELP will automatically increment the browse count for
  355.         you.  This is a GREAT feature that I use in all the help
  356.         files I write.  You no longer have to number the sequences
  357.         on your own.  Just put AUTO in browsenum and you will browse
  358.         thru the topics in the same order that you have them in the
  359.         file.  If you use AUTO do NOT use any numbers for browsenum
  360.         in the same browsename.  This will cause unpredictable results
  361.         since the number you choose may have already been used by the
  362.         AUTO command.
  363.     /endpara
  364.  
  365.     /para \sa150
  366.         /text \b,Command Placement
  367.     /endpara
  368.  
  369.     /para
  370.         This command must be placed after the /topic command
  371.         but before any /para command.
  372.     /endpara
  373.  
  374. /endtopic
  375.  
  376. //
  377. // para command
  378. //
  379.  
  380. /topic PARA_COMMAND
  381.  
  382.     /title The /para command
  383.     /keywords /para;commands
  384.     /browse commands,AUTO
  385.  
  386.     /para \sa300
  387.     /text \b\i\fs40,The /para command
  388.     /endpara
  389.  
  390.     /para \sa150
  391.         The /para command has the following syntax
  392.     /endpara
  393.  
  394.     /para
  395.         /text \b\f3,/para 
  396.         /link PARA_FORMAT_STRINGS,paragraph specific format strings
  397.     /endpara
  398.     /para
  399.         ...text strings...
  400.     /endpara
  401.     /para \sa150
  402.         /text \b\f3,/endpara
  403.     /endpara
  404.  
  405.     /para \sa150
  406.         The /para command is used to let the QDHELP system
  407.         know that this is the start of a new paragraph. Inside
  408.         of the /para command there are a number of commands that
  409.         can be used to set up hyperlinks and popuplinks to 
  410.         other parts of the help system.
  411.     /endpara
  412.  
  413.     /para \sa150
  414.         /text \b,Command Placement
  415.     /endpara
  416.  
  417.     /para \sa150
  418.         This command must be placed after the /topic,/title,/keyword,/browse
  419.         commands.
  420.     /endpara
  421.  
  422.     /para \sa150
  423.         /text \b,Commands used inside /para /endpara pair.
  424.     /endpara
  425.  
  426.     /para \sa150
  427.         Internal to the /para command there are a number of commands that
  428.         can be used to create links to other parts of the help system
  429.         these commands are listed below.
  430.     /endpara
  431.  
  432.     /para
  433.         /link TEXT_COMMAND,/text command
  434.     /endpara
  435.     
  436.     /para
  437.         /link LINK_COMMAND,/link command
  438.     /endpara
  439.  
  440.     /para
  441.         /link POPUP_COMMAND,/popup command
  442.     /endpara
  443.  
  444.     /para
  445.         /link BITMAPLINK_COMMAND,/bitmaplink command
  446.     /endpara
  447.  
  448.     /para
  449.         /link BITMAP_COMMAND,/bitmap command
  450.     /endpara
  451.         
  452. /endtopic
  453.  
  454. //
  455. // para format strings
  456. //
  457.  
  458. /topic PARA_FORMAT_STRINGS
  459.  
  460.     /title Paragraph format strings
  461.     /keywords rtf;format
  462.  
  463.     /para \sa300
  464.         /text \b\i\fs40,Paragraph format strings
  465.     /endpara
  466.  
  467.     /para \sa150 \box \brdrsh
  468.         Here you will find a list of formatting commands
  469.         that can be placed after the /para command. If the
  470.         reader is familiar with the rich text format, they
  471.         may find the look of these commands very similar.
  472.         That is because these are RTF commands!
  473.     /endpara
  474.  
  475.     /para \sa150
  476.         /text \b,Paragraph Justification.
  477.     /endpara
  478.  
  479.     /para 
  480.     \\ql left justified paragraph
  481.     /endpara
  482.  
  483.     /para 
  484.     \\qr right justified paragraph
  485.     /endpara
  486.  
  487.     /para 
  488.     \\qj justified paragraph
  489.     /endpara
  490.  
  491.     /para 
  492.     \\qc centered paragraph
  493.     /endpara
  494.  
  495.     /para
  496.         /link PARAGRAPH_JUSTIFY_EXAMPLES,Paragraph Justify Examples
  497.     /endpara
  498.  
  499.     /para \sa150\sb150
  500.         /text \b,Paragraph Indentation
  501.     /endpara
  502.  
  503.     /para     
  504.     \\fi000    first line of paragraph indent.
  505.     /endpara
  506.  
  507.     /para
  508.     \\li000 left indent. 
  509.     /endpara
  510.  
  511.     /para
  512.     \\ri000 right indent
  513.     /endpara
  514.  
  515.     /para
  516.         /link PARAGRAPH_INDENT_EXAMPLES,Paragraph Indent Examples
  517.     /endpara
  518.  
  519.     /para \sa150\sb150
  520.         /text \b,Paragraph Spacing
  521.     /endpara
  522.  
  523.     /para
  524.     \\sb000 space before paragraph.
  525.     /endpara
  526.  
  527.     /para
  528.     \\sa000 space after paragraph.
  529.     /endpara
  530.  
  531.     /para
  532.     \\sl000 space between lines.
  533.     /endpara
  534.  
  535.     /para
  536.         /link PARAGRAPH_SPACING_EXAMPLES,Paragraph Spacing Examples
  537.     /endpara
  538.  
  539.     /para \sa150\sb150
  540.         /text \b,Paragraph Border Placement
  541.     /endpara
  542.  
  543.     /para 
  544.         \\brdrt border on top of paragraph.
  545.     /endpara
  546.  
  547.     /para 
  548.         \\brdrb border on bottom of paragraph.
  549.     /endpara
  550.  
  551.     /para 
  552.         \\brdrl border on left of paragraph.
  553.     /endpara
  554.  
  555.     /para 
  556.         \\brdrr border on right of paragraph
  557.     /endpara
  558.  
  559.     /para 
  560.         \\box border around entire paragraph
  561.     /endpara
  562.  
  563.     /para
  564.         /link BORDER_PLACEMENT_EXAMPLES,Border Placement Examples
  565.     /endpara
  566.  
  567.     /para \sa150\sb150
  568.         /text \b,Paragraph Border Style
  569.     /endpara
  570.  
  571.     /para 
  572.         \\brdrs single thick border
  573.     /endpara
  574.  
  575.     /para 
  576.         \\brdrth thick border
  577.     /endpara
  578.  
  579.     /para 
  580.         \\brdrsh shadow border
  581.     /endpara
  582.  
  583.     /para 
  584.         \\brdrdb double border
  585.     /endpara
  586.  
  587.     /para
  588.         /link BORDER_STYLE_EXAMPLES,Border Style Examples
  589.     /endpara
  590.     
  591. /endtopic    
  592.  
  593. //
  594. // paragraph justify examples
  595. //
  596.  
  597. /topic PARAGRAPH_JUSTIFY_EXAMPLES
  598.  
  599.         /browse examples,AUTO
  600.  
  601.     /para \sa300
  602.         /text \b,Paragraph Justification Examples.
  603.     /endpara
  604.  
  605.     /para \ql\sa150 \brdrth \box
  606.         This paragraph is left justified. This is just some
  607.         text so that you can see that it is left justified!
  608.         It was generated with the command
  609.         /text \b,/para \\ql
  610.     /endpara
  611.  
  612.     /para \qr\sa150 \brdrth \box
  613.         This paragraph is right justified. This is just some
  614.         text so that you can see that it is right justified!
  615.         It was generated with the command
  616.         /text \b,/para \\qr
  617.     /endpara
  618.  
  619.     /para \qj\sa150 \brdrth \box
  620.         This paragraph is justified. This is just some
  621.         text so that you can see that it is justified!
  622.         It was generated with the command
  623.         /text \b,/para \\qj
  624.     /endpara
  625.  
  626.     /para \qc\sa150 \brdrth \box
  627.         This paragraph is centered. This is just some
  628.         text so that you can see that it is centered!
  629.         It was generated with the command
  630.         /text \b,/para \\qc
  631.     /endpara
  632.  
  633. /endtopic
  634.  
  635. //
  636. // paragraph indent examples
  637. //
  638.  
  639. /topic PARAGRAPH_INDENT_EXAMPLES
  640.  
  641.     /browse examples,AUTO
  642.  
  643.     /para \sa300
  644.         /text \b,Paragraph Indentation Examples
  645.     /endpara
  646.  
  647.     /para \fi300\sa150 \brdrth \box
  648.         This is a paragraph where the first line is indented.
  649.         It was generated using the command
  650.         /text \b,/para \\fi300
  651.         where 300 is the number of 
  652.         /popuplink TWIPS,twips
  653.         to indent the first line.
  654.     /endpara
  655.  
  656.     /para \li300\sa150 \brdrth \box
  657.         This is a paragraph that entire paragraph is indented
  658.         on the left.
  659.         It was generated using the command
  660.         /text \b,/para \\li300
  661.         where 300 is the number of
  662.         /popuplink TWIPS,twips
  663.         to indent the entire paragraph
  664.     /endpara
  665.  
  666.     /para \ri300\sa150 \brdrth \box
  667.         This is a paragraph that entire paragraph is indented
  668.         on the right.
  669.         It was generated using the command
  670.         /text \b,/para \\ri300
  671.         where 300 is the number of
  672.         /popuplink TWIPS,twips
  673.         to indent the entire paragraph
  674.     /endpara
  675.  
  676. /endtopic
  677.  
  678. //
  679. // paragraph spacing examples
  680. //
  681.  
  682. /topic PARAGRAPH_SPACING_EXAMPLES
  683.  
  684.     /browse examples,AUTO
  685.  
  686.     /para \sb300
  687.         /text \b,Paragraph Spacing Examples
  688.     /endpara
  689.  
  690.     /para \sb500 \brdrth \box
  691.         This is a paragraph with a lot of space before it.
  692.         It was generated with the command
  693.         /text \b,/para \\sb500
  694.         where 500 is the number of 
  695.         /popuplink TWIPS,twips
  696.         between the previous paragraph and this paragraph.
  697.     /endpara
  698.  
  699.     /para \sa500 \brdrth \box
  700.         This is a paragraph with a lot of space after it.
  701.         It was generated with the command
  702.         /text \b,/para \\sa500
  703.         where 500 is the number of 
  704.         /popuplink TWIPS,twips
  705.         between the previous paragraph and this paragraph.
  706.     /endpara
  707.  
  708.     /para \sl450 \brdrth \box
  709.         This is a paragraph with alot of space between the
  710.         lines. If you only have one line resize the help
  711.         window to a smaller size to cause more than one line
  712.         to be used.
  713.         This paragraph was generated with the command
  714.         /text \b,/para \\sl450
  715.         where 450 is the number of 
  716.         /popuplink TWIPS,twips
  717.         between the lines.
  718.     /endpara
  719.  
  720. /endtopic
  721.  
  722. //
  723. // border placement examples
  724. //
  725.  
  726. /topic BORDER_PLACEMENT_EXAMPLES
  727.  
  728.     /browse examples,AUTO
  729.  
  730.     /para \sa300
  731.         /text \b,Paragraph Border Placement Examples
  732.     /endpara
  733.  
  734.     /para \brdrt\sa150 
  735.     This is a paragraph with the border placed only on top of 
  736.     it.
  737.     It was generated with the command
  738.     /text \b,/para \\brdrt
  739.     /endpara
  740.  
  741.     /para \brdrb\sa150 
  742.     This is a paragraph with the border placed only on 
  743.     bottom of it.
  744.     It was generated with the command
  745.     /text \b,/para \\brdrb
  746.     /endpara
  747.  
  748.     /para \brdrl\sa150 
  749.     This is a paragraph with the border placed only on 
  750.     the left of it.
  751.     It was generated with the command
  752.     /text \b,/para \\brdrl
  753.     /endpara
  754.  
  755.     /para \brdrr\sa150 
  756.     This is a paragraph with the border placed only on 
  757.     right of it.
  758.     It was generated with the command
  759.     /text \b,/para \\brdrr
  760.     /endpara
  761.  
  762.     /para \box\sa150 
  763.     This is a paragraph with the border placed 
  764.     all the way around it.
  765.     It was generated with the command
  766.     /text \b,/para \\box
  767.     /endpara
  768.  
  769. /endtopic
  770.  
  771. //
  772. // border style examples
  773. //
  774.  
  775. /topic BORDER_STYLE_EXAMPLES
  776.  
  777.     /browse examples,AUTO
  778.  
  779.     /para \sa300
  780.         /text \b,Paragraph Border Style Examples
  781.     /endpara
  782.  
  783.     /para \box\brdrs\sa150
  784.     This is a paragraph with a border of single thickness
  785.     around it. It was generated with the command 
  786.     /text \b,/para \\box\\brdrs.
  787.     /endpara
  788.  
  789.     /para \box\brdrth\sa150
  790.     This is a paragraph with a thick border around it. 
  791.     It was generated with the command 
  792.     /text \b,/para \\box\\brdrth.
  793.     /endpara
  794.  
  795.     /para \box\brdrsh\sa150
  796.     This is a paragraph with a shadow border around it. 
  797.     It was generated with the command 
  798.     /text \b,/para \\box\\brdrsh.
  799.     /endpara
  800.  
  801.     /para \box\brdrdb\sa150
  802.     This is a paragraph with a double border around it. 
  803.     It was generated with the command 
  804.     /text \b,/para \\box\\brdrdb.
  805.     /endpara
  806.  
  807. /endtopic
  808.  
  809. //
  810. // text command
  811. //
  812.  
  813. /topic TEXT_COMMAND
  814.  
  815.     /title The /text command
  816.     /keywords /text;commands
  817.         /browse paracom,AUTO
  818.  
  819.     /para \sa300
  820.         /text \b\i\fs40,The /text command
  821.     /endpara
  822.  
  823.     /para \sa150
  824.         The /text command has the following syntax
  825.     /endpara
  826.  
  827.     /para \sa150
  828.         /text \b,/text 
  829.         /link TEXT_FORMAT_STRINGS,text specific format strings
  830.         , the text
  831.     /endpara
  832.  
  833.     /para \sa150
  834.         The format properties will be applied to the text found between
  835.         the comma (,) and the end of the line which contains the /text
  836.         command.
  837.     /endpara
  838.  
  839. /endtopic
  840.  
  841. //
  842. // text format strings
  843. //
  844.  
  845. /topic TEXT_FORMAT_STRINGS
  846.  
  847.     /title Text format strings
  848.     /keywords /text;format strings
  849.  
  850.     /para \sa300
  851.         /text \b\i\fs40,Text format strings
  852.     /endpara
  853.  
  854.     /para \sa150
  855.         Following are strings that you can add to the /text
  856.         command to cause the string printed by the text command
  857.         to take on special properties.
  858.         The output of these effects will depend on the font
  859.         in use. Since these are really RTF commands you can put
  860.         any RTF text formatting command into this position.  There
  861.         are the most common.
  862.     /endpara
  863.  
  864.     /para
  865.         /link TEXT_FORMAT_EXAMPLES,Examples
  866.     /endpara
  867.     /para
  868.         \\b = bold text
  869.     /endpara
  870.     /para
  871.         \\i = italic text
  872.     /endpara
  873.     /para
  874.         \\strike = strikethru text
  875.     /endpara
  876.     /para
  877.         \\f000 =
  878.         /popuplink FONTS,font number
  879.         where 000 is the font of choice.
  880.     /endpara
  881.     /para
  882.         \\fs000 = font size in half points where 000 is the size.
  883.     /endpara
  884.     /para
  885.         \\ul = underline text
  886.     /endpara
  887.     /para
  888.         \\up000 = superscript in half points where 000 is number of half points.
  889.     /endpara
  890.     /para
  891.         \\dn000 = subscript in half points where 000 is number of half points.
  892.     /endpara
  893.  
  894. /endtopic
  895.  
  896. //
  897. // text format examples
  898. //
  899.  
  900. /topic TEXT_FORMAT_EXAMPLES
  901.  
  902.     /para \sa150
  903.         The following are examples of different text formating
  904.         commands that you can use.  It is important to note that
  905.         the help compiler uses certain sequences of commands to
  906.         signal links,popups etc.  Results of using these commands
  907.         on text will be unpredictable if you use a sequence that
  908.         help has defined for its own use. This should be a very
  909.         rare case.  Consult your help compiler manual to understand
  910.         the sequences used by the help engine.
  911.     /endpara
  912.     /para 
  913.         /text \b,This is bold text
  914.     /endpara
  915.     /para
  916.         /text \i,This is italic text
  917.     /endpara
  918.     /para
  919.         /text \strike,This is strikethrough text
  920.     /endpara
  921.     /para
  922.         /link FONTS,Press here if you want to see the fonts
  923.     /endpara
  924.     /para
  925.         /text \fs50,This is font size 50 text
  926.     /endpara
  927.     /para
  928.         /text \ul,This is underlined text
  929.     /endpara
  930.  
  931.     /para
  932.         Regular text,
  933.         /text \up300,This is superscript 6 half points
  934.     /endpara
  935.     /para
  936.         Regular text,
  937.         /text \dn300,Thisis subscript 6 half points
  938.     /endpara
  939.  
  940.  
  941. /endtopic
  942.  
  943. //
  944. // fonts
  945. //
  946.  
  947. /topic FONTS
  948.  
  949.     /title Fonts
  950.     /keywords fonts
  951.  
  952.     /para \sa150
  953.         The following list correlates font name to font number.
  954.     /endpara
  955.  
  956.     /para
  957.         /text \f000,This is Tms Rmn, \tab \tab value = 000
  958.     /endpara
  959.  
  960.     /para
  961.         /text \f002,This is Helv,        \tab \tab value = 002
  962.     /endpara
  963.  
  964.     /para
  965.         /text \f004,This is Courier,    \tab \tab value 004
  966.     /endpara
  967.  
  968.     /para
  969.         /text \f011,This is Helvetica,  \tab \tab value 011
  970.     /endpara
  971.  
  972.     /para
  973.         /text \f067,This is Modern,    \tab \tab value 067
  974.     /endpara
  975.  
  976.     /para
  977.         /text \f068,This is Roman,     \tab \tab value 068
  978.     /endpara
  979.  
  980. /endtopic
  981.  
  982. //
  983. // link command
  984. //
  985.  
  986. /topic LINK_COMMAND
  987.  
  988.     /title The /link command
  989.     /keywords /link;commands
  990.             /browse paracom,AUTO
  991.  
  992.     /para \sa300
  993.     /text \b\i\fs40,The /link command
  994.     /endpara
  995.  
  996.     /para \sa150
  997.             The /link command has the following syntax
  998.     /endpara
  999.  
  1000.     /para \sa150
  1001.             /text \b,/link TOPIC_NAME,link string
  1002.     /endpara
  1003.  
  1004.         /para
  1005.         The TOPIC_NAME is the name of the topic that this link should
  1006.         transfer the user to.  The link string is the string that is
  1007.         printed in the help window.
  1008.     /endpara
  1009.  
  1010. /endtopic
  1011.  
  1012. //
  1013. // popup command
  1014. //
  1015.  
  1016. /topic POPUP_COMMAND
  1017.  
  1018.     /title The /popuplink command
  1019.     /keywords /popuplink;commands
  1020.     /browse paracom,AUTO
  1021.  
  1022.     /para \sa300
  1023.     /text \b\i\fs40,The /popuplink command
  1024.     /endpara
  1025.  
  1026.     /para \sa150
  1027.         The /popuplink command has the following syntax
  1028.     /endpara
  1029.  
  1030.     /para \sa150
  1031.         /text \b,/popuplink TOPIC_NAME,link string
  1032.     /endpara
  1033.  
  1034.     /para
  1035.         The TOPIC_NAME is the name of the topic that this link should
  1036.         transfer the user to.  The link string is the string that is
  1037.         printed in the help window.
  1038.     /endpara
  1039.  
  1040. /endtopic
  1041.  
  1042. //
  1043. // bitmaplink command
  1044. //
  1045.  
  1046. /topic BITMAPLINK_COMMAND
  1047.  
  1048.     /title The /bitmaplink command
  1049.     /keywords /bitmaplink;commands
  1050.     /browse paracom,AUTO
  1051.  
  1052.     /para \sa300
  1053.     /text \b\i\fs40,The /bitmaplink command
  1054.     /endpara
  1055.  
  1056.     /para \sa150
  1057.         The /bitmaplink command has the following syntax
  1058.     /endpara
  1059.  
  1060.     /para \sa150
  1061.         /text \b,/bitmaplink TOPIC_NAME,filename
  1062.     /endpara
  1063.  
  1064.     /para
  1065.         The TOPIC_NAME is the name of the topic that this link should
  1066.         transfer the user to.
  1067.         The filename is the name of the bitmap
  1068.         file where the image data will be gotten from.  This filename
  1069.         should NOT include any path information.  The path information
  1070.         about where the bitmap lives in put into the .hpj file use by
  1071.         the
  1072.         /popuplink MICROSOFT,Microsoft
  1073.         help complier.
  1074.     /endpara
  1075.  
  1076. /endtopic
  1077.  
  1078. //
  1079. // bitmap command
  1080. //
  1081.  
  1082. /topic BITMAP_COMMAND
  1083.  
  1084.     /title The /bitmap command
  1085.     /keywords /bitmap;commands
  1086.     /browse paracom,AUTO
  1087.  
  1088.     /para \sa300
  1089.     /text \b\i\fs40,The /bitmap command
  1090.     /endpara
  1091.  
  1092.     /para \sa150
  1093.         The /bitmap command has the following syntax
  1094.     /endpara
  1095.  
  1096.     /para \sa150
  1097.         /text \b,/bitmap position,filename
  1098.     /endpara
  1099.  
  1100.     /para
  1101.         The position in the above command is a single character with
  1102.         the following meaning l=left,r=right,c=character which means
  1103.         treat the bitmap just like a character and put it wherever it
  1104.         goes in the sentence.
  1105.         The filename is the name of the bitmap
  1106.         file where the image data will be gotten from.  This filename
  1107.         should NOT include any path information.  The path information
  1108.         about where the bitmap lives in put into the .hpj file use by
  1109.         the
  1110.         /popuplink MICROSOFT,Microsoft
  1111.         help complier.
  1112.     /endpara
  1113.  
  1114. /endtopic
  1115.  
  1116. //
  1117. // what is a twip?
  1118. //
  1119.  
  1120. /topic TWIPS
  1121.  
  1122.     /title twips
  1123.     /keywords twips
  1124.  
  1125.     /para
  1126.     A twip is a unit used to measure output to a graphics device.
  1127.     A twip has a value of 1/1440 of an inch.  In other words there
  1128.     are 1440 twips per inch.
  1129.     /endpara
  1130.  
  1131. /endtopic
  1132.  
  1133. //
  1134. // how to run the ascii help builder program
  1135. //
  1136.  
  1137. /topic RUNNING
  1138.  
  1139.     /title Running Quick and Dirty Help
  1140.     /keywords run;running
  1141.     /browse index,AUTO
  1142.  
  1143.     /para \sa300
  1144.         /text \b\i\fs40,Running Quick and Dirty Help
  1145.     /endpara
  1146.  
  1147.     /para
  1148.         The following items contain information on running 
  1149.         quick and dirty help from the DOS command line. 
  1150.     /endpara
  1151.  
  1152.     /para \sa300
  1153.         The qdhelp program is invoked on the DOS command line.
  1154.         The following syntax is used
  1155.        /endpara
  1156.  
  1157.     /para \fs20\box\sa300
  1158.         qdhelp inputfile [outputfile]
  1159.     /endpara
  1160.     
  1161.     /para
  1162.         The outputfile is optional. If no output file name is
  1163.         given the output will be written to the default file
  1164.         out.rtf. 
  1165.     /endpara
  1166.  
  1167. /endtopic
  1168.  
  1169. //
  1170. // hints and tips
  1171. //
  1172.  
  1173. /topic HINTS
  1174.  
  1175.     /title hints and tips
  1176.     /keywords hints;tips
  1177.     /browse index,AUTO
  1178.  
  1179.     /para \sa300
  1180.         /text \b\i\fs40,Hints and Tips
  1181.         /bitmaplink INDEX,done.bmp
  1182.     /endpara
  1183.  
  1184.     /para \box\sa150
  1185.         The best way to get a feel for using the QDHELP system
  1186.         is to look over the file QUICK.QDH.  This is the file
  1187.         that contains the input to QDHELP which was used to
  1188.         generate the help file that you are currently reading.
  1189.     /endpara
  1190.  
  1191.     /para \box\sa150
  1192.         When developing your help system.  First develop a standard
  1193.         look to each of your topics.  This would include what the
  1194.         title will look like, the spacing of the paragraphs, the
  1195.         method you will use for subtitles, etc.  By putting in a
  1196.         little work up front you will be able to work most of your
  1197.         topics from this template.  Given an ascii editor with cut
  1198.         and paste (the Windows 3.0 notebook will do) you should be
  1199.         able to crank out your help file in a short amount of time.
  1200.      /endpara
  1201.  
  1202.     /para \box\sa150
  1203.         To generate a blank line between 2 groups of text 
  1204.         use the \\sa300 command in the paragraph format
  1205.         string for the first paragraph.  
  1206.     /endpara
  1207.     
  1208.     /para \box
  1209.         To generate a list of links each on a separate line place
  1210.         each /link command in a separate /para /endpara pair.            
  1211.     /endpara
  1212.  
  1213.  
  1214.         
  1215. /endtopic
  1216.  
  1217. /topic ERRATA
  1218.     /title Errata
  1219.     /keywords bugs;errata
  1220.     /browse index,AUTO
  1221.  
  1222.     /para \sa300
  1223.         /text \b\i\fs40,Errata
  1224.         /bitmaplink INDEX,done.bmp
  1225.     /endpara
  1226.  
  1227.     /para \box\sa300
  1228.         Below is a list of known problems and work arounds if
  1229.         any are known
  1230.     /endpara
  1231.  
  1232.     /para \box
  1233.         I dont know of any way to force a line feed in the middle
  1234.         of standard text.  Im sure there is a way I just havent figured
  1235.         it out yet.  If you know of a way drop me a note.
  1236.     /endpara
  1237.  
  1238.     /para \box
  1239.         Tab character is not allowed beyond the first non white space
  1240.         character in the string.  In other words you can use tab to
  1241.         indent at the start of the line but not in the middle of a
  1242.         line.  (I know it's silly, I'm working on it!).  If you want
  1243.         to put a tab into your text use \\tab this will put a tab
  1244.         into the text.
  1245.     /endpara
  1246.  
  1247.     /para \box
  1248.         Bitmap files can not have a comma (,) in there file
  1249.         name.  This is a known bug and will be fixed in later
  1250.         releases 
  1251.     /endpara
  1252.         
  1253. /endtopic
  1254.  
  1255.  
  1256. //
  1257. // test topic
  1258. //
  1259.  
  1260. /topic TEST
  1261.  
  1262.     /title test
  1263.     /keywords test
  1264.     /browse index,AUTO
  1265.  
  1266.     /para
  1267.     Some text
  1268.     /bitmap l,done.bmp
  1269.     /bitmap r ,done.bmp
  1270.     More Text 
  1271.     /bitmap c,bullet.bmp  
  1272.     /endpara
  1273.     
  1274. /endtopic
  1275.  
  1276.