home *** CD-ROM | disk | FTP | other *** search
/ Go64! / Go64_1998-01_1998_CSW_Side_B.d64 / hyperlink2.doc < prev    next >
Text File  |  2023-02-26  |  10KB  |  357 lines
  1. "HyperLink v2.0"
  2. (C)1997 by Myke Carter
  3.  
  4. For use with RAMLink.
  5. JiffyDOS is required.
  6. SuperCPU-64 is optional.
  7.  
  8. Supports C64 and C128 in 40-column,
  9. 80-column and C64 modes.
  10.  
  11. HyperLink v2.0 is NOT in the public
  12. domain.  The author of this program,
  13. Myke Carter, has chosen to keep the
  14. copyright of HyperLink v2.0, however,
  15. it may be freely distributed so long
  16. as it is distributed in its original,
  17. archived form and no profit is
  18. generated as a result of its
  19. distribution.
  20.  
  21. =======================================
  22.  
  23. HyperLink is a menu-driven utility
  24. which greatly simplifies the process of
  25. launching commonly used programs that
  26. are installed within CMD RAMLink
  27. mass-storage units.
  28.  
  29. It is suggested that RAMLinks be
  30. configured to autoboot HyperLink so
  31. that it is available to users at every
  32. powerup and following system resets.
  33.  
  34. Users of Nick Rossi's Novaterm
  35. telecommunications software can use
  36. HyperLink as a Novaterm utility
  37. module simply by renaming the main
  38. program as "nova.HyperLink".
  39.  
  40. =======================================
  41.  
  42. Using HyperLink is extremely easy.
  43. The cursor-down/up keys are used to
  44. navigate custom menus as designed by
  45. the user.  Pressing RETURN on a menu
  46. item launches the program associated
  47. with it.
  48.  
  49. Press (_) to exit HyperLink v2.0 and
  50. see a list of available RAMLink
  51. partitions.
  52.  
  53. Press (8) to exit HyperLink v2.0 and
  54. view the directory of the disk in disk
  55. drive device #8.  If device #8 is not
  56. online, no action will occur.
  57.  
  58. Press (9) to exit HyperLink v2.0 and
  59. view the directory of the disk in disk
  60. drive device #9.  If device #9 is not
  61. online, no action will occur.
  62.  
  63. C128 users may press the spacebar to
  64. exit to C64 mode, after which RAMLink
  65. will autoboot HyperLink again if
  66. pre-configured to do so.
  67.  
  68. =======================================
  69.  
  70. HyperLink v2.0 automatically checks
  71. to detect the presence of a CMD
  72. SuperCPU-64 accelerator and optimizes
  73. itself accordingly if such a detection
  74. is successful.
  75.  
  76. CMD's SuperCPU-128 is NOT supported by
  77. this particular version of HyperLink
  78. because the author doesn't have one
  79. yet.
  80.  
  81. HyperLink v2.0 supports CMD native mode
  82. subdirectories but does NOT support
  83. Commodore 1581 subpartitions.
  84.  
  85. =======================================
  86.  
  87. Two small programs are included with
  88. HyperLink v2.0 which have not been
  89. included with any previous version.
  90. Their filenames are "@" and "@@".
  91. These programs are useful for resetting
  92. the computer when the user has finished
  93. using a program that simply exits to
  94. the BASIC "READY" prompt instead of
  95. resetting the system, causing the
  96. RAMLink to autoboot HyperLink.  It is
  97. suggested that copies of these programs
  98. be placed within each partition and
  99. subdirectory so that system resets are
  100. easily achieved at any time simply by
  101. pressing ^@ (for C64 mode resets) or
  102.         ^@@ (for C128 mode resets).
  103.  
  104. C128 users need to be aware of the
  105. positions of their "40/80 DISPLAY" keys
  106. when using the "@@" reset program!
  107.  
  108. Thanks go out to Marvin Clapp of Broken
  109. Arrow, Oklahoma and the Tulsa Area
  110. Commodore Users Group for suggesting
  111. the use of these system reset programs.
  112.  
  113. =======================================
  114.  
  115. HyperLink users need to have at least
  116. a working knowledge of C64 BASIC 2.0
  117. and/or C128 BASIC 7.0 programming (or
  118. know somebody else who does) in order
  119. to use this powerful and convenient
  120. utility.
  121.  
  122. To create properly functioning
  123. HyperLink menus, users must add DATA
  124. statements to the main HyperLink v2.0
  125. program and/or its associated
  126. "template" version.
  127.  
  128. The only difference between the main
  129. program and the template version is the
  130. DATA statement in line 1040 which is
  131. useful for exiting back to a previous
  132. menu located within a network of menus.
  133.  
  134. Each DATA statement must contain eight
  135. elements, the first five of which must
  136. be text elements (contained within
  137. quotation marks).  The final three of
  138. must be integer elements (whole numbers
  139. not surrounded by quotation marks).
  140.  
  141. If HyperLink will not run after DATA
  142. statements have been entered and/or
  143. edited, it is most likely because one
  144. or more DATA statements has or have not
  145. been entered correctly.  Be certain
  146. that each DATA statement has exactly
  147. eight elements and that they are of the
  148. correct type and in the correct order.
  149.  
  150. =======================================
  151.  
  152. Example of a HyperLink DATA statement:
  153.  
  154. 1050 DATA "APPLICATIONS","^","7",
  155.      "APPS","APPSMENU",0,0,0
  156.  
  157. This statement would cause the word
  158. "APPLICATIONS" to appear in a HyperLink
  159. menu regardless of whether a C64 or a
  160. C128 (in any of its three operating
  161. modes) were being used.  If the
  162. menuname from this DATA statement were
  163. selected, HyperLink would load a BASIC
  164. program named "APPSMENU" located in
  165. subdirectory "APPS" of partition 7.  If
  166. a SuperCPU was present, this statement
  167. will not affect its mode of
  168. "turbo/normal" operation.  This
  169. statement also would not cause a
  170. special subroutine to be executed prior
  171. to launching the "APPS" program.
  172.  
  173. =======================================
  174.  
  175. 1. Each first DATA element, MENUNAME,
  176.    is displayed by HyperLink onscreen
  177.    as part of the menu seen by the
  178.    user.  Menunames are independent
  179.    entities and need not reflect the
  180.    names of the files with which they
  181.    are associated.  No menuname (for
  182.    40-column menus) should consist of
  183.    more than 34 characters else errors
  184.    will occur.  74 characters are
  185.    allowed for use with C128
  186.    80-column menus.
  187.  
  188. 2. Each second element, PRGTYPE,
  189.    indicates the type of the program
  190.    (i.e.  BASIC or ML) which is
  191.    associated with the current
  192.    menuname.  If the program is a BASIC
  193.    program, this element should be "^".
  194.    If the program is a machine language
  195.    program, this element should be "\".
  196.  
  197. 3. Each third element, PART#, is simply
  198.    the number of the RAMLink partition
  199.    in which the associated program is
  200.    located.
  201.  
  202. 4. Each fourth element, SUBDIR, should
  203.    be the name of the subdirectory
  204.    within which the associated program
  205.    is located.  If no subdirectory
  206.    specification is appropriate, use
  207.    the empty string (two adjacent
  208.    quotation marks) to fill this
  209.    position.
  210.  
  211. 5. Each fifth element, FILENAME, should
  212.    be the actual name of the file that
  213.    will be launched if and when its
  214.    associated menuname is selected.
  215.  
  216. 6. Each sixth element, SCPU, should be
  217.    either a 0 (zero) or a 1 (one).
  218.    These elements are integer elements.
  219.    DO NOT surround them with quotation
  220.    marks!  C64 programs that do NOT
  221.    work well or at all with SuperCPUs
  222.    running in turbo (i.e. 20MHz) mode
  223.    should have 1s placed in this
  224.    position.  Otherwise, 0s should be
  225.    used.
  226.  
  227.    If you do not own a SuperCPU or are
  228.    not certain as to whether you should
  229.    use a 0 or a 1 in these positions,
  230.    use 0s.  Programs which don't like
  231.    it will let you know soon enough.
  232.  
  233.    An easy way to remember which value
  234.    is appropriate for each mode is to
  235.    remember that 1 is used for 1MHz.
  236.  
  237. 7. Each seventh element, GOSUB, is used
  238.    by the ON/GOSUB statement located in
  239.    line 770 of the HyperLink program.
  240.    This value should always be 0 (zero)
  241.    unless special subroutines need to
  242.    be executed before a program is
  243.    launched.
  244.  
  245.    Two subroutines are already included
  246.    as part of HyperLink.  The first of
  247.    which is required for use with older
  248.    programs which only work with device
  249.    #8.  For such programs, this element
  250.    should be set to 1.
  251.  
  252.    The second subroutine is supplied
  253.    for users who like to use nova.Text
  254.    editor, the text editor supplied as
  255.    part of Nick Rossi's Novaterm
  256.    telecommunications software package.
  257.    It simply causes the computer to
  258.    switch to using the lowercase/
  259.    uppercase character set, and changes
  260.    the screen's background and border
  261.    colors to blue and the text colour
  262.    to white.
  263.  
  264.    If more subroutines are needed to
  265.    accommodate other programs,
  266.    HyperLink v2.0 may be easily
  267.    expanded by the user as needed.
  268.  
  269. 8. Each 8th element, MODE, is of value
  270.    most to C128 users.  HyperLink v2.0
  271.    uses the values in these positions
  272.    to determine whether or not a
  273.    menuname will appear in a menu
  274.    depending upon the mode in which the
  275.    computer is currently operating.
  276.    This allows single HyperLink menus
  277.    to service any or all of a C128's
  278.    three operating modes at any given
  279.    time.
  280.  
  281.    Use 64 in this position to cause a
  282.    menuname to appear only when
  283.    HyperLink is being used with a C64
  284.    or a C128 operating in C64 mode.
  285.  
  286.    Use 40 in this position to cause a
  287.    menuname to appear only when
  288.    HyperLink is being used with a C128
  289.    operating in 40-column mode.
  290.  
  291.    Use 80 in this position to cause a
  292.    menuname to appear only when
  293.    HyperLink is being used with a C128
  294.    operating in 80-column mode.
  295.  
  296.    Use 48 in this position to cause a
  297.    menuname to appear when HyperLink is
  298.    being used with a C128 operating in
  299.    either 40-column or 80-column modes.
  300.  
  301.    Use 0 in this position to cause a
  302.    menuname to always appear regardless
  303.    of whether a C128 is currently
  304.    operating in 40-column, 80-column or
  305.    C64 mode.  (C64 users may use 0
  306.    instead of 64 in this position, but
  307.    it is not advised.)
  308.  
  309. =======================================
  310.  
  311. IMPORTANT!
  312.  
  313. * No more than 18 menunames should be
  314.   included in any one HyperLink menu
  315.   else fatal errors will occur.  If
  316.   menus consisting of more than 18
  317.   entries need to be created, users
  318.   should use the HyperLink "TEMPLATE"
  319.   program to create a secondary submenu
  320.   file which can be launched by the
  321.   main menu.
  322.  
  323.   The "TEMPLATE" program includes a
  324.   special DATA statement which is not
  325.   part of the main HyperLink program.
  326.   This statement can be used as a link
  327.   to a previous menu.  Please be aware
  328.   that no PART# and/or SUBDIR has been
  329.   supplied in this particular DATA
  330.   statement!
  331.  
  332. * Line 130 reflects the current default
  333.   RAMLink device number.  If your
  334.   RAMLink is set to a device number
  335.   other than #16, you must modify this
  336.   line to match your particular
  337.   system's RAMLink device#
  338.   configuration.
  339.  
  340. =======================================
  341.  
  342. For help or additional information
  343.  
  344. regarding how to maximize the potential
  345. of this small but effective utility,
  346. send email to the author at
  347. mykec@delphi.com.  Delphi members need
  348. only send email to mykec.
  349.  
  350. Thank you for your interest in this
  351. nifty utility.  I hope you enjoy using
  352. it as much as I have and do.
  353.  
  354.                    Myke Carter
  355.                    7 December 1997
  356.  
  357.