home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / htext.lzh / hypertext / Documentation / HTConfig.doc < prev    next >
Encoding:
Text File  |  1990-12-23  |  5.9 KB  |  146 lines
  1. Program    HTConfig
  2.  
  3. Purpose    To allow flexible and easy configuration of HT.  Will dynamically
  4.        change where HT looks for files, etc.
  5.  
  6. Usage       HTConfig       OR          Double click the WorkBench Icon
  7.        (there are no command line options)
  8.  
  9.  
  10. Description :
  11.  
  12.     The HT Configuration utility is used to inform HT where to look for
  13. various external programs, and how to behave.  HTConfig simply pops up a
  14. small window which allows you to edit various parameters.  By clicking on
  15. the gadgets on the left side of the window, you will be prompted to enter a
  16. new value which will appear on the right side of the window.
  17.  
  18.     When you have filled in the values you like, simply click the "Install
  19. this configuration" gadget.  A requestor will pop up asking you to decide
  20. where to write the configuration file.    After having saved the changes, HT
  21. will be informed of your new parameters.  The configuration file can be
  22. written to the current directory or to the S: directory.
  23.  
  24.     It is useful to have the configuration file written to the current
  25. directory if you have a special setup for a certain set of documents.  If
  26. you would like a consistent environment for all HT documents, you should
  27. have the config file written to the S: directory.  Then, the next time HT
  28. starts up, it will look this configuration file, first in the current
  29. directory, then in the S: directory.  This allows you to have multiple
  30. configurations for use with HT.
  31.  
  32.     If you decide that you don't want to finish the configuration, simply
  33. click "Quit Configuration" (or the Close gadget), and the utility will
  34. exit.
  35.  
  36.     The configuration file is a plain ASCII file which has entries, 1 per
  37. line, of name / value pairs.  The "name" parameter is one of : Edit, Show,
  38. Anim, Play, Sound, Usescreen, and Askfirst.  The values a either pathnames
  39. to programs, or Yes/On for a boolean type of field (UseScreen and
  40. Askfirst).  You can edit this file with a standard text editor if you wish.
  41.  
  42.  
  43. Explanation of the various Gadgets :
  44.  
  45.     The gadgets on the left side of the HT Configuration utility are the
  46. options which you can change.  Clicking them prompts you for a new value.
  47. Each of the gadgets applies to one aspect of HT.  Since there are several
  48. types of links and features in HT which rely on external programs, HT needs
  49. to know where to find these programs.  For example, if a piece of text is
  50. linked to an IFF picture, HT must know the pathname of the program to use
  51. to display the picture.  HT has reasonable defaults, and for most folks,
  52. there will be no need to change a thing.  However if you have a somewhat
  53. different setup or different naming scheme for these programs, you can tell
  54. HT by using this utility.
  55.  
  56.  
  57.      Here is a short description of each gadget/option:
  58.      __________________________________________________
  59.  
  60. "Editor for editing HT notes"  :
  61.  
  62.     This option will let you tell HT which editor you would like to have
  63. started to edit notes you have taken during an HT session.  Generally this
  64. will be the name of a text editor that you like to use.  This defaults to
  65. the program "ed" somewhere in your path.
  66.  
  67. __________________________________________________________________________
  68.  
  69.  
  70. "IFF Picture Viewer"  :
  71.  
  72.     This option allows you to specify the program that should be run to
  73. view IFF pictures when a link is to a picture.    You can specify any program
  74. that will display IFF pictures.  The default is to the program "show"
  75. somewhere in your path.
  76.  
  77. __________________________________________________________________________
  78.  
  79.  
  80. "Animation Player Program" :
  81.  
  82.     This gadget lets you tell HT which program to run for viewing
  83. Animations when a link is to an Animation.  The default for this is the
  84. program "showanim", which again should be somewhere in your path.
  85.  
  86. __________________________________________________________________________
  87.  
  88.  
  89. "Digitized Sound Player" :
  90.  
  91.     Clicking this gagdet lets you specify what program HT should use to
  92. play Digitized sounds when a link is to a Sound.  The default is the
  93. program "ssp", which should be reachable in your path.
  94.  
  95. __________________________________________________________________________
  96.  
  97.  
  98. "Song (SMUS) Player program" :
  99.  
  100.     This program will let you tell HT which program should be used for
  101. links which are to Songs.  The program you specify should able to play IFF
  102. SMUS format music files.  The default is the program "play" somewhere in
  103. your path.
  104.  
  105. __________________________________________________________________________
  106.  
  107.  
  108. "Ask before running programs?" :
  109.  
  110.     Firstly, this option is different from the other options as this is a
  111. toggle.  Clicking it causes the value on the right to toggle between off
  112. and on.
  113.  
  114.     This option is very important if you aren't sure about a document.
  115. Since HT documents can have links which run any arbitrary program, it is
  116. possible for a nasty person to do damage.  Setting the variable to "Yes/On"
  117. will instruct HT to have you confirm before any program is run.  This
  118. defaults to No since generally this shouldn't be a problem.
  119.  
  120. __________________________________________________________________________
  121.  
  122.  
  123. "Use a custom screen for HT" :
  124.  
  125.     Firstly, this option is different from the other options as this is a
  126. toggle.  Clicking it causes the value on the right to toggle between off
  127. and on.
  128.  
  129.     Setting this option to "Yes/On" will cause HT to open a custom screen
  130. for itself (and any HT windows).  Some people like to keep their WorkBench
  131. screen clear, and HT obliges.  If this value is "Yes/On", HT will open all
  132. windows on a seperate screen.  This option is only good if HT has not been
  133. started.  You can set this option to Yes if HT has already been started,
  134. but the option will not take effect until the next time you run HT.
  135.  
  136. __________________________________________________________________________
  137.  
  138.  
  139.     That covers each of the gadgets and their purpose.    To change a value,
  140. simply click the gadget, and you will be prompted for the new value.  If
  141. you don't want to change the current value, cancel the input requestor.
  142. Otherwise, simply enter the name of the appropriate program in the
  143. requestor.
  144.  
  145.  
  146.