home *** CD-ROM | disk | FTP | other *** search
/ Otherware / Otherware_1_SB_Development.iso / amiga / utility / text / htext.lzh / hypertext / Documentation / TextInfo < prev    next >
Encoding:
Text File  |  1990-12-24  |  6.6 KB  |  153 lines
  1. \help HT.help
  2. \title Text Formatting Commands
  3. \fgcolor 3
  4. \bgcolor 1
  5. \center
  6. \underline  TEXT FORMATTING COMMANDS  \underline
  7.  
  8. \format
  9.      When using \it HT \it to create your own documents, you should
  10. understand a few things about how to format your text, and how to get it to
  11. stand out nicely.
  12.  
  13. \center
  14. The available topics are:
  15.  
  16. \freeformat
  17. \indent 25
  18. \link { TextCommands UNDERLINE } Underlining text. \endlink
  19. \link { TextCommands ITALICS } Making Italic Text. \endlink
  20. \link { TextCommands BOLD } Bold Text. \endlink
  21. \link { TextCommands INDENT } Indenting text. \endlink
  22. \link { TextCommands CENTER } Centering text. \endlink
  23. \link { TextCommands FORMAT } Formatting text. \endlink
  24. \link { TextCommands FREEFORMAT } Turning formatting off. \endlink
  25.  
  26. \format
  27. \center
  28. \underline How HT views and works with text files \underline
  29.  
  30.     The first thing you should know about HT, is that it is designed to
  31. work \it with \it text files you \bol already \bold have.  The idea is that
  32. you shouldn't have to do anything special to use HT.  If you like, there
  33. are a wealth of options to aid in displaying your document, but you are not
  34. forced to use them.  Without doing a thing, you should be able to load
  35. almost any text file into HT.  The exception to this would be a text file
  36. which contains '\\' characters.  These files will still load, but HT will
  37. complain about unknown '\\' commands and may even produce strange text
  38. which has various text styles turned on (accidently).  For most files this
  39. is not a problem.
  40.  
  41.     If you wish, HT will do some formatting for you.  All you have to do is
  42. place a \bold \\FORMAT \BOLD command at the beginning of your text file.
  43. This instructs HT to format the text so that each line will be as full as
  44. possible for the window width.    The \BOLD '\\FORMAT'\BOLD command tends to
  45. be very useful when you have lots of other embedded commands and you don't
  46. like trying to guess where line breaks will fall.  HT fills up lines on a
  47. per paragraph basis.  That is to say, it won't keep pulling all of your
  48. text together into one giant filled column.  HT considers a paragraph to be
  49. any text up to a blank line.  For example, this paragraph has a blank line
  50. following it, and that signifies to stop filling this paragraph.
  51.  
  52.     Of course you may want to be able to switch between formatted text and
  53. untouched text.  For this there is the \BOLD \\FreeFormat \BOLD command.
  54. This command will turn off any formatting that was taking place.  The
  55. \\Format and \\Freeformat commands toggle between each other.  \\Format
  56. turns formatting \bold on \bold and \\Freeformat turns formatting \bold
  57. off.\bold   The \\Format command will stay in effect until a \\Freeformat
  58. command is encountered, and similarily for \\Freeformat.
  59.  
  60.     When writing your document, there really isn't much you have to keep in
  61. mind, except where you would like things to be \link { TextCommands \CENTER
  62. } centered,\endlink  \link { TextCommands \BOLD } bolded,\endlink  \link {
  63. TextCommands \UNDER } underlined,\endlink  or \link { TextCommands \INDENT
  64. } indented.\endlink
  65.  
  66.     The HT \\ commands are very straightforward.  The initial backslash
  67. is simply there to signify to HT that a command keyword is coming.  The
  68. specific keyword depends on what you would like HT to do.  For example, if
  69. you would like to \bold bold \bold some text, you would type the following
  70. into your document:
  71.  
  72. \center
  73. "The Amiga is \\bold Great.\\bold"
  74.  
  75. When displayed by \it HT, \it the word Great would appear in bold text.
  76. Like this:
  77.  
  78. \center
  79. "The Amiga is \bold Great.\bold"
  80.  
  81.  
  82.      The '\\' commands for style changes are pretty simple.  Where you
  83. would like a style change, you embed a '\\' command.  You put in one '\\'
  84. command to turn the effect on, and a second '\\' command to turn the effect
  85. off.  All HT keywords specify exactly it is you are doing.
  86.  
  87.      As another quick example, suppose you wanted some text to be
  88. italicized for emphasis.  All you have to do is type this:
  89.  
  90. \center
  91. Creating \\italic interactive information \\italic is pretty nifty!
  92.  
  93. Which of course gets displayed like this:
  94.  
  95. \center
  96. Creating \italic interactive information \italic is pretty nifty!
  97.  
  98.  
  99.      You can nest styles changes and a style change can be inside of a
  100. link - but be careful as some combinations may render the text nearly
  101. unreadable.  Oh, one other thing.  Text styles can continue across multiple
  102. lines (just in case you were wondering about that ;-), all you have to do
  103. is to make sure and end it somewhere.
  104.  
  105.  
  106. \center
  107. \ital Using ARexx and your favorite editor \ital
  108.  
  109.      Since you normally create documents with a text editor, and a large
  110. number of text editors support ARexx, I have provided several sets of
  111. macros to work with more popular text editors.    These macros save you the
  112. tedium of typing most of these commands.
  113.  
  114.      Using these ARexx macros with the text editor DME for example, you can
  115. simply type alt-b to automatically insert the \\bold keyword.  While that
  116. is relatively nice, the real power comes when you wish to define a link.
  117. You would simply press alt-s (for start link) at the position where you
  118. would like the link to start, keep typing or moving till you  are where you
  119. want the link to end and press alt-l.  Via the magic of ARexx, you will be
  120. presented with a "Link" requestor, which you can point and click in and
  121. instantly have your link defined and inserted.    In addition to that, there
  122. is a menu from which you can choose these same functions \bold and \bold
  123. you can test your current document in HT (saving it automagically) by
  124. choosing a menu option.
  125.  
  126.      The interface to other text editors varies depending on the degree of
  127. flexibility provided.  Each has its own advantages.  Chances are, the text
  128. editor you use is covered.  There are macros provided for two editors, one
  129. commercial - TxEd+, the other \ital FREE \ital - DME.  All you have to do
  130. to use these macros is to copy the necessary files for your editor into
  131. your REXX: directory, and fire up your text editor.  There may be an extra
  132. step depending on the specific editor, so it is best to look at the
  133. appropriate readme files for each editor.  \link { /dme/Readme } Click here
  134. if you use Dme.\endlink   \link { /txed/Readme } Click here if you use
  135. TxEd+.\Endlink
  136.  
  137.  
  138.  
  139. \underline Other Quickie things to know about text styles.\underline
  140.  
  141.     When using \it italics \it is usually best to leave a space after the
  142. word/phrase you want italicized, as if not, part of the last letter will
  143. get chopped off.  This is due to the way the Amiga renders text.
  144.  
  145.  
  146.  
  147. \UNDERLINE Final Notes \UNDERLINE
  148.  
  149. That pretty much covers a good overview of the formatting commands.  The
  150. file \Link { TextCommands } TextCommands\endlink  has \BOLD much \BOLD more
  151. detailed information about the individual commands and example usage.
  152.  
  153.