home *** CD-ROM | disk | FTP | other *** search
/ Between Heaven & Hell 2 / BetweenHeavenHell.cdr / garden / textpro.doc < prev    next >
Text File  |  1988-01-07  |  9KB  |  224 lines
  1.                           WELCOME TO TEXTPRO
  2.  
  3. INTRODUCTION
  4.  
  5. TextPro (tm) is a tool that lets you write hypertext documents.
  6. In a hypertext document any area of text in the document can be threaded
  7. to additional information that explains, expands or defines the concept.
  8. This lets you hide information that may be important for some readers
  9. but unnecessary to others. Using hypertext threads you can also write
  10. text that lets the user decide what to read next depending on interests
  11. and needs. This is what is referred to as "non-linear" text.
  12.  
  13. For example, in the paragraph above we could have marked the word
  14. "TextPro" as a hypertext item. When selected, the text thread to that
  15. item could give more information about TextPro, such as where you
  16. could get it, who wrote it, and so on. This information, while useful,
  17. would only clutter up the sense of the paragraph. Within the expanded
  18. text, there could be other hypertext items and so on.
  19.  
  20. Hypertext and Knowledge Processing
  21.  
  22. When a hypertext item is selected in TextPro or in other DOS based
  23. hypertext systems, the only effect is to display a message. In a knowledge
  24. processor, hypertext is linked to the structure of a full featured
  25. symbolic language so actions can also be performed. The environment
  26. in which TextPro was written is a knowledge processing environment
  27. called KnowledgePro. Some of the source code for the TextPro system
  28. is supplied in the file TEXTPRO.SRC. If you list this file you can see
  29. some of the powerful features available in a full knowledge processor.
  30.  
  31.  
  32. THE KNOWLEDGEPRO RUNTIME ENVIRONMENT
  33.  
  34. Before you can run TextPro you must load the KnowledgePro runtime
  35. environment which is provided with TextPro.
  36. To load KnowledgePro type :
  37.  
  38.    kp  <ENTER>
  39.  
  40. The menu screen which appears shows the programs, called "knowledge
  41. bases", that are available on the directory from which KnowledgePro
  42. was loaded.
  43.  
  44. If you're new to the KnowledgePro environment start by selecting the USING
  45. knowledge base. This describes how to use KnowledgePro. To select USING
  46. press :
  47.  
  48.    u <ENTER>
  49.  
  50. After you've looked at the USING knowledge base you should be familiar
  51. with the basics of using a KnowledgePro application. In general, press
  52. SPACE when you've finished reading a message, ESC to leave the editor
  53. and ENTER to select a menu item.
  54.  
  55.  
  56. RUNNING TEXTPRO
  57.  
  58. To start TextPro type :
  59.  
  60.    t <ENTER>
  61.  
  62. The main TextPro screen will now appear. On this screen you'll see
  63. some text that appears in inverse video. These items are hypertext
  64. items. That means that there is information hidden behind these words
  65. or groups of words. To select a hypertext item you can either press
  66. F3 until the cursor is over the item you want to expand (shift F3 will
  67. reverse the direction) or, point at the item with a mouse.
  68. When the cursor is over the item press F4 or, click either mouse
  69. button to expand the item.
  70.  
  71. Anytime you finish reading a message, you can press SPACE to continue
  72. or, point to the word SPACE in the lower left of the message window
  73. and click your mouse.
  74.  
  75. Try expanding some of the hypertext nodes from this opening screen
  76. to get a feel for how hypertext works. 
  77.  
  78. When you're ready to continue with TextPro, press SPACE to continue.
  79.  
  80.  
  81. The TextPro main menu
  82.  
  83. The main menu in TextPro contains the following options :
  84.  
  85.    Read a hypertext document                                                                                                    
  86.    Create or edit a hypertext document
  87.    Quit
  88.  
  89. First select "Read a hypertext document" to see an example.
  90.  
  91. You'll be asked the name of the file you want to read. You can type 
  92. in the name of any ASCII file. If there are no hypertext marks or 
  93. pages in the file it is broken into pages and displayed as straight 
  94. text. If you're not sure of what files are on your disk you can get 
  95. a menu of files using the "*" in place of a file name. All files are 
  96. named using regular DOS conventions. Type :
  97.  
  98.    *.hyp <ENTER>
  99.  
  100. For a list of all files with the suffix .hyp on the current 
  101. directory.
  102.  
  103. Select the file SAMPLE.HYP from this menu to see a sample hypertext 
  104. document. The hypertext items work the same way as they did in the
  105. opening screen.
  106.  
  107. When you read the last page of the document, you'll be returned to
  108. the opening menu.
  109.  
  110.  
  111. CREATING A TEXTPRO DOCUMENT
  112.  
  113. Select "Create or edit a hypertext document" from the menu.
  114.  
  115. When you're asked for the file name type :
  116.  
  117.          sample.hyp <ENTER>
  118.  
  119. This will load the KnowledgePro text editor with the hypertext file
  120. sample.hyp.  The editor uses WordStar commands. If you want to see a list of
  121. commands press F1 from within the editor. If you have a mouse you can call a
  122. menu of editor commands by pressing the left mouse button. A command is
  123. selected from the menu by pressing the right button.
  124.  
  125. When F4 is pressed a description of how to lay out hypertext documents
  126. appears.
  127.  
  128. To leave the editor, press ESC.  When you leave the editor you can press
  129. <ENTER> to save the file with the original file name, you can change the
  130. file name and then press <ENTER> or, you can press ESC a second time to
  131. leave without saving the file.
  132.  
  133.  
  134. LAYING OUT A HYPERTEXT DOCUMENT
  135.  
  136. In TextPro, information is broken up into units called messages.
  137. A message is a section of text that is made up of a label, the text
  138. of the message, and an ending. The label depends on the type of message.
  139. The ending is simply a line containing " /end ". There are two different
  140. types of messages; page and thread.
  141.  
  142. Page messages
  143.  
  144. Page messages are labeled with the name " /page" followed by the number
  145. of the page. For example the label for the first page would be "/page1".
  146. These messages are displayed sequentially to provide a context for your
  147. information.
  148.  
  149. The page messages should be formatted with a margin of 77. The length of
  150. the display window is 19 rows but longer messages will be automatically
  151. formatted so that PgUp and PgDn can be used.
  152.  
  153. Within a page message you can mark important concepts by enclosing
  154. the words with the symbols #m. These concepts are called hypertext
  155. threads. Each thread will be linked to another message which will
  156. be displayed when the reader selects the thread. Hypertext thread
  157. names can not be split onto two lines.
  158.  
  159. Thread messages
  160.  
  161. Thread messages are labeled with the character "/" followed by the
  162. name of the hypertext thread to which it's related. Thread messages
  163. are displayed only when the reader selects the hypertext thread in its
  164. label. Threaded messages should be formatted with a right margin of 65.
  165. To change the margin in the editor type ^OR. The length of the display
  166. window is 11 rows but longer messages will be automatically formatted
  167. so that PgUp and PgDn can be used. Threaded messages can contain other
  168. threaded messages.
  169.  
  170. Writing effective documents
  171.  
  172. It takes a little practice to get the knack of writing effectively
  173. using hypertext. Hypertext nodes in messages should be used to provide
  174. information that doesn't always need to be displayed with the message.
  175. Used in this fashion, hypertext helps to clarify text. There is still
  176. a linear flow to the text but the hypertext provides enhancements
  177. to the message.
  178.  
  179. The "/page" feature lets you give your document a backbone from which
  180. to deviate. When you first start experimenting you'll find that freeform
  181. documents with no plan quickly become confusing and overwhelm instead 
  182. of enlighten the hypertext reader.
  183.  
  184. Another important thing to keep in mind when using the computer as 
  185. a communication medium is the limitations of the display. Since we
  186. want to keep the system accessible to the widest possible variety
  187. of hardware configurations, the message area is limited to 77 columns
  188. by 19 rows. Messages longer than 19 rows are automatically formatted
  189. to be displayed a page at a time using PgUp and PgDn. However, long,
  190. dense messages on a computer screen are almost never read.
  191. It's better to keep each message short.
  192.  
  193. Since hypertext writing is in its infancy, there are no accepted guidelines
  194. we can give you to guarantee that your documents will be effective.
  195. One of the reasons we wrote TextPro is so many more people can experiment
  196. with these techniques and a style can begin to evolve.
  197.  
  198.  
  199. EXCHANGING TEXTPRO DOCUMENTS
  200.  
  201. Since all TextPro documents are ASCII files, they can be easily exchanged
  202. either on diskette or using electronic mail services. We hope you'll share
  203. TextPro with others and use it to experiment with many different types of
  204. documents.
  205.  
  206. TextPro can be copied freely and given to others. It may not be modified
  207. or used for commercial purposes.
  208.  
  209.  
  210.  
  211. We hope you enjoy TextPro,
  212.  
  213. The folks at Knowledge Garden
  214.  
  215.  
  216. For information on any of the other Knowledge Garden products call
  217. or write : Knowledge Garden
  218.            473A Malden Bridge Road
  219.            Nassau, NY 12123
  220.            Phone (518) 766-3000.
  221.  
  222. Reach us by EMAIL on BIX (JOIN GARDEN) or CompuServe (GO PCVEN, user op #8)
  223.  
  224.