home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / htext.lzh / hypertext / Documentation / SetUpInfo < prev    next >
Encoding:
Text File  |  1990-12-23  |  5.0 KB  |  129 lines
  1. \help ht.help
  2. \title Setup Commands
  3. \fgcolor 3
  4. \bgcolor 1
  5. \center
  6. \under SETUP COMMANDS \under
  7.  
  8.  
  9. \format
  10.      The Setup Commands.  The purpose of these '\\' commands is to affect
  11. the way HT looks and a little of how it behaves.  These commands have to
  12. come at the \ital BEGINNING \ital of your document.  They are \bold not
  13. \bold displayed, but must be at the beginning of your file.
  14.  
  15. \center
  16. \under The Setup Commands are:\underl
  17.  
  18. \indent 20
  19. \freeformat
  20. \link { SetUpCommands \FONT } Setting the Font for a document. \endlink
  21. \link { SetUpCommands \TITLE } Giving a window a specific Title. \endlink
  22. \link { SetUpCommands \BGCOLOR } Setting the BackGround color. \endlink
  23. \link { SetUpCommands \FGCOLOR } Setting the ForeGround color. \endlink
  24. \link { SetUpCommands \LOCATION } Setting the Window Position. \endlink
  25. \link { SetUpCommands \TEXTCOLOR } Setting the Text Color. \endlink
  26. \link { SetUpCommands \HELP } Defining a help file. \endlink
  27.  
  28.  
  29. \format
  30.      Setup commands are provided as a way to customize your documents and
  31. to make them more visually appealing.  In a sense they are a small header
  32. which tells HT how to modify its basic display.
  33.  
  34. \bold
  35. Restrictions on Setup Commands:
  36. \bold
  37.  
  38. \format
  39.      Unfortunately there are some restrictions on the format of setup
  40. commands.  O.k., what are the restrictions?  They are:
  41.  
  42. \indent 10
  43. \freeformat
  44. \bold
  45. 1. Setup commands must be lower case.
  46. 2. All of your setup commands *must* appear at the beginning
  47.    of the file
  48. 3. They must take less than 2k of space (not really a problem as
  49.    there are only 7 of them).
  50. \bold
  51.  
  52. \format
  53.     That's basically it for restrictions (although any restrictions are
  54. bad ones, the tradeoff here (internally) was well worth it).
  55.  
  56.  
  57.      Another thing to remember about setup commands is that they are one
  58. command to a line.  This means you would put them in this sort of format:
  59.  
  60. \freeformat
  61. \indent 20
  62. \\title My really nifty document
  63. \\font diamond 25
  64. \\location 25 25 400 100
  65. The rest of your document...........
  66.  
  67. \format
  68.     If not, only the first command on each line will be recognized, and it
  69. is even possible for another command to be treated as part of the title
  70. if the line started with the \\title keyword.
  71.  
  72.  
  73. \center
  74. \bold On to more interesting things \bold
  75.  
  76.     The setup commands are a useful tool for creating document
  77. environments.  Using the setup commands, it is possible to use \bold color
  78. \bold coding to provide a sense of location.  In a set of hypertext
  79. documents, setting the same color for documents at roughly the same "level"
  80. in the structure will help your reader to gain a subliminal feeling for
  81. where they are (of course this isn't a substitute for a map facility, but a
  82. supplement).  The \link { SetUpCommands \FGCOLOR } \\fgcolor, \\bgcolor
  83. commands are what you would use. \endlink
  84.  
  85.  
  86.     Setting the window title is another easy method of configuration.
  87. Suppose you would like to convey some information through your title bar.
  88. \it I.E. \it an indication of depth/width or some sort of cue.    It is as
  89. simple as putting a \link { Setupcommands \TITLE } \\Title command in your
  90. document header. \endlink
  91.  
  92.  
  93.     Of course Help is always an important features, and since the Amiga has
  94. a HELP key, I am practically compelled to make use of it ;-).  You can define an
  95. an individual help file for each document.  Using the command \Link  {
  96. SetUpCommands HELP } \\HELP,\Endlink  you can specify which file will be
  97. brought up when the user presses the help key in that window.  If you don't
  98. define a help file for a particular window, HT will simply tell the user
  99. there is no help file defined for this window.    This would be a terrible
  100. thing however, since it is so easy to do.  Try to make use of this feature
  101. when it is feasible.  It will greatly aid the novice user.
  102.  
  103.  
  104.     Setting the font for a window is equally easy.  All you must do is
  105. enter the \link { SetUpCommands } \\FONT\endlink keyword with the name and
  106. size of the font you want. That easy. Each window can have its own font.
  107. If the document you are writing/modifying uses HT formatting (\ital i.e.
  108. \ital the \\FORMAT keyword ), then HT will make sure all lines fit in the
  109. window for the given font size.  HT should work with just about any font,
  110. however some proportional fonts can produce text lines that seem a tad bit
  111. short for the actual window width.  This is due to a combination of the way
  112. the way HT is structured and how the Amiga deals with proportional fonts.
  113. You certainly can give just about any font you want a try though.
  114.  
  115.  
  116.     You can also specify where HT should open the window that will contain
  117. your document.    This is done with the \link { SetUpCommands LOCATION }
  118. \\Location \endlink keyword.  For example if you had a need for a window
  119. starting at 100,50 and dimensions of 300x125. You could embed a \\Location
  120. command to instruct HT to do this. Obviously this is error checked for
  121. sanity.
  122.  
  123.  
  124.     That about wraps it up for SetUp commands.    You would want to refer to
  125. the \link { SetUpCommands } SetUpCommands \endlink file for more detailed
  126. information on each of these commands.    Thank you for your continued
  127. support.
  128.  
  129.