home *** CD-ROM | disk | FTP | other *** search
/ World of Shareware - Software Farm 2 / wosw_2.zip / wosw_2 / CPROG / FLEXLIST.ZIP / HYPERTXT.HTX < prev    next >
Text File  |  1989-07-28  |  6KB  |  226 lines
  1.         hypertxt.htx
  2.         Copyright  1989, John W. Small, All rights reserved
  3.         PSW / Power SoftWare, P.O. Box 10072
  4.         McLean, Virginia 22102 8072
  5.         (703) 759-3838
  6.         7/27/89
  7.  
  8. help
  9.         Copyright  1989, John W. Small, All rights reserved
  10.  
  11.  
  12.         A hypertext file is a text file partitioned into topics. topics
  13.  
  14.         Topics can have more than one page. pages
  15.  
  16.         A page may have highlighted text areas which are called
  17.         hyperlinks hlinks.  Hyperlinks are references to other topics.
  18.         Use the cursor movement keys to move between hyperlinks.
  19.  
  20.         Press <Enter> to select the topic associated with a hyperlink.
  21.         Press <Backspace> to return to the previous topic.
  22.         Press <ESC> to return directly to the root topic.
  23.         Press <ESC> again to exit program.
  24.         See also: keystoke summary keys
  25.  
  26.         The message line messline appearing at the bottom of the screen
  27.         displays the name of the current topic and hypertext file
  28.         at the left as well as the topic referenced by the current
  29.         hyperlink, if any, towards the right.
  30. topics
  31.  
  32.  
  33.  
  34.         A topic is any group of text that constitutes an idea.
  35.  
  36.         A hyperlink hlinks embedded in the text of a topic links that
  37.         topic to another topic.  With many hyperlinks a single
  38.         topic could be feasibly linked to many topics.
  39.  
  40.         A topic may comprise several pages. pages
  41.  
  42.         The name of the current topic is displayed at the start
  43.         of the message line messline followed immediately by a "|" and
  44.         the name of the hypertext file.
  45.  
  46.         See also: hypertext file format htformat
  47.  
  48.  
  49.  
  50.  
  51.         It is possible to move sequentially through the topics
  52.         of a hypertext file even though they may not be "hyperlinked."
  53.         Use <Ctrl Page Up> and <Ctrl Page Down> to move between
  54.         adjacent topics and <Ctrl Home> and <Ctrl End> to move to
  55.         the first and last topics of a hypertext file respectively.
  56.  
  57.         Use <Alt F3> to specify a topic by name.  Topic names are case
  58.         sensitive, which means upper and lower case letters must match
  59.         exactly in order to find the topic.
  60.  
  61.         Use <F3> to specify another hypertext file.
  62.  
  63.         See also: keystoke summary keys
  64.  
  65. pages
  66.  
  67.  
  68.  
  69.  
  70.         If a hypertext topic has more than one page the "PgUp/PgDn"
  71.         message will appear on the message line at the bottom of
  72.         the screen.
  73.  
  74.  
  75.         Use the <Page Down> key now to move to the second page
  76.         of this topic which is "pages."
  77.  
  78.  
  79.         <Backspace> will return you to the previous topic.
  80.  
  81.  
  82.         See also: keystoke summary keys
  83.  
  84.  
  85.  
  86.  
  87.  
  88.         Congratulations, you have arrived - that is at the second
  89.         page of the topic "pages."
  90.  
  91.  
  92.         <Page Up> will take you back to the first page of the
  93.         topic "pages."
  94.  
  95.  
  96.         Note that <Backspace> will return you to the previous topic
  97.         and not back to the first page of this topic!
  98.  
  99.  
  100. hlinks
  101.  
  102.  
  103.  
  104.         Hyperlinks are keyword phrases embedded in the text of a
  105.         topic. topics  This allows a topic to reference other topics
  106.         which expound on the keyword idea.   In a way, this is
  107.         like embedding the index of a book right into the text.
  108.  
  109.         A hyperlink can link to a topic in another hypertext file.
  110.         This allows hypertext files to be interrelated.
  111.  
  112.         A hyperlink may even link to an executable file or system
  113.         command!
  114.  
  115.         The message line messline reveals the associated "hyperlinked"
  116.         topic and/or file.
  117.  
  118.         See also: hypertext file format htformat
  119.  
  120. messline
  121.  
  122.  
  123.  
  124.         The message line appearing at the bottom of the screen
  125.         displays the current hypertext topic followed by a "|"
  126.         and a hypertext file name which in the case of this topic
  127.         is "messline|hypertxt.htx."  If this program were started
  128.         with a path name that path name will appear prefixed to
  129.         "hypertxt.htx."
  130.  
  131.         The current hyperlink hlinks, if any, is shown to the right.
  132.         If the hyperlink links to a topic topics in the current
  133.         hypertext file, only the topic is shown.  Otherwise the
  134.         topic is followed by a "|" and the name of the auxilary
  135.         hypertext file.
  136.  
  137.         If the link is to an executable file, the topic portion
  138.         will be missing with only the "|" and the name of the
  139.         executable file appearing.
  140.  
  141.         See also: hypertext file format htformat
  142.  
  143. keys
  144.  
  145.         <Enter>                select topic associated with current hyperlink
  146.  
  147.         <BackSpace>         return to previous topic
  148.  
  149.         <ESC>                return to root topic or exit
  150.  
  151.         Cursor keys &
  152.         Home/End            move between hyperlinks
  153.  
  154.         <Page Up>/
  155.         <Page Down>            move between pages of a topic
  156.  
  157.         <Ctrl PgUp>/
  158.         <Ctrl PgDn>/
  159.         <Ctrl Home>/
  160.         <Ctrl End>            move between topics
  161.  
  162.         <F1>                hypertext help
  163.  
  164.         <F3>                load new hypertext file
  165.  
  166.         <Alt F3>            specify new topic
  167. htformat
  168.  
  169.  
  170.         When viewing a hypertext file with a word processor the
  171.         topic and hyperlink formating characters become visible.
  172.  
  173.  
  174.         A topic topics is defined on a line by itself begining in column
  175.         one with a vertical tab character, <Ctrl K>, i.e.
  176.  
  177.         ^Ktopic
  178.  
  179.         The topic continues on until the next topic or a <Ctrl X>
  180.         in column one or the end of the file is reached.
  181.  
  182.         A topic can comprise multiple pages pages by having a line
  183.         containing only a vertical tab in column one to indicate
  184.         the page break, i.e.
  185.  
  186.         ^K
  187.  
  188.         It's up to the hypertext file to provide formating for
  189.         pages and lines.
  190.  
  191.  
  192.  
  193.  
  194.         A hyperlink hlinks appears as follows:
  195.  
  196.             ^E text  ^Ktopic^X
  197.  
  198.         <Ctrl E> introduces a hyperlink and <Ctrl X> ends it.
  199.         The <Ctrl K> separates the visible text from the name
  200.         of the "hyperlinked" topic.
  201.  
  202.  
  203.         If the topic resides in an auxilary hypertext file a "|"
  204.         followed by a file name is appended to topic, i.e.
  205.  
  206.             ^E text   ^Ktopic|filename^X
  207.  
  208.  
  209.         If the topic is missing than the file is executed as
  210.         a program:
  211.  
  212.             ^E text   ^K|filename^X
  213.  
  214.  
  215.  
  216.  
  217.  
  218.         From what you have learned from this topic you should be
  219.         able to use your word processor to create hypertext files
  220.         that can be read by this program.
  221.  
  222.         Start out by examining this help file with your word
  223.         processor, i.e.
  224.  
  225.             View:    hypertxt.htx |view hypertxt.htx
  226.