home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 2 / RISC_DISC_2.iso / pd_share / apps / zap / HTMLKeys / ReadMe < prev   
Encoding:
Text File  |  1995-09-20  |  12.8 KB  |  456 lines

  1. <HTML>
  2. <HEAD>
  3.         <TITLE> Quick guide to HTML key bindings </TITLE>
  4. </HEAD>
  5.  
  6. <BODY>
  7.  
  8. <H1>The Zap HTML Keymap</H1>
  9.  
  10. <P>
  11. This is the <EM>All New HTML Keybindings for</EM> <STRONG>Zap</STRONG>! This
  12. keys file will revolutionise the way you work. Within 2 hours of starting to use
  13. this key map we promise you that you will no longer consider HTML coding to be
  14. a chore, <STRONG>or your money back</STRONG>! Yes! We guarentee you that you will soon
  15. find HTML creation more fun than a dirty weekend with Pamella Anderson!
  16. </P>
  17.  
  18. <P>
  19. Honest!
  20. </P>
  21.  
  22. <P>
  23. Well, OK; that's a <EM>slight</EM> exaggeration, but it <EM>does</EM> make
  24. some things easier. For instance, I knocked up this 12K of documentation in
  25. about 2 hours, and it's actually quite complex. Yes, really!
  26. </P>
  27.  
  28. <P>
  29. Anyway, here's the Contents page!
  30. </P>
  31.  
  32. <H2>The Contents Page</H2>
  33.  
  34. <H3 ALIGN="center">
  35. <A HREF="#Legal">The Legal Guff</A><BR>
  36.  
  37. <A HREF="#Install">Installation</A><BR>
  38.  
  39. <A HREF="#Overview">Overview</A><BR>
  40.  
  41. <A HREF="#KeyCut">Keycut Rundown</A><BR>
  42.  
  43. <A HREF="#Bugs">Known Bugs</A><BR>
  44.  
  45. </H3>
  46.  
  47.  
  48. <HR>
  49.  
  50. <A NAME="Legal">
  51. <H2>Legal Guff</H2>
  52. </A>
  53.  
  54. <P>
  55. Don't come running to me in the unlikely event that this keymap trashes
  56. your computer or harddisc, eats your dog, or invades Poland to start
  57. World War III.
  58. </P>
  59.  
  60. <P>
  61. This keymap and associated documentation is <EM>© Andrew Ward 1995</EM>
  62. and are released as Freeware into the Pubic Domain in the hope that some
  63. people will find it useful. Feel free to alter it to suit your tastes,
  64. though. Finally, <STRONG>don't even think about charging money for it!
  65. </STRONG> (PD libraries may charge enough to cover their costs though)
  66. </P>
  67.  
  68. <P>
  69. <EM>Distribute freely, though please don't separate the documentation from
  70. the Keys file</EM>
  71. </P>
  72.  
  73. <H3>Acknowledgment</H3>
  74.  
  75. <P>
  76. Thanks to Dom Symes firstly for the excellent <EM>Zap</EM> (withouut
  77. which I would be wasting my time now :-) and secondly for the default
  78. keymap which this HTML keymap is appended to.
  79. </P>
  80.  
  81. <HR>
  82.  
  83. <A NAME="Install">
  84. <H2>Installation</H2>
  85. </A>
  86.  
  87. <P>
  88. To install this keys file you must be one of two sorts of Zap user:
  89. </P>
  90.  
  91. <OL>
  92. <LI>You are the apprehensive/easy-to-please type and haven't altered the
  93. default <EM>Zap</EM> keymap. This is great, because all you have to do is
  94. drag this Keys file over the default Keys file inside the <EM>Zap</EM>
  95. application, and Bob's your uncle.
  96.  
  97. <LI>You are the stubborn, awkward type who has completely customised your keys
  98. file to your liking, so as to make optimum use of your 12 fingers and 3
  99. tenticles (commonly known as the <EM>vi</EM> bindings). You also have the
  100. alphabet mapped in such a way that everything you type is automatically
  101. ROT13'd. <BR>
  102. <P>
  103. In short you are a pain in the arse, and since you obviously know what you're
  104. doing I'll leave it up to you to <EM>munge</EM> the two keymaps together.
  105. </OL>
  106.  
  107. <HR>
  108. <A NAME="Overview">
  109. <H2>Overview</H2>
  110. </A>
  111.  
  112. This <EM>Zap</EM> keymap is for those of you who like to edit their HTML
  113. by hand, for whatever reason:
  114.  
  115. <UL>
  116. <LI> You haven't got <EM>Impression </EM> <STRONG>or</STRONG> don't want to give Ben
  117. Summers any money for his HTML loaders/savers.
  118. <LI> You don't want to line Andrew Rawnsley's pockets with 30 quid for <EM>!HTMLEdit</EM>.
  119. <LI> You get some perverse gratification from seeing < and > characters all
  120. over your screen.
  121. <LI> You actually need the power of editing HTML directly so you can add all those
  122. cheesey <EM>Netscape</EM> hacks that Acorn WYSIWYG editors don't support.
  123. <LI> Or you might even (<EM>Shock! Horror!</EM>) want to code some proper HTML3.
  124. <LI> In my case, it's all the above.
  125. </UL>
  126.  
  127. <P>
  128. Anyway, this <EM>Zap</EM> keys file takes some of the pain and tedium out
  129. of editing HTML by hand by providing a load of key shortcuts for some
  130. commonly typed tags. There are two new keymaps, for two different methods
  131. of document creation, though they are broadly similar.
  132. </P>
  133.  
  134. <H3>HTML Creation Map</H3>
  135.  
  136. <P>
  137. The first kemap is for creating HTML on a blank page, so that you can type the
  138. tags in on the fly, as and when you need to put them in your text. i.e Typing
  139. </P>
  140.  
  141. <P>
  142. <KBD>
  143. The best text editor for the <STRONG>[Ctrl-E] </STRONG> Acorn
  144. <STRONG>[Ctrl-Sh-E] </STRONG> range of computers is <STRONG>[Ctrl-S] </STRONG> Zap
  145. <STRONG>[Ctrl-Sh-S]</STRONG>.
  146. </KBD>
  147. </P>
  148.  
  149. <P>
  150. (Where <STRONG>[Ctrl-S]</STRONG> means pressing <EM>Control</EM> and the
  151. letter <EM>S</EM> simultaneously, and <STRONG>[Ctrl-Sh-S]</STRONG> means
  152. pressing <EM>Control, Shift</EM> and <EM>S</EM>
  153. simultaneously, <STRONG>stupid</STRONG>)
  154. </P>
  155.  
  156. <P>
  157. will produce HTML that looks like:<BR>
  158. </P>
  159.  
  160. <P>
  161. <CODE>
  162. The best text editor for the <EM>Acorn</EM> range of computers is
  163. <STRONG>Zap</STRONG>.
  164. </CODE>
  165. </P>
  166.  
  167. <P>
  168. Which would <EM>should</EM> hopefully get rendered as: <BR>
  169.  
  170. <P>
  171. The best text editor for the <EM>Acorn</EM> range of computers is <STRONG>Zap</STRONG>.
  172. </P>
  173.  
  174.  
  175. <H3>HTML Markup Map</H3>
  176.  
  177. <P>
  178. The second keymap is for marking up an existing text file. Basically you can highlight
  179. the region you want to apply the tag to and hit the keycut to put the HTML
  180. markers around it. For example, take the following pre-typed paragraph in Zap: <BR>
  181. </P>
  182.  
  183. <P>
  184. <CODE>
  185. I love my Acorn Computer. It's just so damn easy to use, and combined with
  186. the all-singing all-dancing editor, Zap, HTML editing is a breeze.
  187. </CODE>
  188.  
  189. <P>
  190. By high-lighting the words <EM>Acorn Computer</EM> and hitting
  191. <STRONG>[Ctrl-A] </STRONG> Zap will enclose the selection with
  192. <I><A HREF="http://"></I> and <I></A></I> so you get:<BR>
  193. </P>
  194.  
  195. <P>
  196. <CODE>
  197. I love my <A HREF="http://">Acorn Computer</A>. It's just so
  198. damn easy to use, and combined with the all singing all dancing editor,
  199. Zap, HTML editing is a breeze.
  200. </CODE>
  201. </P>
  202.  
  203. <P>
  204. Not only that, but it will <STRONG>also</STRONG> place the cursor after
  205. the '<EM>//</EM>' ready for you to type in the rest of the URL.
  206. </P>
  207.  
  208. <P>Simple, yeah! Anyway, enough of the waffle; here's the definitive listing
  209. of what keycuts do what.
  210. </P>
  211.  
  212. <HR>
  213.  
  214. <A NAME="Keycut">
  215. <H2>Keycut Rundown</H2>
  216. </A>
  217.  
  218. <P>
  219. I've tried to make the keys obvious, or at least attach the most used tags
  220. to the obvious keys, though some of this is pretty subjective. Feel free to
  221. hack it round if you want. I haven't been able to get all the baseline
  222. HTML2 tags allocated to keys, because I ran out of letters, and using Meta
  223. keypresses for entering 4 letter tags like <DT> is a waste of time
  224. IMO.
  225. </P>
  226.  
  227. <H3>Conventions</H3>
  228.  
  229. <P>
  230. I'm using the Zap Keys file convention of <STRONG>c</STRONG> for
  231. <EM>Control</EM> and <STRONG>s</STRONG> for <EM>Shift</EM> though I'll
  232. undoubtedly change my mind just to keep you on your toes.
  233. </P>
  234.  
  235. <H3>Non-HTML Keycuts common to both keymaps</H3>
  236.  
  237. <PRE>
  238.    Action                               Key
  239.  ============================================
  240.  
  241.  Change to HTML Creation Mode            c\
  242.  Change to HTML Markup Mode             cs\
  243.  Return to Default Keymap               Esc
  244.  Pass next key to default keymap         cQ
  245.  
  246.  Copy Selection                          cC
  247.  Cut Selection                           cX
  248.  Move Selection                          cM
  249.       (Sorry cV was already taken :)
  250.  Clear Selection                         cZ
  251.  Select Word at cursor                   cW
  252.  
  253. </PRE>
  254.  
  255. <H3>HTML related keys common to both maps</H3>
  256.  
  257. <DL>
  258.  
  259. <DT> <STRONG>Ctrl-Shift-7 (Ctrl-&)</STRONG>
  260. <DD> Inserts the escaped ampersand , <STRONG>&</STRONG> (&amp;)
  261.  
  262. <DT> <STRONG>Ctrl-Shift-9 (Ctrl-( )</STRONG>
  263. <DD> Inserts the escaped version of <STRONG><</STRONG> (&lt;)
  264.  
  265. <DT> <STRONG>Ctrl-Shift-0 (Ctrl-) )</STRONG>
  266. <DD> Inserts the escaped version of <STRONG>></STRONG> (&gt;)
  267.  
  268. <DT> <STRONG>Ctrl-Shift-C</STRONG>
  269. <DD> Inserts the <STRONG>©</STRONG> symbol (&#169;) Be aware that
  270. &copy; is a dreaded Netscapism, whereas &#169; is the agreed W3
  271. standard for the copyright symbol.
  272.  
  273. <DT> <STRONG>Ctrl-Shift-L</STRONG>
  274. <DD> Inserts the <STRONG>£</STRONG> sign. (&#163;)
  275.  
  276. </DL>
  277.  
  278. <H3>HTML keys for Creation Keymap </H3>
  279.  
  280. <P>
  281. Probably the best way to remember what keys do what is to fire up Zap
  282. and have a go. As mentioned above, <EM>Ctrl-\</EM> changes to the HTML
  283. creation keymap. So, do that then suck it and see.
  284. </P>
  285.  
  286. <H4>The Simple ones</H4>
  287.  
  288. <!-- My kingdom for Universal Tables support :-) -->
  289.  
  290. <PRE>
  291.     Key         Ctrl            Ctrl-Sh
  292.  ============================================
  293.  
  294.      A          <A HREF="         </A>
  295.      B          <B>               </B>
  296.      D          <DL>              </DL>
  297.      E          <EM>              </EM>
  298.      I          <I>               </I>
  299.      K          <KBD>             </KBD>
  300.      L          <LI>              Inserts a £ (&#163;)
  301.      N          <A NAME="         Easter Egg
  302.      O          <OL>              </OL>
  303.      P          <PRE>             </PRE>
  304.      R          <!--              --> (LET R = REM)
  305.      S          <STRONG>          </STRONG>
  306.      T          <TT>              </TT>
  307.      U          <UL>              </UL>
  308.      V          <VAR>             </VAR>
  309.  
  310.      1          <H1>              </H1>
  311.      2          <H2>              </H2>
  312.      ... 3-5 left as an exercise to the reader ...
  313.      6          <H6>              </H6>
  314.  
  315. </PRE>
  316.  
  317. <H4>The Less Simple ones</H4>
  318.  
  319. (The ones I couldn't fit in the table sensibly :-)
  320.  
  321. <DL>
  322.  
  323. <DT> <STRONG>Ctrl-F</STRONG>
  324. <DD> Inserts <CODE> <FORM METHOD="POST" ACTION=" </CODE>
  325.  
  326. <DT> <STRONG>Ctrl-Shift-F</STRONG>
  327. <DD> Inserts <CODE> </FORM> </CODE>
  328.  
  329. <DT> <STRONG>Ctrl-G</STRONG>
  330. <DD> Inserts an inline GIF as in : <CODE> <IMG SRC=".gif"> </CODE>
  331. and puts the cursor before the dot of <EM>.gif</EM> ready for you to type
  332. in the URL. Gosh! Aren't I kind saving you all those keypresses :-)<BR>
  333.  
  334. <P>
  335. <DD>In a perfect world this would be mapped to <EM>Ctrl-I</EM> but that's
  336. already pinched by <I> Besides G was unallocated, and the
  337. alternative was J ...
  338.  
  339. <DT> <STRONG>Ctrl-J</STRONG>
  340. <DD> Which nicely inserts an inline JPEG <EM>comme ça</EM> :<CODE> <IMG
  341. SRC=".jpg"> </CODE> and again conveniently places the cursor before the
  342. dot.
  343.  
  344. <DT> <STRONG>Ctrl-H</STRONG>
  345. <DD> Puts the basic HTML Header around a document. ie.
  346.  
  347. <PRE>
  348. <HTML>
  349. <HEAD>
  350. <TITLE> </TITLE>
  351. </HEAD>
  352. <P>
  353. <BODY>
  354.  
  355. <P>
  356. </BODY>
  357. </HTML>
  358. </PRE>
  359.  
  360. <DD>Any text previously on the page will be left between the <EM>BODY</EM> tags.
  361. Don't forget to put some text in for the <EM>TITLE</EM>. If you want to add
  362. your Netscape pretties to the <EM>BODY</EM> section do it yourself :-)
  363.  
  364. <DT> <STRONG>Ctrl-RETURN</STRONG>
  365. <DD> Puts in a line Break : <EM><BR></EM>
  366.  
  367. <DT> <STRONG>Shift-RETURN</STRONG>
  368. <DD> Inserts a paragraph break <EM>(sic)</EM> : <EM><P></EM>
  369.  
  370. <DT> <STRONG>Ctrl-Shift-RETURN</STRONG>
  371. <DD> Inserts the close paragraph tag : </P>
  372.  
  373. </DL>
  374.  
  375. OK! That's most of it out the way. Now for the Markup Section ...
  376.  
  377. <HR>
  378.  
  379. <H3>HTML keys for Creation Keymap</H3>
  380.  
  381.  
  382. <P>
  383. <STRONG><SPEECH TYPE="Jack Dee" Value="Sarcastic"></STRONG>
  384. </P>
  385.  
  386. <P>
  387. <EM>Oh... I can't do this!</EM>
  388. </P>
  389.  
  390. <P>
  391. <STRONG></SPEECH></STRONG>
  392. </P>
  393.  
  394. <P>
  395. Yep, I <EM>really</EM> can't be bothered to go through all the same stuff
  396. again going over the minor differences between the Creation and Markup
  397. maps! I've got better things to do :-) Basically, all the keys are mapped onto
  398. the same tags, except, when you apply a container tag, such as <EM> you
  399. <A NAME="NOSEL"> <STRONG>must</STRONG></A> have a selection highlighted.
  400. If you don't, you will find whatever you selected <STRONG>last</STRONG>
  401. slapped inbetween the container tags. This is because, what the macro does
  402. is a process of<BR>
  403. </P>
  404.  
  405. <OL>
  406. <LI>Cut Selection.
  407. <LI>Insert start tag.
  408. <LI>Paste back selection.
  409. <LI>Insert end tag.
  410. </OL>
  411.  
  412. <P>
  413. And if you didn't cut anything in step one you'll paste rubbish back. In short
  414. <STRONG>don't do it</STRONG>. If you need <EM>create</EM> HTML put yourself in
  415. Creation mode, and if you want to <EM>markup</EM> make sure you're in Markup mode.
  416. </P>
  417.  
  418. <P>
  419. Right, that's it! Simple yeah? If you want to change anything, feel free, though
  420. if you make any majorly useful changes I'd appreciate a copy. If you don't like
  421. your tags in capitals tough, 'cos I do!
  422. </P>
  423.  
  424. <HR>
  425.  
  426. <A NAME="Bugs">
  427. <H2>Known Bugs</H3>
  428. </A>
  429.  
  430. <UL>
  431. <LI>There appears to be a bug in Zap's redraw code that leaves behind a ghost cursor
  432. when a complex series of '<EM>INSERTs</EM>' are carried out. This is especially
  433. visible when using the <EM>[Ctrl-H]</EM> 'Header' keycut. Redrawing the window
  434. sorts it out.
  435.  
  436. <LI>Using the container tags in the markup mode without a selection. See
  437. <A HREF="#NOSEL">above</A>
  438. </UL>
  439.  
  440. <P>
  441. <EM>Everything else is <STRONG>your</STRONG> fault!</EM>
  442. </P>
  443.  
  444. <P>
  445. That'll be it then! Any problems, bugs (Ha!), requests, remunerations etc. to the
  446. <EM>Netscape enhanced</EM> email address below.
  447. </P>
  448.  
  449. <HR>
  450. <ADDRESS>
  451. <A HREF="mailto:andy@websvcs.demon.co.uk">andy@websvcs.demon.co.uk</A><BR>
  452. </ADDRESS>
  453.  
  454. </BODY>
  455. </HTML>
  456.