home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 January / macformat-020.iso / Shareware City / Applications / Alpha.5.96 folder / Help / HTML Help < prev    next >
Encoding:
Text File  |  1994-08-17  |  8.3 KB  |  227 lines  |  [TEXT/ALFA]
  1. ================================================================================
  2. = What's Going On Here?
  3. ================================================================================
  4.  
  5. HTML Mode (suffix ".html") is for editing HyperText Markup Language 
  6. documents.  It is not a previewer, nor is it a verifier.  If you don't 
  7. know about HTML or the WorldWideWeb, FTP to ftp.ncsa.mosaic.edu and 
  8. poke around in the Mosaic and Mac directories, or FTP to ftp.einet.net 
  9. and poke around in einet/mac/macweb, to start with.
  10.  
  11. This is not a complete tool for editing HTML 2.0.  There are several 
  12. features for which you are going to have to enter tags by hand.  
  13. However more are being added all the time, and I expect that it will 
  14. be a full HTML 2.0 tool by late in 1994 (this is a spare-time 
  15. project).
  16.  
  17. To have HTML mode loaded automatically, simply select Install:HTML 
  18. under Alpha's Utils menu.  This will place several commands at the 
  19. bottom of userStartup.tcl, the user customization file, in Alpha's top 
  20. directory.  That's all you need to do to .
  21.  
  22. When you use this package you will see bullet characters (•, 
  23. option-8) being dribbled near where you insert tags.  These are 
  24. supposed to be a feature, honest.  The tab key will take you to the 
  25. next one.  For example, if you insert a header, the cursor will be 
  26. inside the header tag, with a bullet after it.  Type in the header 
  27. text and hit tab to go to the bullet (and automatically delete the 
  28. bullet).  If you like, you may ignore the bullets and at any time 
  29. select "Remove Tab Marks" from the menu to eliminate all of them.  If 
  30. you never want these at all, turn off the flag htmlUseTabMarks (or set 
  31. it to 0 -- see the section on User-Settable Variables).
  32.     
  33. Without Peter Keleher's development and ongoing enhancements to Alpha 
  34. this wouldn't have been possible in the first place.  I am also 
  35. indebted to the authors of html.el for GNU Emacs and latex.tcl for 
  36. Alpha, from whom I originally took ideas and some tcl code.
  37.     
  38. I want feedback.  I'm Scott Brim <swb@nr-tech.cit.cornell.edu>.  This 
  39. is "opinionware" -- if you use it regularly, you should tell me your 
  40. opinion.
  41.     
  42.  
  43.  
  44. ================================================================================
  45. = User-Settable Flags and Variables
  46. ================================================================================
  47.  
  48. HTML mode is intended to be customizable.  You can modify its 
  49. behavior using the Flags menu (click on the little flag), or you can 
  50. initialize to your preferred defaults in userStartup.tcl (described 
  51. above).  If you initialize them in userStartup.tcl, be sure to set 
  52. them after sourcing html.tcl.
  53.     
  54. Alpha will add lines something like the following to userStartup.tcl 
  55. when you "install" HTML:
  56.  
  57.     # The following lines install the HyperText Markup Language Mode
  58.     source "Macintosh HD:Public:Alpha folder:Tcl:UserCode:html.tcl"
  59.     catch {htmlDummy}
  60.     enableMenuItem -m install HTML 0
  61.         
  62. After Alpha has done that, below them you can yourself add, for 
  63. example:
  64.  
  65.     set HTMLmodeVars(htmlUseLowerCase) 1
  66.     set HTMLmodeVars(htmlDLEntries) 5
  67.  
  68.     
  69. To set a flag *off*, set it to 0.  To set a flag *on*, set it to 1.  
  70. Variables can be set to any reasonable value.
  71.     
  72. FLAGS
  73. -----
  74.     
  75.     htmlUseCtlCmd        -    For use with international keyboards.  
  76.                             If 0, will use option-cmd and shift-option-cmd 
  77.                             in keybindings.  If 1, will use ctl-cmd and 
  78.                             shift-ctl-cmd.  This is to support use of the 
  79.                             international keyboard.  This area will probably 
  80.                             see some improvement in the future.  The default 
  81.                             is 0, i.e.  to use the US keyboard.
  82.                             
  83.     htmlCompactDiscLists -    If set, discursive lists will default to
  84.                             "compact" format and the alternate key binding
  85.                             will be set to create the more open form.  The
  86.                             default is 0, i.e. discursive lists will not be
  87.                             compact.
  88.                             
  89.     htmlUseLowerCase    -    if 0, tags will be like <P>; if 1, like <p>
  90.                             default: 0
  91.     
  92.     htmlUseHeadAndBody    -    if 0, "title" just generates <title></title>.  If 
  93.                             greater than 0, "title" will also generate <html>, 
  94.                             <head> and <body>.  The default is 0.
  95.                             
  96.     htmlUseTabMarks        -    if 0, will not insert the • characters.  The
  97.                             default is 1, to insert them.
  98.                             
  99. VARIABLES
  100. ---------
  101.  
  102.     htmlDLEntries        -    the default number of entries for a new discursive 
  103.                             list.  The default is 3.
  104.                             
  105.  
  106.                             
  107. ================================================================================
  108. = Default Key Bindings
  109. ================================================================================
  110.  
  111. This section assumes you are using all default options.
  112.  
  113. Almost all are on Option-Cmd, except for a few conflicts which I put 
  114. on Shift-Cmd-Option (note, if htmlUseCtlCmd is set, they will be on 
  115. Ctl-Cmd).  I have bound the ones which I *think* are used less often 
  116. on average.  Not everything is on keys, so explore the menus too.
  117.     
  118. Tabs are not supposed to be in HTML files, so, as in LaTeX, <tab> is 
  119. used to get to the next little "•" inserted by some of the commands.
  120.     
  121.         bind 0x30        nextTabStop        "HTML"
  122.         bind 0x30    <s> previousTabStop    "HTML"
  123.         
  124. Enter & cmd-opt-enter for new paragraph (c-o-enter leaves no space)
  125.     
  126.         bind Enter            htmlParagraph    "HTML"
  127.         bind Enter    <co>    htmlParaMark    "HTML"
  128.         
  129. Put new paragraph on control-M for those with awkward enter keys
  130.  
  131.         bind 'm'    <z>        htmlParaMark    "HTML"
  132.     
  133. Break on "!"
  134.     
  135.         bind '1'    <sco>    htmlBreak        "HTML"
  136.  
  137. Comment on cmd-opt-semicolon (shades of GNU Emacs)
  138.     
  139.         bind 0x29    <co> htmlComment    "HTML"
  140.         
  141. These should be obvious from the names...
  142.         
  143.         bind '0'    <co>    htmlTagTitle    "HTML"
  144.         bind '1'    <co>    htmlAddHeader1    "HTML"
  145.         bind '2'     <co>    htmlAddHeader2    "HTML"
  146.         bind '3'     <co>    htmlAddHeader3    "HTML"
  147.         bind '4'     <co>    htmlAddHeader4    "HTML"
  148.         bind '5'     <co>    htmlAddHeader5    "HTML"
  149.         bind '6'     <co>    htmlAddHeader6    "HTML"
  150.         
  151.         bind 'e'    <co>    htmlAddEmphasized    "HTML"
  152.         bind 's'    <co>    htmlAddStrong    "HTML"
  153.         bind 'b'    <co>    htmlAddBold        "HTML"
  154.         bind 'i'    <co>    htmlAddItalic    "HTML"
  155.         bind 'f'    <co>    htmlAddFixed    "HTML"
  156.         bind 'k'    <co>    htmlAddKeyboard    "HTML"
  157.         
  158. Note that "underlined" is in the menus but not in the key bindings.
  159.         
  160. These are UL, OL, MENU and DIR.  The first entry is set up 
  161. automatically in a new list.  The 'n' to add more entries is for 
  162. "eNtry".
  163.         
  164.         bind 'n'    <co>    htmlAddListEntry    "HTML"
  165.         bind 'u'    <co>    htmlAddUnnumbered    "HTML"
  166.         bind 'o'    <co>    htmlAddNumbered        "HTML"
  167.         bind 'm'    <co>    htmlAddMenu            "HTML"
  168.         bind 'd'    <co>    htmlAddDirectory    "HTML"
  169.         
  170. More self-explanatory (I hope) ones...
  171.         
  172.         bind 'p'    <co>    htmlAddPreformatted    "HTML"
  173.         bind 't'    <co>    htmlAddTitle    "HTML"
  174.         bind 'c'    <co>    htmlAddCite        "HTML"
  175.         bind 'c'    <sco>    htmlAddCode        "HTML"
  176.         bind 'q'    <co>    htmlAddBlockquote    "HTML"
  177.         bind 's'    <sco>    htmlAddSample    "HTML"
  178.         bind 'a'    <co>    htmlAddAddress    "HTML"
  179.         bind 'v'    <co>    htmlAddVarname    "HTML"
  180.         bind 'l'    <co>    htmlAddListing    "HTML"
  181.         bind 'x'    <co>    htmlAddXMP        "HTML"
  182.         
  183. <DL> Glossary (no space between entries, perhaps narrower <DT> 
  184. fields) and longer descriptions (space & width) are on G and g.  An 
  185. individual entry is "n" again but with a Shift modifier.
  186.     
  187.         bind 'n'    <sco>    htmlAddDescEntry    "HTML"
  188.         bind 'g'    <co>    htmlDescLong    "HTML"
  189.         bind 'g'    <sco>    htmlDescCompact    "HTML"
  190.         
  191. Anchor and Href: A "<" is something pointed at.  A ">" points to it.
  192.     
  193.         bind ','    <co>    htmlAddAnchor    "HTML"
  194.         bind '.'    <co>    htmlAddHref        "HTML"
  195.         
  196. An inline image, slightly off of ">".
  197.     
  198.         bind '/'    <co>    htmlAddImg    "HTML"
  199.         
  200. "<", ">" and "&" treated specially.  Shift inserts the character.
  201.     
  202.         bind ','    <s>        htmlLt    "HTML"
  203.         bind ','    <cso>    htmlLT    "HTML"
  204.         bind '.'    <s>        htmlGt    "HTML"
  205.         bind '.'    <cso>    htmlGT    "HTML"
  206.         bind '7'    <s>        htmlAmp    "HTML"
  207.         bind '7'    <cso>    htmlAMP    "HTML"
  208.  
  209.  
  210.  
  211. ================================================================================
  212. = Other Possible Key Bindings
  213. ================================================================================
  214.  
  215. These are not bound in the distribution.  They are included here as 
  216. samples of what is possible.  For example, if you are using an 
  217. international keyboard to produce German HTML, you might put these 
  218. lines in your userStartup.html:
  219.  
  220.     bind 0x27 <s>         {insertText "Ä\;"} "HTML"
  221.     bind 0x27             {insertText "ä\;"} "HTML"
  222.     bind 0x29 <s>         {insertText "Ö\;"} "HTML"
  223.     bind 0x29             {insertText "ö\;"} "HTML"
  224.     bind 0x21 <s>         {insertText "Ü\;"} "HTML"
  225.     bind 0x21             {insertText "ü\;"} "HTML"
  226.     bind 0x1b             {insertText "ß\;"} "HTML"
  227.