home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WP / HT01.ZIP / HT.DOC < prev    next >
Text File  |  1994-01-16  |  4KB  |  102 lines
  1. \\HT___A_Hypertext_Viewer
  2.  
  3. This is a documentation file for HT.EXE, a hypertext viewer. If you would
  4. like to see this documentation as hypertext, type
  5.  
  6.     ht ht.doc
  7.  
  8. and press Enter. To get help while in HT, use the F1 key. You can see an
  9. index of all the topics by pressing F2.
  10.  
  11. Most of the text on the screen appears in gray. You can move up and down
  12. thru the text with the up and down arrows, the Page Up and Page Down keys,
  13. and the Home and End keys. Keywords appear in green. The selected keyword
  14. appears in bright green. You can use the left and right arrow keys can be
  15. used to select different keywords. When you press the Enter key, you'll go
  16. to the topic with that keyword as a title.
  17.  
  18. This documentation includes information on \hypertext_files, \keywords, the
  19. \help_screen, and \memory_limitations. HT is \shareware.
  20.  
  21. \\Hypertext_Files
  22.  
  23. Hypertext files can be prepared with any standard text editor. Titles of
  24. topics should appear alone on a line, immediately preceded by two
  25. backslashes. The backslashes should be the first two characters on the line,
  26. and there should be no spaces, tabs, or other characters separating the
  27. backslashes from the title. Titles must be valid \keywords.
  28.  
  29. References to other topics are keywords immediately preceded by single
  30. backslashes. These may appear anywhere in the text.
  31.  
  32. If you don't specify a filename on the command line, HT will prompt you for
  33. one. If you don't supply a filename extension, HT will assume the extension
  34. is HT (e.g. foobar.ht).
  35.  
  36. Any text preceding the first title in the file will be treated as a comment
  37. and will not be visible from the viewer.
  38.  
  39. This file is an example of how a hypertext file should be set up.
  40.  
  41. \\Keywords
  42.  
  43. Keywords appear at the top of the page in gray, as the title of the
  44. currently displayed topic. Keywords referring to other topics are shown in
  45. green. Keywords can be up to 78 characters long. The following characters
  46. cannot appear in keywords: spaces, tabs, carriage returns, linefeeds,
  47. periods, commas, exclamation points, question marks, colons, semicolons,
  48. single quotes ('), or backslashes.
  49.  
  50. Keywords are case-insensitive. References like \memory_limitations,
  51. \HELP_SCREEN, and \HyPeRtExT_FiLeS are all equally valid.
  52.  
  53. \\Memory_Limitations
  54.  
  55. I have used HT with files larger than 360K. That's a lot of hypertext.
  56. Mileage may vary, depending on the available memory in your computer and
  57. what TSRs you're running.
  58.  
  59. If your file contains N characters, HT will attempt to allocate 1.1 * N +
  60. 5000 bytes of memory. The extra is to make room for the \help_screen and
  61. index. The help screen is around 600 bytes. The memory used by the index
  62. depends on the lengths of the 
  63.  
  64. In almost all cases, if HT can't allocate enough memory for your file, it
  65. will tell you what's happening, and gracefully exit. HT will crash
  66. ungraciously if the index overruns the allocated memory. This can happen if
  67. your file is really huge (about 400K, I think) and more than ten percent of
  68. your file is titles. You could do this by making a file with a huge number
  69. of single-line topics. So don't do that.
  70.  
  71. As far as I'm aware, that's the only condition that will cause HT to crash.
  72. When that happens, the computer announces that it has a "Memory Allocation
  73. Error" and you need to reboot.
  74.  
  75. \\Help_Screen
  76.  
  77. The help screen looks like this:
  78.  
  79. Navigating in text - Up arrow, Down arrow, Page up,
  80.          Page down, Home, End
  81.  
  82. Selecting Topics - Left arrow, Right arrow, Enter key
  83.             Previous Topic - Backspace key
  84.  
  85. Text Search - F3 to begin a search, F4 for next occurence
  86.  
  87. Index of all topics (not alphabetized) - F2
  88.  
  89. This help screen - F1
  90.  
  91. To quit hypertext and return to DOS - 'Q' or Escape key
  92.  
  93. Now press Backspace to return to the previous topic, F2 for
  94.             the index, or 'Q' or Escape to quit
  95.  
  96. \\Shareware
  97.  
  98. HT is shareware. If you enjoy it and find it useful, you are encouraged to
  99. register your copy by sending a check for fifteen dollars to Will Ware, 26
  100. Beacon St. #34B, Burlington MA 01803. People who register will receive
  101. copies of any upgrades, and will sleep a little better at night.
  102.