home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / htext.lzh / hypertext / Documentation / LinkInfo < prev    next >
Encoding:
Text File  |  1990-12-23  |  5.6 KB  |  138 lines
  1. \help Ht.help
  2. \title Commands for Linking Text
  3. \fgcolor 3
  4. \bgcolor 1
  5. \center
  6. \bold LINK COMMANDS \bold
  7. (the fun part)
  8.  
  9. \format
  10.     This part is where the real capability of HT lies.    (I'm telling the
  11. truth though :).  When you embed a link in a document, you are connecting
  12. the 'linked' text with another object.  As mentioned before, there are
  13. seven (7) types of links in HT.  These links cover everything from simply
  14. linking other text to linking animations or music, to words and phrases in
  15. the current text file.
  16.  
  17.     The link commands are based on a two part sequence.  You put the
  18. initial '\\' keyword to start defining a link.  You end the link with an
  19. \\EndLink keyword.  The text that falls between these two keywords is
  20. the linked text.  The linked text will be displayed in inverse video.  This
  21. is the only way linked text can be displayed, so whenever a user sees text
  22. in inverse video they \ital KNOW \ital it is a link.  You can embed style
  23. changes inside of a link command, but remember that the text is in inverse
  24. video, so things like \\bold may not work that great.
  25.  
  26. \center
  27. \underline The Seven Link Topics Are: \underline
  28.  
  29. \freeformat
  30. \indent 25
  31. \link { LinkCommands \LINK } Linking to other text.\endlink
  32. \link { LinkCommands \SHOW } IFF Picture Links. \endlink
  33. \link { LinkCommands \ANIM } Links to Animations. \endlink
  34. \link { LinkCommands \PLAY } Linking text to Music. \endlink
  35. \link { LinkCommands \SOUND } Sound sample links. \endlink
  36. \link { LinkCommands \AREXX } Arexx Links. \endlink
  37. \link { LinkCommands \REXX } Rexx Links. \endlink
  38. \format
  39.  
  40.    Just click on any of the above topics to find out more about it.
  41.  
  42.  
  43. \center
  44. \ul \bol Some General Information about Links:\ul \bold
  45.  
  46.     Link commands in \it HT \it are similar to other '\\' sequences.  They
  47. must be followed by a space, but can begin anywhere.  The link keywords
  48. also have a section enclosed by curly braces ({}'s) that denote information
  49. which is relevant to the keyword.  The text in the {}'s is \ital not \ital
  50. displayed.  The link ends when a \\Endlink command is encountered.  If you
  51. happen to use one of the ARexx compatible editors, you probably won't even
  52. have to type these commands by hand (see the file \link { editors.txt }
  53. editors.txt)\endlink  as there are several macros to make this process much
  54. easier.
  55.  
  56.  
  57.  
  58. \underline Other Questions about links:\underline
  59.  
  60.     When you specify you want a "link" between the current text and the
  61. link you have defined, what are you \ital really \ital doing?
  62.  
  63.     A link is a connection that you are setting up between text following
  64. the link keyword and the object specified in the link.    Lets explain more.
  65. When you embed a \\sound keyword in your document (followed shortly after
  66. by a \\endlink keyword), you are saying in effect : "Take the text between
  67. these two keywords and associate it with this sound".
  68.  
  69.     More than anything else, "links" in hyper-text/media are associations
  70. between different types of objects.  For example if you read a book and it
  71. says - \ital Refer to Figure 23.a \ital - it is really asking you to
  72. associate the text you are reading with Figure 23.a.  What you gain with
  73. hyper-text/media is access to several more types of objects and media.
  74.  
  75.  
  76.  
  77. \center
  78. \bold Linking to other programs: TECHIE INFO \bold
  79.  
  80.     Just quickly, you should know that any program run by HT will have a
  81. CON: device for both \ital input \ital and output.  The console device is
  82. opened for the program, and all standard I/O is through it.  This allows
  83. easy use of existing programs without worrying about how I/O will be done.
  84. However, programs that open their own windows will also have this extra
  85. window sitting around.    Eventually there will probably be an option to
  86. specify default I/O handles, but for now, you should be able to run just
  87. about any program with \\RUN keyword.
  88.  
  89.  
  90.  
  91. \UNDERLINE Other things to know about LINK keywords: \UNDERLINE
  92.  
  93.     Link keywords in HT (\\Link, \\Show, \\Rexx, etc.) are not case
  94. sensitive.  That is to say that \\Link, \\LINK, and \\liNK are all the
  95. same keyword to HT.
  96.  
  97.     The keywords that activate external programs to do their work (\\Show,
  98. \\Anim, \\Sound, and \\Play), require certain programs to exist somewhere
  99. on your system.  If you have not installed these files when you
  100. first installed HT, you can specify where they exist using the
  101. \link { HTConfig.doc } HTConfig\endlink  program.
  102.  
  103.  
  104. \UNDERLINE The keywords and the programs they require are:\UNDERLINE
  105.  
  106. \freeformat
  107. \\Anim        :   ShowAnim
  108. \\Show        :   Show
  109. \\Sound     :   Ssp
  110. \\Play        :   Play
  111.  
  112. \format
  113.     Since all of these programs are public domain/shareware, they are
  114. included here.    Of course if you have substitutes that you prefer to use,
  115. HT accomodates.  Simply use the HTConfig program to specify the name and
  116. location of the replacement program.  The HTConfig program writes a small
  117. (ASCII) text file that describes where the individual programs are located.
  118. HT will pick up the changes as soon as the configuration file has been
  119. written.
  120.  
  121.     If while using HT, you realize that it cannot find a file, run HTConfig
  122. and change the appropriate value to what is correct.  After you have saved
  123. the configuration, HT will notice the changes.    NOTE: If you have installed
  124. HT from the distribution disk, there should be no problem finding any
  125. files.    If you have a non-standard setup, then you may have to fiddle with
  126. the settings.
  127.  
  128.  
  129. \underline Finishing words. \underline
  130.  
  131.     That pretty much covers an overview of what goes on with links in your
  132. documents.  For more detailed information of each of the keywords, see the
  133. \link { LinkCommands } LinkCommands \endlink file.  Inside there you will
  134. find complete information on each command and working examples of how to
  135. create links of any type.
  136.  
  137.  
  138.