home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / htext.lzh / hypertext / TxEd / Readme < prev   
Encoding:
Text File  |  1990-12-23  |  3.5 KB  |  89 lines
  1. \format
  2.     This file contains documentation on several macros for use with the
  3. text editor TxEd+.  These macros will make it easier for you to write
  4. hypertext documents with TxEd+.  There are macros for inserting '\\'
  5. commands and testing out your current document.  The big macro is for
  6. creating links. The "link" macro will pop up a requestor which you can use
  7. to fill in and specify the type of link you want (more on this later).
  8.  
  9.     To use these macros, you should append the startup.txed file in the
  10. Rexx directory on this disk to your personal startup.txed file.  You
  11. will also have to copy over the '.txed' files in the Rexx directory to
  12. wherever your REXX: directory is.  You may want to check to make sure there
  13. are no conflicts with your personal setup (there shouldn't be, but just
  14. in case).
  15.  
  16.  
  17. \underline What exactly is there? \underline
  18.  
  19.     The are three main files.  The first, \ital startup.txed, \ital setups
  20. the environment.  It defines some \bold control-key \bold based macros and
  21. adds some menu items to the "User" menu.
  22.  
  23. \ital The control-key sequences are: \ital
  24.  
  25. Control-b     Turn bolding on/off
  26.  
  27. Control-i     Turn italics on/off
  28.  
  29. Control-u     Turn underlining on/off
  30.  
  31. Control-c     Center text
  32.  
  33. Control-d     Indent text
  34.  
  35. Control-f     Turn Formatting on
  36.  
  37. Control-r     Turn FreeFormatting on
  38.  
  39. Control-L     Define a link on current highlighted text
  40.  
  41.  
  42.     These macros will insert the appropriate '\\' commands directly into
  43. your document.    For example, to start bolded text you would press
  44. control-b, type your text, and press control-b again to turn bolding off.
  45. That is all that's required.  You won't see any special text styles on the
  46. screen, only the '\\' codes.  However when HT displays it, you will see the
  47. appropriate style.
  48.  
  49.  
  50. \underline Defining Links inside of TxEd \underline
  51.  
  52.     The Control-L macro will define a link.  You would highlight a section
  53. of text either using RightAmiga-B or the mouse (just like you would for a
  54. cut or copy operation).  Then press Control-L or choose "Link Block" from
  55. the User menu.    This will present you with a requestor which you can fill
  56. out. Click the type of link you would like, fill in the string gadget as
  57. needed and close the requestor.  The appropriate command will be inserted
  58. into your document.
  59.  
  60.     If you would like to get a quick file list, pressing the "File List"
  61. gadget will pop up an Arp File requestor which you can use to pick out a
  62. specific file name.  That file name will be inserted into the string gadget
  63. if you click "OK" on the file requestor.
  64.  
  65.     In addition, if you would like to verify that a link will work
  66. properly, you can use the "Preview" gadget to test the link.  Clicking the
  67. Preview gadget will cause the link you are defining to be executed.  This
  68. is convienent for making sure things work as expected.
  69.  
  70.  
  71. \underline Testing the current document. \underline
  72.  
  73.     You can then use the "Test File" option to see your document in HT.
  74. This command will save your file, and then instruct HT to load it directly
  75. in.  This works excellently for quickly writing and testing Hypertext
  76. documents.  In addition it saves your work for you, helping to prevent an
  77. accidental loss.
  78.  
  79.  
  80. \underline What else is there? \underline
  81.  
  82.     That about covers it for TxEd.  The macro coverage should be about
  83. 100%, but working from these examples, I'd imagine you could trivially add
  84. any new commands you wanted to.  Even adapting this to another editor is
  85. fairly easy.  You may also want to look at the interfaces to the other
  86. editors. Most of the features are fairly standard across each of the
  87. editors, but there are some subtleties (sp?) with each editor.
  88.  
  89.