home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / htext.lzh / hypertext / Documentation / SetUpCommands < prev    next >
Encoding:
Text File  |  1990-12-24  |  4.0 KB  |  132 lines
  1. \title Set Up Commands and what they do
  2. \fgcolor 1
  3. \bgcolor 3
  4. \format
  5. \bold \\FONT <fontname> <size> : \bold
  6. \indent 8
  7. This command will set the font for this window.
  8. Each window may have its own font.  Proportional
  9. fonts may or may not work well.  If the font
  10. cannot be found, the default system font (Topaz) will be used.
  11. It is also worthwhile to note that while using large
  12. fonts (point size > 20) is possible, the results may
  13. not be what you intended (this could be called a bug).
  14.  
  15. \freeformat
  16. \ital Example: \ital
  17.       1.)  \\font times 15        /* use a 15 point Times font     */
  18.       2.)  \\font helvetica 26  /* use a 26 point Helvetica font */
  19.  
  20.  
  21.  
  22. \format
  23. \bold \\TITLE <Some Title>     : \bold
  24. \indent 8
  25. Set the window Title for this document.  This is
  26. what will be displayed in the window title bar.
  27. Any text from \underline after\underline  the TITLE keyword to
  28. the end of line will be used as the window title.
  29.  
  30. \freeformat
  31. \ital Example: \ital
  32.       1.)  \\title    FlowerText
  33.       2.)  \\title    Joes' really cool HyperText Document
  34.  
  35.  
  36.  
  37. \format
  38. \bold \\BGCOLOR  <number>      : \bold
  39. \indent 8
  40. Set the Background color for the window border.  The
  41. number given is the pen number to use.    If your
  42. choice here is the same as the FGCOLOR option,
  43. the FGCOLOR will be complemented.  This keeps
  44. silly things like invisible window borders from
  45. happening.
  46.  
  47. \freeformat
  48. \ital Example: \ital
  49.       1.)  \\bgcolor 3    /* set window background color to pen 3 */
  50.       2.)  \\bgcolor 2    /* set window background color to pen 2 */
  51.  
  52.  
  53.  
  54. \format
  55. \bold \\FGCOLOR  <number>      : \bold
  56. \indent 8
  57. Set the Foreground color for the window border.
  58. Watch out for unusable color combinations.  Some
  59. can be *really* tough on the eyes (even if it
  60. is only the border).  This command and the one
  61. above are useful for using the windows to color
  62. code the different the levels within in your
  63. hypertext document(s) heirarchy.
  64.  
  65. \freeformat
  66. \ital Example: \ital
  67.       1.)  \\fgcolor 1    /* foreground color for window is pen 1 */
  68.       2.)  \\fgcolor 4    /* color in foreground of window is pen 4 */
  69.  
  70.  
  71.  
  72. \format
  73. \bold \\LOCATION <xmin> <ymin> <width> <height> : \bold
  74. \indent 8
  75. This command will set up the window to appear at
  76. your given coordinates if at all possible.  If you
  77. specify something too large, or off screen, it will
  78. put in suitable defaults.  The sanity checking
  79. is good, so don't worry about being off a few
  80. pixels here or there.
  81.  
  82. \freeformat
  83. \ital Example: \ital
  84.       /* open a window at 42x25 which is 400x100  */
  85.       1.)  \\location 42 25 400 100
  86.  
  87.       2.)  \\location 10 175 700 80  /* no good, but will work     */
  88.  
  89.  
  90.  
  91. \format
  92. \bold \\TEXTCOLOR <num> : \bold
  93. \indent 8
  94. This command will set the text in the window to be printed in <num> color.
  95. On a 4 color workbench screen, you specify the number between 0-3.  Larger
  96. numbers will simply wrap around.  Be careful of using unreadable
  97. combinations of text, some can very difficult to read.    Remember, this is
  98. only a setup command and cannot be used to change colors in the rest of a
  99. document (currently).
  100.  
  101. \freeformat
  102. \ital Example: \ital
  103.       1.)  \\textcolor 3      /* use pen number 3 to draw text */
  104.       2.)  \\textcolor 4      /* use pen number 4 to draw text */
  105.  
  106.  
  107.  
  108. \format
  109. \bold \\HELP <filename> :\bold
  110. \indent 8
  111. This command makes use of the help key on the Amiga keyboard. The file name
  112. you give will be taken as the file to load and display whenver the \bold
  113. HELP \bold key is pressed.  This provides a convienent and easy method to
  114. give help for your documents.  Each window may have its own seperate help
  115. file.  This is a very important command and \bold every \bold Hypertext
  116. author should make use of this in \ital each and every document. \ital    The
  117. Amiga keyboard is one of the few that actually has a HELP key, don't let it
  118. go to waste.
  119.  
  120. \freeformat
  121. \ital Example: \ital
  122.      1.) \\help my_help.doc
  123.         This example will open and display the file my_help.doc
  124.         (in the current directory) \italic whenever \italic the
  125.         help key is pressed.
  126.  
  127.      2.) \\help df1:help/quick_help.doc
  128.         In this example, when the user presses the help key,
  129.         the file df1:quick_help.doc will be displayed.
  130.  
  131.  
  132.