|
0
|
1 \input texinfo
|
|
20
|
2 @c
|
|
|
3 @c Please note that this file uses some constructs not supported by earlier
|
|
|
4 @c versions of TeXinfo. You must be running one of the newer TeXinfo
|
|
|
5 @c releases (I currently use version 3.9 from ftp://prep.ai.mit.edu/pub/gnu
|
|
|
6 @c
|
|
|
7 @c Please do not send in bug reports about not being able to format the
|
|
|
8 @c document with 'makeinfo' or 'tex', just upgrade your installation.
|
|
|
9 @c
|
|
|
10 @c Info formatted files are provided in the distribution, and you can
|
|
|
11 @c retrieve dvi, postscript, and PDF versions from the web site or ftp
|
|
|
12 @c site: http://www.cs.indiana.edu/elisp/w3/docs.html
|
|
|
13 @c
|
|
14
|
14 @setfilename w3.info
|
|
0
|
15 @settitle Emacs-W3 User's Manual
|
|
|
16 @iftex
|
|
|
17 @finalout
|
|
|
18 @end iftex
|
|
|
19 @c @setchapternewpage odd
|
|
|
20 @c @smallbook
|
|
|
21 @tex
|
|
|
22 \overfullrule=0pt
|
|
|
23 %\global\baselineskip 30pt % for printing in double space
|
|
|
24 @end tex
|
|
|
25 @synindex cp fn
|
|
|
26 @synindex vr fn
|
|
16
|
27 @dircategory World Wide Web
|
|
|
28 @dircategory GNU Emacs Lisp
|
|
|
29 @direntry
|
|
|
30 * W3: (w3). Emacs-W3 World Wide Web browser.
|
|
|
31 @end direntry
|
|
0
|
32 @ifinfo
|
|
|
33 This file documents the Emacs-W3 World Wide Web browser.
|
|
|
34
|
|
20
|
35 Copyright (C) 1993, 1994, 1995, 1996 William M. Perry
|
|
|
36 Copyright (C) 1996, 1997 Free Software Foundation
|
|
0
|
37
|
|
|
38 Permission is granted to make and distribute verbatim copies of
|
|
|
39 this manual provided the copyright notice and this permission notice
|
|
|
40 are preserved on all copies.
|
|
|
41
|
|
|
42 @ignore
|
|
|
43 Permission is granted to process this file through Tex and print the
|
|
|
44 results, provided the printed document carries copying permission
|
|
|
45 notice identical to this one except for the removal of this paragraph
|
|
|
46 (this paragraph not being relevant to the printed manual).
|
|
|
47
|
|
|
48 @end ignore
|
|
|
49 @end ifinfo
|
|
|
50 @c
|
|
|
51 @titlepage
|
|
|
52 @sp 6
|
|
|
53 @center @titlefont{Emacs-W3}
|
|
|
54 @center @titlefont{User's Manual}
|
|
|
55 @sp 4
|
|
2
|
56 @center Third Edition, Emacs-W3 Version 3.0
|
|
0
|
57 @sp 1
|
|
20
|
58 @center February 1997
|
|
0
|
59 @sp 5
|
|
|
60 @center William M. Perry
|
|
|
61 @center @i{wmperry@@cs.indiana.edu}
|
|
|
62 @page
|
|
|
63 @vskip 0pt plus 1filll
|
|
|
64 Copyright @copyright{} 1993, 1994, 1995 William M. Perry@*
|
|
20
|
65 Copyright @copyright{} 1996, 1997 Free Software Foundation
|
|
0
|
66
|
|
|
67 Permission is granted to make and distribute verbatim copies of@*
|
|
|
68 this manual provided the copyright notice and this permission notice@*
|
|
|
69 are preserved on all copies.
|
|
|
70
|
|
|
71 @end titlepage
|
|
|
72 @page
|
|
|
73 @ifinfo
|
|
20
|
74 @node Top, Getting Started,, (DIR)
|
|
|
75 Users can browse the World Wide Web from within Emacs by using Emacs-W3.
|
|
|
76 All of the widely used (and even some not very widely used) @sc{url}
|
|
|
77 schemes are supported, and it is very easy to add new methods as the
|
|
|
78 need arises.
|
|
|
79
|
|
|
80 Emacs-W3 provides some core functionality that can be readily re-used
|
|
|
81 from any program in Emacs. Users and other package writers are
|
|
|
82 encouraged to @i{Web-enable} their applications and daily work routines
|
|
|
83 with the library.
|
|
|
84
|
|
|
85 Emacs-W3 is completely customizable, both from Emacs-Lisp and from
|
|
|
86 stylesheets @xref{Style Sheets} If there is any aspect of Emacs-W3 that
|
|
|
87 cannot be modified to your satisfaction, please send mail to the
|
|
|
88 @t{w3-beta@@indiana.edu} mailing list with any suggestions.
|
|
|
89 @xref{Reporting Bugs}
|
|
0
|
90
|
|
|
91 @menu
|
|
14
|
92 * Getting Started:: Getting up and running with Emacs-W3
|
|
0
|
93 * Basic Usage:: Basic movement and usage of Emacs-W3.
|
|
|
94 * Compatibility:: Explanation of compatibility with
|
|
20
|
95 other browsers.
|
|
|
96 * Stylesheets:: How to control the look of web pages
|
|
|
97 * MIME Support:: Support for @sc{mime}
|
|
|
98 * Security:: Various security methods supported
|
|
0
|
99 * Non-Unix Operating Systems:: Special considerations necessary to get
|
|
|
100 up and running correctly under non-unix
|
|
|
101 OS's.
|
|
20
|
102 * Speech Integration:: Outputting to a speech synthesizer.
|
|
0
|
103 * Advanced Features:: Some of the more arcane features.
|
|
|
104 * More Help:: How to get more help---mailing lists,
|
|
|
105 newsgroups, etc.
|
|
|
106 * Future Directions:: Plans for future revisions
|
|
|
107
|
|
|
108 Appendices:
|
|
|
109 * Reporting Bugs:: How to report a bug in Emacs-W3
|
|
20
|
110 * Installing SSL:: Turning on @sc{ssl} support
|
|
0
|
111 * Mailcap Files:: An explanation of Mailcap files
|
|
|
112
|
|
|
113 Indices:
|
|
|
114 * General Index:: General Index
|
|
|
115 * Key Index:: Menus of command keys and their references
|
|
|
116 @end menu
|
|
|
117 @end ifinfo
|
|
|
118
|
|
20
|
119 @node Getting Started, Basic Usage, Top, Top
|
|
14
|
120 @chapter Getting Started
|
|
|
121 @cindex Clueless in Seattle
|
|
|
122 @cindex Getting Started
|
|
20
|
123 @kindex M-x w3
|
|
0
|
124 @vindex w3-default-homepage
|
|
20
|
125 @findex w3
|
|
|
126 If installed correctly, starting Emacs-W3 is quite painless. Just type
|
|
|
127 @kbd{M-x w3} in a running Emacs sessions. This will retrieve the
|
|
|
128 default page that has been configured - by default the documentation for
|
|
|
129 Emacs-W3 at Indiana University.
|
|
0
|
130
|
|
20
|
131 If the default page is not retrieved correctly at startup, you will have
|
|
|
132 to do some customization.
|
|
|
133
|
|
|
134 @menu
|
|
|
135 * Using the Network:: Tell Emacs about your network setup.
|
|
|
136 * Proxy Gateways:: Using an @sc{http} proxy
|
|
|
137 * Startup Files:: What is where, and why.
|
|
|
138 * Preferences Panel:: Quick configuration of common options.
|
|
|
139 @end menu
|
|
0
|
140
|
|
20
|
141 @node Using the Network, Proxy Gateways, Getting Started, Getting Started
|
|
|
142 @section Using the Network
|
|
|
143 By default, Emacs can support standard @sc{tcp}/@sc{ip} network
|
|
|
144 connections on almost all the platforms it runs on (Unix, @sc{vms},
|
|
|
145 Windows, etc). However, there are several situations where it is not
|
|
|
146 sufficient.
|
|
0
|
147
|
|
|
148 @table @b
|
|
|
149 @cindex Firewalls
|
|
20
|
150 @item Firewalls
|
|
|
151 It is becoming more and more common to be behind a firewall or some
|
|
|
152 other system that restricts your outbound network activity, especially
|
|
|
153 if you are like me and away from the wonderful world of academia.
|
|
|
154 Emacs-W3 has several different methods to get around firewalls (not to
|
|
|
155 worry though - none of them should get you in trouble with the local
|
|
|
156 @sc{mis} department.)
|
|
0
|
157
|
|
20
|
158 @item Emacs cannot resolve hostnames.
|
|
0
|
159 @cindex Faulty hostname resolvers
|
|
20
|
160 @cindex Broken SunOS libc
|
|
|
161 @cindex Hostname resolution
|
|
|
162 This happens quite often on SunOS workstations and some ULTRIX machines.
|
|
|
163 Some C libraries do not include the hostname resolver routines in their
|
|
|
164 static libraries. If Emacs was linked statically, and was not linked
|
|
|
165 with the resolver libraries, it wil not be able to get to any machines
|
|
0
|
166 off the local network. This is characterized by being able to reach
|
|
|
167 someplace with a raw ip number, but not its hostname
|
|
20
|
168 (@url{http://129.79.254.191/} works, but
|
|
|
169 @url{http://www.cs.indiana.edu/} doesn't).
|
|
|
170
|
|
|
171 The best solution for this problem is to recompile Emacs, making sure to
|
|
|
172 either link dynamically (if available on your operating system), or
|
|
|
173 include the @file{-lresolv}.
|
|
|
174
|
|
|
175 @cindex url-gateway-broken-resolution
|
|
|
176 If you do not have the disk space or the appropriate permissions to
|
|
|
177 recompile Emacs, another alternative is using the @file{nslookup}
|
|
|
178 program to do hostname resolution. To turn this on, set the variable
|
|
|
179 @code{url-gateway-broken-resolution} in your @file{~/.emacs} file. This
|
|
|
180 runs the program specified by @code{url-gateway-nslookup-program} (by
|
|
|
181 default "@code{nslookup}" to do hostname resolution. This program should
|
|
|
182 expect a single argument on the command line - the hostname to resolve,
|
|
|
183 and should produce output similar to the standard Unix @file{nslookup}
|
|
|
184 program:
|
|
0
|
185
|
|
20
|
186 @example
|
|
|
187 Name: www.cs.indiana.ed
|
|
|
188 Address: 129.79.254.191
|
|
|
189 @end example
|
|
0
|
190
|
|
20
|
191 @cindex @sc{term}
|
|
|
192 @item Using @sc{term} (or @sc{term}-like) Networking Software
|
|
|
193 @sc{term} @footnote{@sc{term} is a user-level protocol for emulating
|
|
|
194 @sc{ip} over a serial line. More information is available at
|
|
|
195 @url{ftp://sunsite.unc.edu/pub/Linux/apps/comm/term}} for slip-like
|
|
|
196 access to the internet.
|
|
|
197
|
|
|
198 @sc{note}: XEmacs and Emacs 19.22 or later have patches to enable native
|
|
|
199 @sc{term} networking. To enable it, @code{#define TERM} in the
|
|
|
200 appropriate s/*.h file for the operating system, then change the
|
|
|
201 @code{SYSTEM_LIBS} definition to include the @file{termnet} library that
|
|
|
202 comes with the latest versions of @sc{term}.
|
|
|
203
|
|
|
204 If you run into any problems with the native @sc{term} networking
|
|
|
205 support in Emacs or XEmacs, please let @t{wmperry@@cs.indiana.edu} know,
|
|
|
206 as he is responsible for the original support.
|
|
|
207 @end table
|
|
0
|
208
|
|
|
209 @vindex url-gateway-local-host-regexp
|
|
|
210 Emacs-W3 has support for using the gateway mechanism for certain
|
|
20
|
211 domains, and directly connecting to others. The variable
|
|
|
212 @code{url-gateway-local-host-regexp} controls this behaviour. This is a
|
|
|
213 regular expression @footnote{Please see the full Emacs distribution for
|
|
|
214 a description of regular expressions} that matches local hosts that do
|
|
|
215 not require the use of a gateway. If @code{nil}, then all connections
|
|
|
216 are made through the gateway.
|
|
0
|
217
|
|
|
218 @vindex url-gateway-method
|
|
20
|
219 Emacs-W3 supports several methods of getting around gateways. The
|
|
|
220 variable @code{url-gateway-method} controls which of these methods is
|
|
|
221 used. This variable can have several values (use these as symbol names,
|
|
|
222 not strings), ie: @samp{(setq url-gateway-method 'telnet)}. Possible
|
|
|
223 values are:
|
|
|
224
|
|
0
|
225 @table @dfn
|
|
20
|
226 @item telnet
|
|
|
227 Use this method if you must first telnet and log into a gateway host,
|
|
|
228 and then run telnet from that host to connect to outside machines.
|
|
|
229
|
|
|
230 :: WORK :: document telnet gw variables
|
|
|
231 This section needs more information, specifically documenting the
|
|
|
232 following variables. For now, please do @key{C-h v} on the variable for
|
|
|
233 more information.
|
|
|
234
|
|
|
235 @table @code
|
|
|
236 @item url-gateway-telnet-host
|
|
|
237 @item url-gateway-telnet-parameters
|
|
|
238 @item url-gateway-telnet-password-prompt
|
|
|
239 @item url-gateway-telnet-puser-name
|
|
|
240 @item url-gateway-prompt-pattern
|
|
|
241 @end table
|
|
|
242
|
|
|
243 @item rlogin
|
|
|
244 This method is identical to the @code{telnet} method, but uses
|
|
|
245 @file{rlogin} to log into the remote machine without having to send the
|
|
|
246 username and password over the wire every time.
|
|
|
247
|
|
|
248 :: WORK :: document rlogin gw variables
|
|
|
249 This section needs more information, specifically documenting the
|
|
|
250 following variables. For now, please do @key{C-h v} on the variable for
|
|
|
251 more information.
|
|
|
252
|
|
|
253 @table @code
|
|
|
254 @item url-gateway-rlogin-host
|
|
|
255 @item url-gateway-rlogin-parameters
|
|
|
256 @item url-gateway-rlogin-user-name
|
|
|
257 @item url-gateway-prompt-pattern
|
|
|
258 @end table
|
|
0
|
259
|
|
|
260 @item tcp
|
|
20
|
261 Masanobu UMEDA (@i{umerin@@mse.kyutech.ac.jp}) has written a very small
|
|
|
262 application that you can run in a subprocess to do the network
|
|
|
263 connections.
|
|
|
264
|
|
|
265 @item @sc{socks}
|
|
|
266 Use if the firewall has a @sc{socks} gateway running on it.
|
|
|
267
|
|
|
268 :: WORK :: document socks variables
|
|
|
269 This section needs more information, specifically documenting the
|
|
|
270 following variables. For now, please do @key{C-h v} on the variable for
|
|
|
271 more information.
|
|
|
272
|
|
|
273 @table @code
|
|
|
274 @item socks-host
|
|
|
275 @item socks-password
|
|
|
276 @item socks-username
|
|
|
277 @item socks-port
|
|
|
278 @item socks-timeout
|
|
0
|
279 @end table
|
|
20
|
280
|
|
|
281 @c @item ssl
|
|
|
282 @c This probably shouldn't be documented
|
|
|
283
|
|
|
284 @item native
|
|
|
285 This means that Emacs-W3 should use the builtin networking code of
|
|
|
286 Emacs. This should be used only if there is no firewall, or the Emacs
|
|
|
287 source has already been hacked to get around the firewall.
|
|
|
288 @end table
|
|
0
|
289
|
|
|
290 Emacs-W3 should now be able to get outside the local network. If none
|
|
|
291 of this makes sense, its probably my fault. Please check with the
|
|
|
292 network administrators to see if they have a program that does most of
|
|
|
293 this already, since somebody somewhere at the company has probably been
|
|
|
294 through something similar to this before, and would be much more
|
|
|
295 helpful/knowledgeable about the local setup than I would be. But feel
|
|
|
296 free to mail me as a last resort.
|
|
20
|
297 @node Proxy Gateways, Startup Files , Using the Network, Getting Started
|
|
0
|
298 @section Proxy Gateways
|
|
2
|
299 @vindex url-proxy-services
|
|
|
300 @cindex Proxy Servers
|
|
|
301 @cindex Proxies
|
|
|
302 @cindex Proxies, environment variables
|
|
|
303 @cindex HTTP Proxy
|
|
20
|
304
|
|
2
|
305 In late January 1993, Kevin Altis and Lou Montulli proposed and
|
|
|
306 implemented a new proxy service. This service requires the use of
|
|
|
307 environment variables to specify a gateway server/port # to send
|
|
20
|
308 protocol requests to. Each protocol (@sc{http}, @sc{wais}, gopher,
|
|
|
309 @sc{ftp}, etc.) can have a different gateway server. The environment
|
|
|
310 variables are @code{PROTOCOL}_proxy, where @code{PROTOCOL} is one of the
|
|
|
311 supported network protocols (gopher, file, @sc{http}, @sc{ftp}, etc.)
|
|
2
|
312
|
|
|
313 @cindex No Proxy
|
|
|
314 @cindex Proxies, exclusion lists
|
|
|
315 @vindex NO_PROXY
|
|
|
316 For companies with internal intranets, it will usually be helpful to
|
|
|
317 define a list of hosts that should be contacted directly, @b{not} sent
|
|
20
|
318 through the proxy. The @code{NO_PROXY} environment variable controls
|
|
2
|
319 what hosts are able to be contacted directly. This should be a comma
|
|
|
320 separated list of hostnames, domain names, or a mixture of both.
|
|
|
321 Asterisks can be used as a wildcard. For example:
|
|
0
|
322
|
|
2
|
323 @example
|
|
|
324 NO_PROXY=*.aventail.com,home.com,*.seanet.com
|
|
|
325 @end example
|
|
|
326
|
|
|
327 tells Emacs-W3 to contact all machines in the @b{aventail.com} and
|
|
|
328 @b{seanet.com} domains directly, as well as the machine named
|
|
|
329 @b{home.com}.
|
|
|
330
|
|
|
331 @vindex url-proxy-services
|
|
|
332 @cindex Proxies, setting from lisp
|
|
|
333 For those adventurous souls who enjoy writing regular expressions, all
|
|
|
334 the proxy settings can be manipulated from Emacs-Lisp. The variable
|
|
|
335 @code{url-proxy-services} controls this. This is an assoc list, keyed
|
|
20
|
336 on the protocol type (@sc{http}, gopher, etc) in all lowercase. The
|
|
|
337 @code{cdr} of each entry should be the fully-specified @sc{url} of the proxy
|
|
2
|
338 server to contact, or, in the case of the special "no_proxy" entry, a
|
|
|
339 regular expression that matches any hostnames that should be contacted
|
|
|
340 directly.
|
|
|
341
|
|
|
342 @example
|
|
|
343 (setq url-proxy-services '(("http" . "http://proxy.aventail.com/")
|
|
|
344 ("no_proxy" . "^.*\\(aventail\\|seanet\\)\.com")))
|
|
|
345 @end example
|
|
0
|
346
|
|
20
|
347 @node Startup Files, Preferences Panel, Proxy Gateways, Getting Started
|
|
|
348 @section Startup Files
|
|
|
349 @cindex Startup files
|
|
|
350 @cindex Default stylesheet
|
|
|
351 :: WORK :: startup files
|
|
|
352 This section should document where emacs-w3 looks for its startup files,
|
|
|
353 and what each one does. 'profile' 'stylesheet' 'hotlist' 'history' etc.
|
|
|
354
|
|
|
355 @node Preferences Panel, , Startup Files, Getting Started
|
|
|
356 @section Preferences Panel
|
|
|
357 @cindex Preferences
|
|
|
358 @kindex M-x w3-edit-preferences
|
|
|
359 :: WORK :: pref panel
|
|
|
360 This should document the quick preferences panel. M-x w3-edit-preferences
|
|
|
361
|
|
|
362 @node Basic Usage, Movement , Getting Started, Top
|
|
0
|
363 @chapter Basic Usage
|
|
20
|
364 @cindex Basic Usage
|
|
|
365 @kindex space
|
|
|
366 @kindex backspace
|
|
|
367 @kindex return
|
|
|
368 @kindex tab
|
|
|
369 @kindex M-tab
|
|
|
370 Emacs-W3 is similar to the Info package all Emacs users hold near and
|
|
|
371 dear to their hearts (@xref{Top,,Info,info, The Info Manual}, for a
|
|
|
372 description of Info). Basically, @kbd{space} and @kbd{backspace}
|
|
|
373 control scrolling, and @kbd{return} or the middle mouse button follows a
|
|
|
374 hypertext link. The @kbd{tab} and @kbd{Meta-tab} keys maneuver around the
|
|
|
375 various links on the page.
|
|
0
|
376
|
|
20
|
377 @b{NOTE:} Starting with Emacs-W3 3.0, form entry areas in a page can be
|
|
|
378 typed directly into. This is one of the main differences in navigation
|
|
|
379 from version 2.0. If you are used to using the @kbd{f} and @kbd{b} keys
|
|
|
380 to navigate around a buffer, I suggest training yourself to always use
|
|
|
381 @kbd{tab} and @kbd{M-tab} - it will save time and frustration on pages
|
|
|
382 with lots of form fields.
|
|
0
|
383
|
|
14
|
384 By default, hypertext links are surrounded by '[[' and ']]' on
|
|
|
385 non-graphic terminals (VT100, DOS window, etc.). On a graphics
|
|
20
|
386 terminal, the links are in shown in different colors.
|
|
|
387 @xref{Stylesheets} for information on how to change this.
|
|
0
|
388
|
|
|
389 There are approximately 50 keys bound to special Emacs-W3 functions.
|
|
|
390 The basic rule of thumb regarding keybindings in Emacs-W3 is that a
|
|
|
391 lowercase key takes an action on the @b{current document}, and an
|
|
|
392 uppercase key takes an action on the document pointed to by the
|
|
|
393 hypertext link @b{under the cursor}.
|
|
|
394
|
|
|
395 There are several areas that the keybindings fall into: movement,
|
|
|
396 information, action, and miscellaneous.
|
|
|
397
|
|
|
398 @ifinfo
|
|
|
399 @menu
|
|
20
|
400 * Movement:: Moving around in the buffer.
|
|
|
401 * Information:: Getting information about a document.
|
|
|
402 * Action:: Following links, printing, etc.
|
|
|
403 * Miscellaneous:: Everything else.
|
|
0
|
404 @end menu
|
|
|
405 @end ifinfo
|
|
|
406 @node Movement, Information, Basic Usage, Basic Usage
|
|
|
407 @section Movement
|
|
20
|
408 All the standard Emacs bindings for movement are still in effect, with a
|
|
|
409 few additions for convenience.
|
|
|
410
|
|
0
|
411 @table @kbd
|
|
20
|
412 @findex w3-scroll-up
|
|
|
413 @kindex space
|
|
|
414 @item space
|
|
0
|
415 Scroll downward in the buffer. With prefix arg, scroll down that many
|
|
|
416 screenfuls.
|
|
20
|
417 @kindex backspace
|
|
0
|
418 @findex scroll-down
|
|
20
|
419 @item backspace
|
|
0
|
420 Scroll upward in the buffer. With prefix arg, scroll up that many
|
|
|
421 screenfuls.
|
|
|
422 @kindex <
|
|
|
423 @findex w3-start-of-document
|
|
|
424 @item <
|
|
|
425 Goes to the start of document
|
|
|
426 @kindex >
|
|
|
427 @findex w3-end-of-document
|
|
|
428 @item >
|
|
|
429 Goes to the end of document
|
|
|
430 @kindex b
|
|
20
|
431 @kindex Meta-tab
|
|
|
432 @findex w3-widget-backward
|
|
|
433 @item Meta-tab, b
|
|
0
|
434 Attempts to move backward one link area in the current document.
|
|
|
435 Signals an error if no previous links are found.
|
|
20
|
436 @kindex f
|
|
|
437 @kindex tab
|
|
|
438 @kindex n
|
|
|
439 @findex w3-widget-forward
|
|
|
440 @item tab, f, n
|
|
|
441 Attempts to move forward one link area in the current document. Signals
|
|
|
442 an error if no more links are found.
|
|
|
443 @kindex B
|
|
|
444 @findex w3-backward-in-history
|
|
|
445 @item B
|
|
|
446 Move backwards in the history stack.
|
|
|
447 @kindex F
|
|
|
448 @findex w3-forward-in-history
|
|
|
449 @item F
|
|
|
450 Move forwards in the history stack.
|
|
|
451 @kindex l
|
|
|
452 @findex w3-goto-last-buffer
|
|
|
453 @item l
|
|
|
454 Return to the last buffer shown before this buffer.
|
|
|
455 @kindex q
|
|
|
456 @findex w3-quit
|
|
|
457 @item q
|
|
|
458 Kill this buffer.
|
|
|
459 @kindex Q, u
|
|
|
460 @findex w3-leave-buffer
|
|
|
461 Bury this buffer, but don't kill it
|
|
|
462 @end table
|
|
|
463
|
|
|
464 @node Information, Action, Movement, Basic Usage
|
|
|
465 @section Information
|
|
|
466 These functions relate information about one or more links on the
|
|
|
467 current document.
|
|
|
468
|
|
|
469 @table @kbd
|
|
|
470 @kindex v
|
|
|
471 @findex url-view-url
|
|
|
472 @item v
|
|
|
473 This shows the @sc{url} of the current document in the minibuffer.
|
|
|
474 @kindex V
|
|
|
475 @findex w3-view-this-url
|
|
|
476 @item V
|
|
|
477 This shows the @sc{url} of the hypertext link under point in the
|
|
|
478 minibuffer.
|
|
|
479 @kindex i
|
|
|
480 @findex w3-document-information
|
|
|
481 @item i
|
|
|
482 Shows miscellaneous information about the currently displayed document.
|
|
|
483 This includes the @sc{url}, the last modified date, @sc{mime} headers,
|
|
|
484 the @sc{http} response code, and any relationships to other documents.
|
|
|
485 Any security information is also displayed.
|
|
|
486 @kindex I
|
|
|
487 @findex w3-document-information-this-url
|
|
|
488 @item I
|
|
|
489 Shows information about the @sc{url} at point.
|
|
|
490 @kindex s
|
|
|
491 @findex w3-source-document
|
|
|
492 @item s
|
|
|
493 This shows the @sc{html} source of the current document in a separate buffer.
|
|
|
494 The buffer's name is based on the document's @sc{url}.
|
|
|
495 @kindex S
|
|
|
496 @findex w3-source-document-at-point
|
|
|
497 @item S
|
|
|
498 Shows the @sc{html} source of the hypertext link under point in a separate
|
|
|
499 buffer. The buffer's name is based on the document's @sc{url}.
|
|
|
500 @kindex k
|
|
|
501 @findex w3-save-url
|
|
|
502 @item k
|
|
|
503 This stores the current document's @sc{url} in the kill ring, and also in the
|
|
|
504 current window-system's clipboard, if possible.
|
|
|
505 @kindex K
|
|
|
506 @findex w3-save-this-url
|
|
|
507 @item K
|
|
|
508 Stores the @sc{url} of the document under point in the kill ring, and also in
|
|
|
509 the current window-system's clipboard, if possible.
|
|
|
510 @end table
|
|
|
511
|
|
|
512 @node Action, Miscellaneous, Information, Basic Usage
|
|
|
513 @section Action
|
|
|
514 First, here are the keys and functions that bring up a new hypertext
|
|
|
515 page, usually creating a new buffer.
|
|
|
516 @table @kbd
|
|
0
|
517 @kindex m
|
|
|
518 @findex w3-complete-link
|
|
|
519 @item m
|
|
|
520 Choose a link from the current buffer and follow it. A completing-read
|
|
|
521 is done on all the links, so @kbd{space} and @kbd{TAB} can be used for
|
|
|
522 completion.
|
|
|
523 @kindex return
|
|
|
524 @findex w3-follow-link
|
|
|
525 @item return
|
|
|
526 Pressing return when over a hyperlink attempts to follow the link
|
|
|
527 under the cursor. With a prefix argument (@kbd{C-u}), this forces the
|
|
|
528 file to be saved to disk instead of being passed off to other viewers
|
|
20
|
529 or being parsed as @sc{html}.
|
|
0
|
530
|
|
20
|
531 Pressing return when over a form input field can cause auto-submission
|
|
|
532 of the form. This is for Mosaic and Netscape compatibility. If there
|
|
|
533 is only one item in the form other than submit or reset buttons, then
|
|
|
534
|
|
0
|
535 minibuffer for the data to insert into the input field. Type checking
|
|
|
536 is done, and the data is only entered into the form when data of the
|
|
|
537 correct type is entered (ie: cannot enter 44 for 'date' field, etc).
|
|
|
538
|
|
|
539 @kindex Middle Mouse Button
|
|
|
540 @findex w3-follow-mouse
|
|
|
541 @item Middle Mouse Button
|
|
|
542 Attempt to follow a hypertext link under the mouse cursor. Clicking on
|
|
|
543 a form input field will prompt in the minibuffer for the data to insert
|
|
|
544 into the input field. Type checking is done, and the data is only
|
|
|
545 entered into the form when data of the correct type is entered (ie:
|
|
|
546 cannot enter 44 for 'date' field, etc).
|
|
|
547
|
|
|
548 @kindex Control Middle Mouse Button
|
|
|
549 @kindex Meta return
|
|
|
550 @findex w3-follow-inlined-image
|
|
|
551 @item Control Middle Mouse Button, Meta return
|
|
|
552 Tries to retrieve the inlined image that is under point. It ignores any
|
|
|
553 form entry areas or hyperlinks, and blindly follows any inlined image.
|
|
|
554 Useful for seeing images that are meant to be used as hyperlinks when
|
|
|
555 not on a terminal capable of displaying graphics.
|
|
|
556
|
|
|
557 @kindex p
|
|
|
558 @findex w3-print-this-url
|
|
|
559 @item p
|
|
|
560 Prints out the current buffer in a variety of formats, including
|
|
20
|
561 PostScript, @sc{html} source, or formatted text.
|
|
0
|
562 @kindex P
|
|
|
563 @findex w3-print-url-under-point
|
|
|
564 @item P
|
|
20
|
565 Prints out the @sc{url} under point in a variety of formats, including
|
|
|
566 PostScript, @sc{html} source, or formatted text.
|
|
0
|
567 @kindex m
|
|
|
568 @findex w3-complete-link
|
|
|
569 @item m
|
|
|
570 Selects a destination from a list of all the hyperlinks in the current
|
|
|
571 buffer. Use @kbd{space} and @kbd{tab} to complete on the links.
|
|
|
572
|
|
|
573 @kindex r
|
|
|
574 @kindex g
|
|
|
575 @findex w3-reload-document
|
|
|
576 @item r, g
|
|
|
577 Reloads the current document. The position within the buffer remains
|
|
|
578 the same (unless the document has changed since it was last retrieved,
|
|
|
579 in which case it should be relatively close). This causes an
|
|
|
580 unconditional reload from the remote server - the locally cached copy is
|
|
|
581 not consulted.
|
|
|
582 @kindex C-o
|
|
|
583 @findex w3-fetch
|
|
|
584 @item C-o
|
|
20
|
585 Prompts for a @sc{url} in the minibuffer, and attempts to fetch
|
|
0
|
586 it. If there are any errors, or Emacs-W3 cannot understand the type of link
|
|
|
587 requested, the errors are displayed in a hypertext buffer.
|
|
|
588 @kindex o
|
|
|
589 @findex w3-open-local
|
|
|
590 @vindex url-use-hypertext-dired
|
|
|
591 @item o
|
|
|
592 Opens a local file, interactively. This prompts for a local file name
|
|
|
593 to open. The file must exist, and may be a directory. If the requested
|
|
|
594 file is a directory and @code{url-use-hypertext-dired} is @code{nil},
|
|
|
595 then a dired-mode buffer is displayed. If non@code{nil}, then Emacs-W3
|
|
|
596 automatically generates a hypertext listing of the directory. The
|
|
|
597 hypertext mode is the default, so that all the keys and functions remain
|
|
|
598 the same.
|
|
|
599
|
|
|
600 @kindex M-s
|
|
|
601 @findex w3-search
|
|
|
602 @item M-s
|
|
|
603 Perform a search, if this is a searchable index. Searching requires a
|
|
|
604 server - Emacs-W3 can not do local file searching, as there are too many
|
|
|
605 possible types of searches people could want to do. Generally, the only
|
|
20
|
606 @sc{url} types that allow searching are @sc{http}, gopher, and X-EXEC.
|
|
0
|
607 @kindex Hv
|
|
|
608 @findex w3-show-history-list
|
|
|
609 @vindex w3-keep-history
|
|
|
610 @item Hv
|
|
|
611 If @code{url-keep-history} is non-@code{nil}, then Emacs-W3 keeps track
|
|
20
|
612 of all the @sc{url}s visited in an Emacs session. This function takes all
|
|
0
|
613 the links that are in that internal list, and formats them as hypertext
|
|
|
614 links in a list.
|
|
|
615 @end table
|
|
|
616
|
|
|
617 @cindex Buffer movement
|
|
|
618 And here are the commands to move around between Emacs-W3 buffers:
|
|
|
619
|
|
|
620 @table @kbd
|
|
|
621 @kindex l
|
|
|
622 @findex w3-goto-last-buffer
|
|
|
623 @item l
|
|
|
624 Goes to the last WWW buffer seen.
|
|
|
625 @kindex q
|
|
|
626 @findex w3-quit
|
|
|
627 @item q
|
|
|
628 Quits WWW mode. This kills the current buffer and goes to the most
|
|
|
629 recently visited buffer.
|
|
|
630 @kindex Q
|
|
|
631 @findex w3-leave-buffer
|
|
|
632 @item u
|
|
|
633 This is similar to w3-quit, but the buffer is not killed, it is moved to
|
|
|
634 the bottom of the buffer list (so it is the least likely to show up as
|
|
|
635 the default with switch-to-buffer). This is different from
|
|
|
636 @code{w3-goto-last-buffer} in that it does not return to the last WWW
|
|
|
637 page visited - it is the same as using @code{switch-to-buffer} - the
|
|
|
638 buffer left in the window is fairly random.
|
|
|
639 @kindex HB
|
|
|
640 @kindex B
|
|
|
641 @findex w3-backward-in-history
|
|
|
642 @item HB, B
|
|
|
643 Takes one step back along the path in the current history. Has no
|
|
|
644 effect if at the beginning of the session history.
|
|
|
645 @kindex HF
|
|
|
646 @kindex F
|
|
|
647 @findex w3-forward-in-history
|
|
|
648 @item HF, F
|
|
|
649 Takes one step forward along the path in the current history. Has no
|
|
|
650 effect if at the end of the session history.
|
|
|
651 @end table
|
|
|
652
|
|
|
653 @node Miscellaneous, , Action, Basic Usage
|
|
|
654 @section Miscellaneous
|
|
|
655 @table @kbd
|
|
|
656 @kindex M-m
|
|
|
657 @findex w3-mail-current-document
|
|
|
658 @item M-m
|
|
|
659 Mails the current document to someone. Choose from several different
|
|
20
|
660 formats to mail: formatted text, @sc{html} source, PostScript, or LaTeX source.
|
|
|
661 When the @sc{html} source is mailed, then an appropriate <base> tag is inserted
|
|
0
|
662 at the beginning of the document so that relative links may be followed
|
|
|
663 correctly by whoever receives the mail.
|
|
|
664 @kindex M-M
|
|
|
665 @findex w3-mail-document-under-point
|
|
|
666 @item M-M
|
|
|
667 Mails the document pointed to by the hypertext link under point to someone.
|
|
20
|
668 Choose from several different formats to mail: formatted text, @sc{html} source,
|
|
|
669 PostScript, or LaTeX source. When the @sc{html} source is mailed, then an
|
|
0
|
670 appropriate <base> tag is inserted at the beginning of the document so that
|
|
|
671 relative links may be followed correctly by whoever receives the
|
|
|
672 mail.
|
|
|
673 @kindex p
|
|
|
674 @findex w3-print-this-url
|
|
|
675 @item p
|
|
|
676 Prints the current document. Choose from several different formats to
|
|
20
|
677 print: formatted text, @sc{html} source, PostScript (with ps-print), or by using
|
|
0
|
678 LaTeX and dvips).
|
|
|
679
|
|
|
680 @findex lpr-buffer
|
|
|
681 @vindex lpr-command
|
|
|
682 @vindex lpr-switches
|
|
|
683 When the formatted text is printed, the normal @code{lpr-buffer} function
|
|
|
684 is called, and the variables @code{lpr-command} and @code{lpr-switches}
|
|
|
685 control how the document is printed.
|
|
|
686
|
|
20
|
687 When the @sc{html} source is printed, then an appropriate <base> tag is
|
|
0
|
688 inserted at the beginning of the document.
|
|
|
689 @vindex w3-print-commnad
|
|
|
690 @vindex w3-latex-docstyle
|
|
20
|
691 When postscript is printed, then the @sc{html} source of the document is
|
|
14
|
692 converted into LaTeX source. There are several variables controlling
|
|
|
693 what the final LaTeX document looks like.
|
|
|
694
|
|
|
695 :: WORK :: Document the new LaTeX backend
|
|
|
696
|
|
|
697 @table @code
|
|
|
698 @item w3-latex-use-latex2e
|
|
|
699 @vindex w3-latex-use-latex2e
|
|
|
700 If non-@code{nil}, configures the LaTeX engine to use the LaTeX2e
|
|
|
701 syntax. A @code{nil} value indicates that LaTeX 2.0.9 compabibility
|
|
|
702 will be used instead.
|
|
|
703 @item w3-latex-docstyle
|
|
|
704 @vindex w3-latex-docstyle
|
|
20
|
705 The document style to use when printing or mailing converted @sc{html} files
|
|
14
|
706 in LaTeX. Good defaults are: @{article@}, [psfig,twocolumn]@{article@},
|
|
|
707 etc.
|
|
|
708 @item w3-latex-packages
|
|
|
709 @vindex w3-latex-packages
|
|
|
710 List of LaTeX packages to include. Currently this is only used if
|
|
|
711 @code{w3-latex-use-latex2e} is non-@code{nil}.
|
|
|
712 @item w3-latex-use-maketitle
|
|
|
713 @vindex w3-latex-use-maketitle
|
|
|
714 If non-@code{nil}, the LaTeX engine will use real LaTeX title pages for
|
|
|
715 document titles.
|
|
|
716 @item w3-latex-print-links
|
|
|
717 @vindex w3-latex-print-links
|
|
20
|
718 If non-@code{nil}, prints the @sc{url}s of hypertext links as endnotes at the
|
|
|
719 end of the document. If set to @code{footnote}, prints the @sc{url}'s as
|
|
14
|
720 footnotes on each page.
|
|
|
721 @end table
|
|
|
722
|
|
0
|
723 @kindex P
|
|
|
724 @findex w3-print-url-under-point
|
|
|
725 @item P
|
|
|
726 Prints the document pointed to by the hypertext link under point.
|
|
|
727 Please see the previous item for more information.
|
|
|
728 @kindex M-x w3-insert-formatted-url
|
|
|
729 @findex w3-insert-formatted-url
|
|
|
730 @item M-x w3-insert-formatted-url
|
|
20
|
731 Insert a fully formatted @sc{html} link into another buffer. This gets the
|
|
|
732 name and @sc{url} of either the current buffer, or, with a prefix arg, of the
|
|
0
|
733 link under point, and construct the appropriate <a...>...</a> markup and
|
|
|
734 insert it into the desired buffer.
|
|
|
735 @kindex M-tab
|
|
|
736 @findex w3-insert-this-url
|
|
|
737 @item M-tab
|
|
20
|
738 Inserts the @sc{url} of the current document into another buffer. Buffer is
|
|
|
739 prompted for in the minibuffer. With prefix arg, uses the @sc{url} of the
|
|
0
|
740 link under point.
|
|
|
741 @kindex U
|
|
|
742 @findex w3-use-links
|
|
|
743 @item U
|
|
|
744 Selects one of the <LINK> tags from this document and fetch it. Links
|
|
|
745 are attributes of a specific document, and can tell such things as who
|
|
|
746 made the document, where a table of contents is located, etc.
|
|
|
747
|
|
|
748 Link tags specify relationships between documents in two ways. Normal
|
|
|
749 (forward) relationships (where the link has a REL="xxx" attribute), and
|
|
|
750 reverse relationships (where the link has a REV="xxx" attribute). This
|
|
|
751 first asks what type of link to follow (Normal or Reverse), then does
|
|
|
752 a @code{completing-read} on only the links that have that type of
|
|
|
753 relationship.
|
|
|
754 @end table
|
|
|
755
|
|
|
756 @node Compatibility, , , Top
|
|
|
757 @chapter Compatibility with other Browsers
|
|
|
758 Due to the popularity of several other browsers, Emacs-W3 offers an easy
|
|
|
759 transition to its much better way of life. This ranges from being able
|
|
|
760 to share the same preferences files and disk cache to actually emulating
|
|
|
761 the keybindings used in other browsers.
|
|
|
762
|
|
|
763 @ifinfo
|
|
|
764 @menu
|
|
|
765 * Emulation:: Emacs-W3 can emulate the keybindings and
|
|
|
766 other behaviours of other browsers.
|
|
|
767 * Hotlist Handling:: A hotlist is an easy way to keep track of
|
|
|
768 interesting Web pages without having to
|
|
|
769 remember the exact path to get there.
|
|
|
770 * Session History:: Keeping a history of documents visited
|
|
|
771 in one Emacs sessions allows the use of
|
|
|
772 'forward' and 'back' buttons easily.
|
|
|
773 * Global History:: Keeping a history of all the places ever
|
|
|
774 visited on the web.
|
|
|
775 @end menu
|
|
|
776 @end ifinfo
|
|
|
777 @node Emulation, Hotlist Handling, Compatibility, Compatibility
|
|
|
778 @section Emulation
|
|
|
779 @cindex Browser emulation
|
|
|
780 @cindex Emulation of other browsers
|
|
|
781 @cindex Netscape emulation
|
|
|
782 @cindex Lynx emulation
|
|
|
783 @findex turn-on-netscape-emulation
|
|
|
784 @findex turn-on-lynx-emulation
|
|
|
785 @findex w3-netscape-emulation-minor-mode
|
|
|
786 @findex w3-lynx-emulation-minor-mode
|
|
|
787 @vindex w3-mode-hook
|
|
14
|
788 :: WORK :: Document lynx emulation
|
|
20
|
789 @table @key
|
|
|
790 @item Down arrow
|
|
|
791 Highlight next topic
|
|
|
792 @item Up arrow
|
|
|
793 Highlight previous topic
|
|
|
794 @item Right arrow, Return, Enter
|
|
|
795 Jump to highlighted topic
|
|
|
796 @item Left arrow
|
|
|
797 Return to previous topic
|
|
|
798 @item +
|
|
|
799 Scroll down to next page (Page-Down)
|
|
|
800 @item -
|
|
|
801 Scroll up to previous page (Page-Up)
|
|
|
802 @item SPACE
|
|
|
803 Scroll down to next page (Page-Down)
|
|
|
804 @item b
|
|
|
805 Scroll up to previous page (Page-Up)
|
|
|
806 @item C-A
|
|
|
807 Go to first page of the current document (Home)
|
|
|
808 @item C-E
|
|
|
809 Go to last page of the current document (End)
|
|
|
810 @item C-B
|
|
|
811 Scroll up to previous page (Page-Up)
|
|
|
812 @item C-F
|
|
|
813 Scroll down to next page (Page-Down)
|
|
|
814 @item C-N
|
|
|
815 Go forward two lines in the current document
|
|
|
816 @item C-P
|
|
|
817 Go back two lines in the current document
|
|
|
818 @item )
|
|
|
819 Go forward half a page in the current document
|
|
|
820 @item (
|
|
|
821 Go back half a page in the current document
|
|
|
822 @item #
|
|
|
823 Go to Toolbar or Banner in the current document
|
|
|
824 @item ?, h
|
|
|
825 Help (this screen)
|
|
|
826 @item a
|
|
|
827 Add the current link to a bookmark file
|
|
|
828 @item c
|
|
|
829 Send a comment to the document owner
|
|
|
830 @item d
|
|
|
831 Download the current link
|
|
|
832 @item e
|
|
|
833 Edit the current file
|
|
|
834 @item g
|
|
|
835 Goto a user specified @sc{url} or file
|
|
|
836 @item i
|
|
|
837 Show an index of documents
|
|
|
838 @item j
|
|
|
839 Execute a jump operation
|
|
|
840 @item k
|
|
|
841 Show a list of key mappings
|
|
|
842 @item l
|
|
|
843 List references (links) in current document
|
|
|
844 @item m
|
|
|
845 Return to main screen
|
|
|
846 @item o
|
|
|
847 Set your options
|
|
|
848 @item p
|
|
|
849 Print the current document
|
|
|
850 @item q
|
|
|
851 Quit
|
|
|
852 @item /
|
|
|
853 Search for a string within the current document
|
|
|
854 @item s
|
|
|
855 Enter a search string for an external search
|
|
|
856 @item n
|
|
|
857 Go to the next search string
|
|
|
858 @item v
|
|
|
859 View a bookmark file
|
|
|
860 @item V
|
|
|
861 Go to the Visited Links Page
|
|
|
862 @item x
|
|
|
863 Force submission of form or link with no-cache
|
|
|
864 @item z
|
|
|
865 Cancel transfer in progress
|
|
|
866 @item [backspace]
|
|
|
867 Go to the history Page
|
|
|
868 @item =
|
|
|
869 Show file and link info
|
|
|
870 @item \
|
|
|
871 Toggle document source/rendered view
|
|
|
872 @item !
|
|
|
873 Spawn your default shell
|
|
|
874 @item *
|
|
|
875 Toggle image_links mode on and off
|
|
|
876 @item [
|
|
|
877 Toggle pseudo_inlines mode on and off
|
|
|
878 @item ]
|
|
|
879 Send an @sc{http} @sc{head} request for the current doc or link
|
|
|
880 @item C-R
|
|
|
881 Reload current file and refresh the screen
|
|
|
882 @item C-W
|
|
|
883 Refresh the screen
|
|
|
884 @item C-U
|
|
|
885 Erase input line
|
|
|
886 @item C-G
|
|
|
887 Cancel input or transfer
|
|
|
888 @item C-T
|
|
|
889 Toggle trace mode on and off
|
|
|
890 @item C-K
|
|
|
891 Invoke the Cookie Jar Page
|
|
|
892 @end table
|
|
|
893
|
|
14
|
894 :: WORK :: Document netscape emulation
|
|
20
|
895 Uh, turn this into pretty tables about what keys are emulated.
|
|
|
896
|
|
|
897 @example
|
|
|
898 (define-key w3-netscape-emulation-minor-mode-map "\M-s" 'w3-save-as)
|
|
|
899 (define-key w3-netscape-emulation-minor-mode-map "\M-m" 'w3-mailto)
|
|
|
900 (define-key w3-netscape-emulation-minor-mode-map "\M-n" 'make-frame)
|
|
|
901 (define-key w3-netscape-emulation-minor-mode-map "\M-l" 'w3-fetch)
|
|
|
902 (define-key w3-netscape-emulation-minor-mode-map "\M-o" 'w3-open-local)
|
|
|
903 (define-key w3-netscape-emulation-minor-mode-map "\M-p" 'w3-print-this-url)
|
|
|
904 (define-key w3-netscape-emulation-minor-mode-map "\M-q" 'w3-quit)
|
|
|
905 (define-key w3-netscape-emulation-minor-mode-map "\M-f" 'w3-search-forward)
|
|
|
906 (define-key w3-netscape-emulation-minor-mode-map "\M-g" 'w3-search-again)
|
|
|
907 (define-key w3-netscape-emulation-minor-mode-map "\M-r" 'w3-reload-document)
|
|
|
908 (define-key w3-netscape-emulation-minor-mode-map "\M-i" 'w3-load-delayed-images)
|
|
|
909 (define-key w3-netscape-emulation-minor-mode-map "\M-a" 'w3-hotlist-add-document)
|
|
|
910 (define-key w3-netscape-emulation-minor-mode-map "\M-b" 'w3-show-hotlist)
|
|
|
911 (define-key w3-netscape-emulation-minor-mode-map "\M-h" 'w3-show-history-list)
|
|
|
912
|
|
|
913 @end example
|
|
0
|
914
|
|
|
915 @node Hotlist Handling, Session History, Emulation, Compatibility
|
|
|
916 @section Hotlist Handling
|
|
|
917 :: WORK :: Document that it supports different types of hotlist formats
|
|
|
918 :: WORK :: Make sure everything hotlist related can be accessed via 'h'
|
|
|
919 In order to avoid having to traverse many documents to get to the same
|
|
|
920 document over and over, Emacs-W3 supports a ``hotlist'' like Mosaic. This is
|
|
20
|
921 a file that contains @sc{url}s and aliases. Hotlists allow quick access to any
|
|
0
|
922 document in the Web, providing it has been visited and added to the hotlist.
|
|
|
923 The variable @code{w3-hotlist-file} determines where this information
|
|
|
924 is saved. The structure of the file is compatible with Mosaic's
|
|
|
925 hotlist file, so this defaults to @file{~/.mosaic-hotlist-default}.
|
|
|
926
|
|
|
927 Hotlist commands are:
|
|
|
928 @table @kbd
|
|
|
929 @kindex hi
|
|
|
930 @findex w3-hotlist-add-document
|
|
|
931 @vindex w3-hotlist-file
|
|
|
932 @item a
|
|
|
933 Adds the current document to the hotlist, with the buffer name as its
|
|
|
934 identifier. Modifies the file specified by @code{w3-hotlist-file}. If
|
|
20
|
935 this is given a prefix-argument (via @kbd{C-u}), the title is prompted
|
|
|
936 for instead of automatically defaulting to the document title.
|
|
0
|
937
|
|
|
938 @findex w3-hotlist-refresh
|
|
|
939 @vindex w3-hotlist-file
|
|
|
940 @kindex hR
|
|
|
941 @item hR
|
|
|
942 This rereads the default hostlist file specified by
|
|
|
943 @code{w3-hotlist-file}.
|
|
|
944 @findex w3-hotlist-delete
|
|
|
945 @vindex w3-hotlist-file
|
|
|
946 @kindex hd
|
|
|
947 @item d
|
|
|
948 Prompts for the alias of the entry to kill. Pressing the spacebar or
|
|
|
949 tab will list out partial completions. The internal representation of
|
|
|
950 the hotlist and the file specified by @code{w3-hotlist-file} are
|
|
|
951 updated.
|
|
|
952 @item hr
|
|
|
953 @kindex hr
|
|
|
954 @findex w3-hotlist-rename-entry
|
|
|
955 @vindex w3-hotlist-file
|
|
|
956 Some hotlist item names can be very unwieldy (`Mosaic for X level 2 fill
|
|
|
957 out form support'), or uninformative (`Index of /'). Prompts for the
|
|
|
958 item to rename in the minibuffer---use the spacebar or tab key for
|
|
|
959 completion. After having chosen an item to rename, prompts for a new
|
|
|
960 title until a unique title is entered. Modifies the file specified by
|
|
|
961 @code{w3-hotlist-file}.
|
|
|
962
|
|
|
963 @item hu
|
|
|
964 @kindex hu
|
|
|
965 @findex w3-use-hotlist
|
|
|
966 Prompts for the alias to jump to. Pressing the @key{spacebar} or
|
|
|
967 @key{tab} key shows partial completions.
|
|
|
968
|
|
|
969 @item hv
|
|
|
970 @kindex hv
|
|
|
971 @findex w3-show-hotlist
|
|
20
|
972 Converts the hotlist into @sc{html} and displays it.
|
|
0
|
973 @item ha
|
|
|
974 @kindex ha
|
|
|
975 @findex w3-hotlist-apropos
|
|
|
976 Shows the hotlist entries matching a regular expression.
|
|
|
977 @item hA
|
|
|
978 @kindex hA
|
|
|
979 @findex w3-hotlist-append
|
|
|
980 Appends another hotlist file to the one currently in memory.
|
|
|
981 @end table
|
|
|
982 @node Session History, Global History, Hotlist Handling, Compatibility
|
|
|
983 @section History
|
|
|
984 @cindex History Lists
|
|
20
|
985 Almost all web browsers keep track of the @sc{url}s followed from a page, so
|
|
0
|
986 that it can provide @b{forward} and @b{back} buttons to keep a @i{path}
|
|
20
|
987 of @sc{url}s that can be traversed easily.
|
|
0
|
988 @vindex url-keep-history
|
|
|
989 If the variable @code{url-keep-history} is @code{t}, then Emacs-W3
|
|
20
|
990 keeps a list of all the @sc{url}s visited in a session.
|
|
0
|
991 @findex w3-show-history
|
|
|
992 To view a listing of the history for this session of Emacs-W3, use
|
|
|
993 @code{M-x w3-show-history} from any buffer, and Emacs-W3 generates an
|
|
20
|
994 @sc{html} document showing every @sc{url} visited since Emacs started (or
|
|
0
|
995 cleared the history list), and then format it. Any of the links can
|
|
|
996 be chosen and followed to the original document. To clear the history
|
|
|
997 list, choose 'Clear History' from the 'Options' menu.
|
|
|
998
|
|
|
999 @findex w3-forward-in-history
|
|
|
1000 @findex w3-backward-in-history
|
|
|
1001 @findex w3-fetch
|
|
|
1002 Another twist on the history list mechanism is the fact that all
|
|
20
|
1003 Emacs-W3 buffers remember what @sc{url}, buffer, and buffer position of the
|
|
0
|
1004 last document, and also keeps track of the next location jumped @b{to}
|
|
|
1005 from that buffer. This means that the user can go forwards and
|
|
|
1006 backwards very easily along the path taken to reach a particular
|
|
|
1007 document. To go forward, use the function @code{w3-forward-in-history},
|
|
|
1008 to go backward, use the function @code{w3-backward-in-history}.
|
|
|
1009
|
|
20
|
1010 @node Global History, , Session History, Compatibility
|
|
0
|
1011 @section Global History
|
|
|
1012 :: WORK :: Document that the global history can have diff. formats
|
|
20
|
1013 Most web browsers also support the idea of a ``history'' of @sc{url}s the
|
|
0
|
1014 user has visited, and it displays them in a different style than normal
|
|
20
|
1015 @sc{url}s.
|
|
0
|
1016
|
|
|
1017 @vindex url-keep-history
|
|
|
1018 @vindex url-global-history-file
|
|
|
1019 If the variable @code{url-keep-history} is @code{t}, then Emacs-W3
|
|
20
|
1020 keeps a list of all the @sc{url}s visited in a session. The file is
|
|
0
|
1021 automatically written to disk when exiting emacs. The list is added to
|
|
|
1022 those already in the file specified by @code{url-global-history-file},
|
|
|
1023 which defaults to @file{~/.mosaic-global-history}.
|
|
|
1024
|
|
20
|
1025 If any @sc{url} in the list is found in the file, it is not saved, but new
|
|
0
|
1026 ones are added at the end of the file.
|
|
|
1027
|
|
|
1028 The function that saves the global history list is smart enough to
|
|
|
1029 notice what style of history list is being used (Netscape, Emacs-W3, or
|
|
|
1030 XMosaic), and writes out the new additions appropriately.
|
|
|
1031
|
|
|
1032 @cindex Completion of URLs
|
|
|
1033 @cindex Usefulness of global history
|
|
|
1034 One of the nice things about keeping a global history files is that Emacs-W3
|
|
|
1035 can use it as a completion table. When doing @kbd{M-x w3-fetch}, pressing
|
|
|
1036 the @kbd{tab} or @kbd{space} key will show all completions for a
|
|
20
|
1037 partial @sc{url}. This is very useful, especially for very long @sc{url}s that
|
|
0
|
1038 are not in a hotlist, or for seeing all the pages from a particular web
|
|
|
1039 site before choosing which to retrieve.
|
|
|
1040
|
|
20
|
1041 @node Stylesheets, General Formatting, Top, Top
|
|
|
1042 @chapter Stylesheets
|
|
0
|
1043 @cindex Customizing formatting
|
|
|
1044 @cindex Specifying Fonts
|
|
|
1045 @cindex Fonts
|
|
20
|
1046 @cindex Stylesheets
|
|
0
|
1047 @cindex Colors
|
|
14
|
1048 How Emacs-W3 formats a document is very customizable. All control over
|
|
|
1049 formatting is now controlled by a default stylesheet set by the user
|
|
20
|
1050 with the @code{w3-default-stylesheet} variable.
|
|
0
|
1051
|
|
|
1052 The following sections describe in more detail how to change the
|
|
|
1053 formatting of a document.
|
|
|
1054
|
|
|
1055 @ifinfo
|
|
|
1056 @menu
|
|
|
1057 * General Formatting:: Changing general things about a
|
|
|
1058 document.
|
|
|
1059 * Character based terminals:: Changing how a document is
|
|
|
1060 displayed on a non-graphics
|
|
|
1061 terminal (vt100, etc.@:) or if
|
|
|
1062 @code{w3-delimit-emphasis} is @code{t}.
|
|
|
1063 * Graphics workstations:: Changing how a document is
|
|
|
1064 displayed on a graphics terminal
|
|
|
1065 (Xwindows, Windows, NeXTstep,
|
|
|
1066 OS/2, etc.)
|
|
|
1067 * Inlined images:: How to specify how Emacs-W3
|
|
|
1068 handles inlined images/mpegs.
|
|
|
1069 @end menu
|
|
|
1070 @end ifinfo
|
|
20
|
1071 @node General Formatting, Character based terminals, Stylesheets, Stylesheets
|
|
0
|
1072 @section General formatting conventions
|
|
|
1073 @iftex
|
|
|
1074 @heading Setting the fill column
|
|
|
1075 @end iftex
|
|
|
1076 @ifinfo
|
|
|
1077 @center --------------------
|
|
14
|
1078 @center Setting the right margin
|
|
0
|
1079 @center --------------------
|
|
|
1080 @end ifinfo
|
|
14
|
1081 @cindex Margins
|
|
0
|
1082 @vindex fill-column
|
|
|
1083 @vindex w3-right-border
|
|
14
|
1084 Each time a document is parsed, the right margin is recalculated
|
|
|
1085 using the width of the current window and @code{w3-right-border}.
|
|
0
|
1086 @code{w3-right-border} is an integer specifying how much room at the
|
|
|
1087 right edge of the screen to leave blank. The @code{fill-column} is set
|
|
|
1088 to @code{(- (window-width) @code{w3-right-border})}.
|
|
|
1089 @iftex
|
|
|
1090 @heading Formatting of directory listings
|
|
|
1091 @end iftex
|
|
|
1092 @ifinfo
|
|
|
1093 @center --------------------
|
|
|
1094 @center Formatting of directory listings
|
|
|
1095 @center --------------------
|
|
|
1096 @end ifinfo
|
|
|
1097 @vindex url-use-hypertext-dired
|
|
|
1098 When Emacs-W3 encounters a link to a directory (whether by local file access
|
|
20
|
1099 or via @sc{ftp}), it can either create an @sc{html} document on the fly, or use
|
|
0
|
1100 @code{dired-mode} to peruse the listing. The variable
|
|
|
1101 @code{url-use-hypertext-dired} controls this behavior.
|
|
|
1102
|
|
|
1103 If the value is @code{t}, Emacs-W3 uses @code{directory-files} to list them
|
|
|
1104 out and transform the directory into a hypertext document, then pass it
|
|
|
1105 through the parser like any other document.
|
|
|
1106
|
|
|
1107 If the value is @code{nil}, just pass the directory off to dired using
|
|
|
1108 @code{find-file}. Using this option loses all the hypertext abilities
|
|
|
1109 of Emacs-W3, and the users is unable to load documents in the directory
|
|
|
1110 directly into Emacs-W3 by clicking with the mouse, etc.
|
|
|
1111
|
|
|
1112 @iftex
|
|
|
1113 @heading Formatting of gopher directories
|
|
|
1114 @end iftex
|
|
|
1115 @ifinfo
|
|
|
1116 @center --------------------
|
|
|
1117 @center Formatting of gopher directories
|
|
|
1118 @center --------------------
|
|
|
1119 @end ifinfo
|
|
|
1120 @vindex w3-use-hypertext-gopher
|
|
|
1121 @cindex Gopher+
|
|
|
1122 @cindex ASK blocks
|
|
|
1123 There are two different ways of viewing gopher links. The built-in
|
|
20
|
1124 support that converts gopher directories into @sc{html}, or the
|
|
0
|
1125 @file{gopher.el} package by Scott Snyder (@i{snyder@@fnald0.fnal.gov}).
|
|
|
1126 The variable that controls this is @code{w3-use-hypertext-gopher}. If
|
|
|
1127 set to @code{nil}, then @file{gopher.el} is used. Any other value
|
|
|
1128 causes Emacs-W3 to use its internal gopher support. If using
|
|
|
1129 @file{gopher.el}, all the hypertext capabilities of Emacs-W3 are lost.
|
|
|
1130 All the functionality of @file{gopher.el} is now available in the
|
|
|
1131 hypertext version, and the hypertext version supports Gopher+ and ASK
|
|
|
1132 blocks.
|
|
|
1133
|
|
|
1134 @vindex w3-gopher-labels
|
|
|
1135 The main way to control the display of gopher directories is by the
|
|
|
1136 variable @code{w3-gopher-labels}. This variable controls the text that
|
|
|
1137 is inserted at the front of each item. This is an assoc list of gopher
|
|
|
1138 types (as one character strings), and a string to insert just after the
|
|
|
1139 list item. All the normal gopher types are defined. Entries should be
|
|
|
1140 similar to: @samp{("0" . "(TXT)")}. I have tried to keep all the tags
|
|
|
1141 to three characters plus two parentheses.
|
|
|
1142 @iftex
|
|
|
1143 @heading Creating a horizontal rule
|
|
|
1144 @end iftex
|
|
|
1145 @ifinfo
|
|
|
1146 @center --------------------
|
|
|
1147 @center Creating a horizontal rule
|
|
|
1148 @center --------------------
|
|
|
1149 @end ifinfo
|
|
|
1150 @vindex w3-horizontal-rule-char
|
|
20
|
1151 Horizontal rules (@b{<HR>} tags in @sc{html}[+]) are used to separate chunks
|
|
0
|
1152 of a document, and is meant to be rendered as a solid line across the
|
|
|
1153 page. Some terminals display characters differently, so the variable
|
|
14
|
1154 @code{w3-horizontal-rule-char} controls which character is used to draw
|
|
|
1155 a horizontal bar. This variable must be the ASCII value of the
|
|
|
1156 character, @b{not a string}. The variable is passed through
|
|
|
1157 @code{make-string} whenever a horizontal rule of a certain width is
|
|
|
1158 necessary.
|
|
0
|
1159
|
|
20
|
1160 @node Character based terminals, Graphics workstations, General Formatting, Stylesheets
|
|
0
|
1161 @section On character based terminals
|
|
|
1162 @vindex w3-delimit-emphasis
|
|
|
1163 On character based terminals, there is no easy way to show that a
|
|
|
1164 certain range of text is in bold or italics. If the variable
|
|
|
1165 @code{w3-delimit-emphasis} is non-@code{nil}, then Emacs-W3 can insert
|
|
20
|
1166 characters before and after character formatting commands in @sc{html}
|
|
0
|
1167 documents. The defaul value of @code{w3-delimit-emphasis} is
|
|
|
1168 automatically set based on the type of window system and version of
|
|
|
1169 Emacs being used.
|
|
|
1170
|
|
|
1171 @vindex w3-header-chars-assoc
|
|
|
1172 :: WORK ::
|
|
|
1173
|
|
|
1174 @findex w3-upcase-region
|
|
|
1175 @code{w3-header-chars-assoc} is an assoc list of header tags and a list
|
|
|
1176 of formatting instructions. The @code{car} of the list is the level of
|
|
|
1177 the header (1--6). The rest of the list should contain three items.
|
|
|
1178 The first item is text to insert before the header. The second item is
|
|
|
1179 text to insert after the header. Both should have reserved characters
|
|
20
|
1180 converted to their @sc{html}[+] entity definitions. The third item is a
|
|
0
|
1181 function to call on the area the header is in. This function is called
|
|
|
1182 with arguments specifying the start and ending character positions of
|
|
|
1183 the header. The starting point is always first. To convert a region to
|
|
|
1184 upper case, please use @code{w3-upcase-region} instead of
|
|
|
1185 @code{upcase-region}, so that entities are converted properly.
|
|
|
1186
|
|
20
|
1187 @node Graphics workstations, Inlined images, Character based terminals, Stylesheets
|
|
0
|
1188 @section With graphics workstations
|
|
|
1189 Starting with the first public release of version 2.3.0, all formatting
|
|
|
1190 is controlled by the use of stylesheets.
|
|
|
1191
|
|
|
1192 :: WORK :: Graphic workstation stuff - redo for stylesheets
|
|
|
1193
|
|
20
|
1194 @node Inlined images, , Graphics workstations, Stylesheets
|
|
0
|
1195 @cindex Inlined images
|
|
|
1196 @cindex Images
|
|
|
1197 @cindex Movies
|
|
|
1198 @cindex Inlined MPEGs
|
|
|
1199 @cindex MPEGs
|
|
|
1200 When running in Lucid Emacs 19.10 or XEmacs 19.11 and higher, Emacs-W3 can
|
|
|
1201 display inlined images and MPEG movies. There are several variables that
|
|
|
1202 control how and when the images are displayed.
|
|
|
1203
|
|
|
1204 @cindex Netpbm
|
|
|
1205 @cindex Pbmplus
|
|
|
1206 @vindex w3-graphic-converter-alist
|
|
|
1207 Since Lucid/XEmacs only natively understands XPixmaps and XBitmaps, GIFs
|
|
|
1208 and other image types must first be converted to one of these formats.
|
|
|
1209 To do this, the @b{netpbm utilities}@footnote{Available via anonymous
|
|
|
1210 ftp from ftp.x.org:/R5contrib/netpbm-1mar1994.tar.gz, and most large ftp
|
|
|
1211 sites.} programs are normally used. This is a suite of freeware image
|
|
|
1212 conversion tools. The variable @code{w3-graphic-converter-alist}
|
|
|
1213 controls how each image type is converted. This is an assoc list, keyed
|
|
20
|
1214 on the @sc{mime} content-type. The @code{car} is the content-type, and
|
|
|
1215 the @code{cdr} is a string suitable to pass to @code{format}. A %s in
|
|
|
1216 this string will be replaced with a converter from the ppm image format
|
|
|
1217 to an XPixmap (or XBitmap, if being run on a monochrome display). By
|
|
|
1218 default, the Emacs-W3 browser has converters for:
|
|
0
|
1219
|
|
|
1220 @enumerate
|
|
|
1221 @item
|
|
|
1222 image/x-xbitmap
|
|
|
1223 @item
|
|
|
1224 image/xbitmap
|
|
|
1225 @item
|
|
|
1226 image/xbm
|
|
|
1227 @item
|
|
|
1228 image/gif
|
|
|
1229 @item
|
|
|
1230 image/jpeg
|
|
|
1231 @item
|
|
|
1232 image/x-fax
|
|
|
1233 @item
|
|
|
1234 image/x-raster
|
|
|
1235 @item
|
|
|
1236 image/windowdump
|
|
|
1237 @item
|
|
|
1238 image/x-icon
|
|
|
1239 @item
|
|
|
1240 image/portable-graymap
|
|
|
1241 @item
|
|
|
1242 image/portable-pixmap
|
|
|
1243 @item
|
|
|
1244 image/x-pixmap
|
|
|
1245 @item
|
|
|
1246 image/x-xpixmap
|
|
|
1247 @item
|
|
|
1248 image/pict
|
|
|
1249 @item
|
|
|
1250 image/x-macpaint
|
|
|
1251 @item
|
|
|
1252 image/x-targa
|
|
|
1253 @item
|
|
|
1254 image/tiff
|
|
|
1255 @end enumerate
|
|
|
1256
|
|
|
1257 @vindex w3-color-max-blue
|
|
|
1258 @vindex w3-color-max-green
|
|
|
1259 @vindex w3-color-max-red
|
|
|
1260 @vindex w3-color-use-reducing
|
|
|
1261 @vindex w3-color-filter
|
|
|
1262 Since most displays are (sadly) not 24-bit, Emacs-W3 can automatically
|
|
|
1263 dither an image, so that it does not fill up the application' colormap too
|
|
|
1264 quickly. If @code{w3-color-use-reducing} is non-@code{nil}, then the
|
|
|
1265 images will use reduced colors. If @code{w3-color-filter} is @code{eq} to
|
|
|
1266 @code{'ppmquant}, then the ppmquant program will be used. If @code{eq} to
|
|
|
1267 @code{'ppmdither}, then the ppmdither program will be used. The ppmdither
|
|
|
1268 program tends to give better results. The values of
|
|
|
1269 @code{w3-color-max-red}, @code{w3-color-max-blue}, and
|
|
|
1270 @code{w3-color-max-green} control how many colors the inlined images can
|
|
|
1271 use. If using ppmquant, then the product of these three variables is used
|
|
|
1272 as the maximum number of colors per image. If using ppmdither, then only
|
|
|
1273 the set number of color cells can be allocated per image. See the man
|
|
|
1274 pages for ppmdither and ppmquant for more information on how the dithering
|
|
|
1275 is actually done. @code{w3-color-filter} may also be a string, specifying
|
|
|
1276 exactly what external filter to use. An example is: @samp{ppmquant -fs
|
|
|
1277 -map ~/pixmaps/colormap.ppm}.
|
|
|
1278
|
|
|
1279 @cindex MPEGs
|
|
|
1280 @cindex Inlined animations
|
|
|
1281 When running in XEmacs 19.11 or XEmacs 19.12, Emacs-W3 can insert an
|
|
|
1282 MPEG movie in the middle of a buffer.
|
|
|
1283
|
|
|
1284 :: WORK :: Need a pointer to the new EMBED Internet Draft ::
|
|
|
1285
|
|
|
1286 The basic syntax is:
|
|
|
1287 @example
|
|
|
1288 <embed href="somevideo.mpg" type="video/mpeg">
|
|
|
1289 @end example
|
|
|
1290
|
|
|
1291 @vindex w3-mpeg-args
|
|
|
1292 @vindex w3-mpeg-program
|
|
|
1293 This requires a special version of the standard @file{mpeg_play} mpeg
|
|
|
1294 player. Patches against the 2.0 version are available at
|
|
|
1295 ftp://ftp.cs.indiana.edu/pub/elisp/w3/mpeg_patch. The variable
|
|
|
1296 @code{w3-mpeg-program} should point to this executable, and
|
|
|
1297 @code{w3-mpeg-args} should be a list of any additional arguments to be
|
|
|
1298 passed to the player. By default, this includes @var{-loop}, so the
|
|
|
1299 mpeg plays continuously.
|
|
|
1300
|
|
|
1301 @cindex Delaying inlined images
|
|
|
1302 @cindex Delaying inlined animations
|
|
|
1303 @vindex w3-delay-image-loads
|
|
|
1304 @vindex w3-delay-mpeg-loads
|
|
|
1305 Because images and movies can take up an incredible amount of bandwidth,
|
|
|
1306 it is useful to be able to control whether they are loaded or not. By
|
|
|
1307 default, images and movies are loaded automatically, but the variables
|
|
|
1308 @code{w3-delay-image-loads} and @code{w3-delay-mpeg-loads} control this.
|
|
|
1309 If set to non-@code{nil}, then the images or movies are not
|
|
|
1310 loaded until explicitly requested by the user.
|
|
|
1311
|
|
|
1312 @cindex Loading delayed images
|
|
|
1313 @cindex Loading delayed movies
|
|
|
1314 @findex w3-load-delayed-images
|
|
|
1315 @findex w3-load-delayed-mpegs
|
|
|
1316 To load any delayed images, use the function
|
|
|
1317 @code{w3-load-delayed-images}. Its counterpart for delayed movies is
|
|
|
1318 @code{w3-load-delayed-mpegs}
|
|
|
1319
|
|
|
1320 @node MIME Support, Adding MIME types based on file extensions, , Top
|
|
|
1321 @chapter MIME Support
|
|
20
|
1322 @sc{mime} is an emerging standard for multimedia mail. It offers a very
|
|
0
|
1323 flexible typing mechanism. The type of a file or message is specified
|
|
|
1324 in two parts, separated by a '/'. The first part is the general
|
|
|
1325 category of the data (text, application, image, etc.). The second part
|
|
|
1326 is the specific type of data (postscript, gif, jpeg, etc.). So
|
|
20
|
1327 @samp{text/html} specifies an @sc{html} document, whereas
|
|
0
|
1328 @samp{image/x-xwindowdump} specifies an image of an Xwindow taken with
|
|
|
1329 the @file{xwd} program.
|
|
|
1330
|
|
|
1331
|
|
20
|
1332 This typing allows much more flexibility in naming files. @sc{http}/1.0
|
|
0
|
1333 servers can now send back content-type headers in response to a request,
|
|
20
|
1334 and not have the client second-guess it based on file extensions. @sc{html}
|
|
0
|
1335 files can now be named @file{something.gif} (not a great idea, but
|
|
|
1336 possible).
|
|
|
1337
|
|
|
1338 @ifinfo
|
|
|
1339 @menu
|
|
|
1340 * Adding MIME types based on file extensions:: How to map file
|
|
|
1341 extensions onto MIME
|
|
|
1342 types (e.g., @samp{.gif ->
|
|
|
1343 image/gif)}.
|
|
|
1344 * Specifying Viewers:: How to specify external and internal viewers
|
|
|
1345 for files that Emacs-W3 cannot handle natively.
|
|
|
1346 @end menu
|
|
|
1347 @end ifinfo
|
|
|
1348
|
|
|
1349 @node Adding MIME types based on file extensions, Specifying Viewers, MIME Support, MIME Support
|
|
|
1350 @section Adding MIME types based on file extensions
|
|
|
1351 @vindex mm-mime-extensions
|
|
|
1352 For some protocols however, it is still necessary to guess the content
|
|
|
1353 of a file based on the file extension. This type of guess-work should
|
|
20
|
1354 only be needed when accessing files via @sc{ftp}, local file access, or old
|
|
|
1355 @sc{http}/0.9 servers.
|
|
0
|
1356
|
|
|
1357 Instead of specifying how to view things twice, once based on
|
|
|
1358 content-type and once based on the file extension, it is easier to map
|
|
|
1359 file extensions to MIME content-types. The variable that controls this
|
|
|
1360 is @code{mm-mime-extensions}.
|
|
|
1361
|
|
|
1362 This variable is an assoc list of file extensions and the corresponding
|
|
|
1363 MIME content-type. A sample entry looks like: @samp{(".movie"
|
|
|
1364 . "video/x-sgi-movie")} This makes all files that end in @file{.movie}
|
|
|
1365 (@file{foo.movie} and @file{bar.movie}) be interpreted as SGI animation
|
|
|
1366 files. If a content-type is defined for the document, then this is
|
|
|
1367 over-ridden. Regular expressions can @b{NOT} be used.
|
|
|
1368
|
|
|
1369 @cindex mime-types file
|
|
|
1370 @findex mm-parse-mimetypes
|
|
20
|
1371 Both Mosaic and the NCSA @sc{http} daemon rely on a separate file for mapping
|
|
0
|
1372 file extensions to MIME types. Instead of having the users of Emacs-W3
|
|
|
1373 duplicate this in lisp, this file can be parsed using the
|
|
|
1374 @code{url-parse-mimetypes} function. This function is called each time
|
|
|
1375 w3 is loaded. It tries to locate mimetype files in several places. If
|
|
|
1376 the environment variable @code{MIMETYPES} is nonempty, then this is
|
|
|
1377 assumed to specify a UNIX-like path of mimetype files (this is a colon
|
|
|
1378 separated string of pathnames). If the @code{MIMETYPES} environment
|
|
|
1379 variable is empty, then Emacs-W3 looks for these files:
|
|
|
1380
|
|
|
1381 @enumerate
|
|
|
1382 @item
|
|
|
1383 @file{~/.mime-types}
|
|
|
1384 @item
|
|
|
1385 @file{/etc/mime-types}
|
|
|
1386 @item
|
|
|
1387 @file{/usr/etc/mime-types}
|
|
|
1388 @item
|
|
|
1389 @file{/usr/local/etc/mime-types}
|
|
|
1390 @item
|
|
|
1391 @file{/usr/local/www/conf/mime-types}
|
|
|
1392 @end enumerate
|
|
|
1393
|
|
20
|
1394 Each line contains information for one @sc{http} type. These types resemble
|
|
0
|
1395 MIME types. To add new ones, use subtypes beginning with x-, such as
|
|
|
1396 application/x-myprogram. Lines beginning with # are comment lines, and
|
|
|
1397 suitably ignored. Each line consists of:
|
|
|
1398
|
|
|
1399 type/subtype ext1 ext2 ... ext@var{n}
|
|
|
1400
|
|
|
1401 type/subtype is the MIME-like type of the document. ext* is any number
|
|
|
1402 of space-separated filename extensions which correspond to the MIME
|
|
|
1403 type.
|
|
|
1404
|
|
|
1405 @node Specifying Viewers, ,Adding MIME types based on file extensions, MIME Support
|
|
|
1406 @section Specifying Viewers
|
|
20
|
1407 Not all files look as they should when parsed as an @sc{html} document
|
|
0
|
1408 (whitespace is stripped, paragraphs are reformatted, and lots of little
|
|
|
1409 changes that make the document look unrecognizable). Files may be
|
|
|
1410 passed to external programs or Emacs Lisp functions to be viewed.
|
|
|
1411
|
|
|
1412 Not all files can be viewed accurately from within an Emacs session (GIF
|
|
|
1413 files for example, or audio files). For this reason, the user can
|
|
|
1414 specify file "viewers" based on MIME content-types. This is done with
|
|
|
1415 a standard mailcap file. @xref{Mailcap Files}
|
|
|
1416
|
|
|
1417 @findex mm-add-mailcap-entry
|
|
|
1418 As an alternative, the function @code{mm-add-mailcap-entry} can also be
|
|
|
1419 used from an appropriate hook.@xref{Hooks} This functions takes three
|
|
|
1420 arguments, the major type ("@i{image}"), the minor type ("@i{gif}"), and
|
|
20
|
1421 an assoc list of information about the viewer. Please see the @sc{url}
|
|
0
|
1422 documentation for more specific information on what this assoc list
|
|
|
1423 should look like.
|
|
|
1424
|
|
|
1425 @node Security, Non-Unix Operating Systems, , Top
|
|
|
1426 @chapter Security
|
|
|
1427 @cindex Security
|
|
|
1428 @cindex Paranoia
|
|
|
1429 There are an increasing number of ways to authenticate a user to a web
|
|
|
1430 service. Emacs-W3 tries to support as many as possible. Emacs-W3
|
|
|
1431 currently supports:
|
|
|
1432
|
|
|
1433 @table @b
|
|
|
1434 @item Basic Authentication
|
|
|
1435 @cindex Security, Basic
|
|
|
1436 @cindex HTTP/1.0 Authentication
|
|
|
1437 @cindex Authentication, Basic
|
|
|
1438 The weakest authentication available, not recommended if serious
|
|
|
1439 security is necessary. This is simply a string that looks like
|
|
|
1440 @samp{user:password} that has been Base64 encoded, as defined in RFC
|
|
|
1441 1421.
|
|
|
1442 @item Digest Authentication
|
|
|
1443 @cindex Security, Digest
|
|
|
1444 @cindex HTTP/1.0 Authentication
|
|
|
1445 @cindex Authentication, Digest
|
|
|
1446 Jeffery L. Hostetler, John Franks, Philip Hallam-Baker, Ari Luotonen,
|
|
|
1447 Eric W. Sink, and Lawrence C. Stewart have an internet draft for a new
|
|
|
1448 authentication mechanism. For the complete specification, please see
|
|
|
1449 draft-ietf-http-digest-aa-01.txt in the nearest internet drafts
|
|
|
1450 archive@footnote{One is ftp://ds.internic.net/internet-drafts}.
|
|
|
1451 @item SSL Encryption
|
|
|
1452 @cindex HTTP/1.0 Authentication
|
|
|
1453 @cindex Secure Sockets Layer
|
|
|
1454 @cindex SSL
|
|
|
1455 @cindex Gag Puke Retch
|
|
|
1456 @cindex Exportability
|
|
|
1457 @cindex Export Restrictions
|
|
|
1458 SSL is the @code{Secure Sockets Layer} interface developed by Netscape
|
|
|
1459 Communications @footnote{http://www.netscape.com/}. Emacs-W3 supports
|
|
20
|
1460 @sc{http} transfers over an SSL encrypted channel, if the appropriate files
|
|
0
|
1461 have been installed.@xref{Installing SSL}
|
|
|
1462 @end table
|
|
|
1463
|
|
|
1464 @node Non-Unix Operating Systems, VMS, Security, Top
|
|
|
1465 @chapter Non-Unix Operating Systems
|
|
|
1466 @cindex Non-Unix Operating Systems
|
|
|
1467 @ifinfo
|
|
|
1468 @menu
|
|
|
1469 * VMS:: The wonderful world of VAX|AXP-VMS!
|
|
|
1470 * OS/2:: The next-best thing to Unix.
|
|
|
1471 * MS-DOS:: The wonderful world of MS-DOG!
|
|
20
|
1472 * Windows:: Windows NT, Chicago/Windows 95.
|
|
0
|
1473 @end menu
|
|
|
1474 @end ifinfo
|
|
|
1475
|
|
|
1476 @node VMS, OS/2, Non-Unix Operating Systems, Non-Unix Operating Systems
|
|
|
1477 @section VMS
|
|
|
1478 @cindex VAX-VMS
|
|
|
1479 @cindex AXP-VMS
|
|
|
1480 @cindex Digital VMS
|
|
|
1481 @cindex VMS
|
|
|
1482 :: WORK :: VMS Specific instriuctions
|
|
|
1483
|
|
|
1484 @node OS/2, MS-DOS, VMS, Non-Unix Operating Systems
|
|
|
1485 @section OS/2
|
|
|
1486 @cindex OS/2
|
|
|
1487 @cindex Warp
|
|
|
1488 :: WORK :: OS/2 Specific instructions
|
|
|
1489
|
|
20
|
1490 @node MS-DOS, Windows, OS/2, Non-Unix Operating Systems
|
|
0
|
1491 @section MS-DOS
|
|
|
1492 @cindex MS-DOS
|
|
|
1493 @cindex Microsloth
|
|
|
1494 @cindex DOS
|
|
|
1495 @cindex MS-DOG
|
|
|
1496 :: WORK :: DOS Specific instructions
|
|
|
1497
|
|
20
|
1498 @node Windows, Speech Integration , MS-DOS, Non-Unix Operating Systems
|
|
|
1499 @section Windows
|
|
0
|
1500 @cindex Windows (32-Bit)
|
|
|
1501 @cindex 32-Bit Windows
|
|
|
1502 @cindex Microsloth
|
|
|
1503 @cindex Windows '95
|
|
|
1504 :: WORK :: 32bit Windows Specific instructions
|
|
|
1505
|
|
20
|
1506 @node Speech Integration, Advanced Features, Windows, Top
|
|
|
1507 @chapter Speech Integration
|
|
|
1508 :: WORK :: Emacspeak integration
|
|
0
|
1509
|
|
20
|
1510 @node Advanced Features, Style Sheets, Speech Integration, Top
|
|
0
|
1511 @chapter Advanced Features
|
|
|
1512
|
|
|
1513 @ifinfo
|
|
|
1514 @menu
|
|
|
1515 * Style Sheets:: Formatting control, the right way
|
|
|
1516 * Disk Caching:: Improving performance by using a local disk cache
|
|
|
1517 * Interfacing to Mail/News:: How to make VM understand hypertext links
|
|
|
1518 * Debugging HTML:: How to make Emacs-W3 display warnings about invalid
|
|
20
|
1519 @sc{html}/@sc{html}+ constructs.
|
|
0
|
1520 * Native WAIS Support:: How to make Emacs-W3 understand WAIS links without
|
|
|
1521 using a gateway.
|
|
|
1522 * Rating Links:: How to make Emacs-W3 put an 'interestingness' value
|
|
|
1523 next to each link.
|
|
|
1524 * Gopher Plus Support:: How Emacs-W3 makes use of the Gopher+ protocol.
|
|
|
1525 * Hooks:: Various hooks to use throughout Emacs-W3
|
|
|
1526 * Other Variables:: Miscellaneous variables that control the real
|
|
|
1527 guts of Emacs-W3.
|
|
|
1528 @end menu
|
|
|
1529 @end ifinfo
|
|
|
1530
|
|
|
1531 @node Style Sheets, Disk Caching, Advanced Features, Advanced Features
|
|
|
1532 @section Style Sheets
|
|
|
1533 @cindex Formatting control
|
|
|
1534 @cindex Style sheets
|
|
|
1535 @cindex Look and Feel
|
|
|
1536 @cindex Layout control
|
|
|
1537 @cindex Experimental style sheet mechanism
|
|
|
1538 Emacs-W3 currently supports the experimental style sheet mechanism
|
|
|
1539 proposed by H&kon W. Lie of the W3 Consortium. This allows for the
|
|
|
1540 author to specify what a document should look like, and yet allow the
|
|
|
1541 end user to override any of the stylistic changes. This allows for
|
|
|
1542 people with special needs (most notably the visually impaired) to
|
|
|
1543 override style bindings that could make a document totally
|
|
|
1544 unreadable.
|
|
|
1545
|
|
|
1546 @example
|
|
|
1547 <style notation="css">
|
|
|
1548 /* This is a comment
|
|
2
|
1549 ** These will be ignored, up to the terminating */
|
|
|
1550
|
|
0
|
1551 h1 @{ align: center,
|
|
|
1552 color: yellow,
|
|
|
1553 background: red,
|
|
|
1554 font-size: 24pt
|
|
|
1555 @}
|
|
|
1556 h2 @{ align: right,
|
|
|
1557 font-family: palatino,
|
|
|
1558 font-size: 18pt
|
|
|
1559 @}
|
|
|
1560 </style>
|
|
|
1561 @end example
|
|
|
1562
|
|
|
1563 :: WORK :: Much more information on stylesheets
|
|
|
1564
|
|
|
1565 @cindex <style>
|
|
|
1566 To include a stylesheet into a document, simply use the <style> tag.
|
|
|
1567 Use the @b{notation} attribute to specify what language the stylesheet
|
|
|
1568 is specified in. The default is @b{css}. The data between the <style>
|
|
20
|
1569 and </style> tags is the stylsheet proper - no @sc{html} parsing is done to
|
|
0
|
1570 this data - it is treated similar to an <XMP> section of text. To
|
|
|
1571 reference an external stylesheet, use the <link> tag.
|
|
|
1572 @example
|
|
|
1573 <link rel="stylesheet" href="/bill.style">
|
|
|
1574 @end example
|
|
20
|
1575 If these two mechanisms are mixed, then the @sc{url} is resolved first, and
|
|
0
|
1576 the contents of the <style> tag take precedence if there are any
|
|
|
1577 conflicting directives.
|
|
|
1578
|
|
|
1579 @cindex DSSSL
|
|
|
1580 @cindex DSSSL-lite
|
|
|
1581 In the future, DSSSL and DSSSL-lite will be supported as valid
|
|
|
1582 stylesheet languages, but not in this release. For more information on
|
|
|
1583 DSSSL-lite see http://www.falch.no/~pepper/DSSSL-Lite/ - for more
|
|
|
1584 information on full DSSSL, see
|
|
|
1585 ftp://ftp.jclark.com/pub/dsssl/dsssl.ps.gz
|
|
|
1586
|
|
|
1587 @node Disk Caching, Interfacing to Mail/News, Style Sheets, Advanced Features
|
|
|
1588 @section Disk Caching
|
|
|
1589 @cindex Caching
|
|
|
1590 @cindex Persistent Cache
|
|
|
1591 @cindex Disk Cache
|
|
|
1592 A cache stores the information on a page on the local machine. When
|
|
|
1593 requesting a page that is in the cache, Emacs-W3 can retrieve the page
|
|
|
1594 from the cache more quickly than retrieving the page again from its
|
|
|
1595 location out on the network. With a well-populated cache, browsing the
|
|
|
1596 web is dramatically faster.
|
|
|
1597
|
|
|
1598 The first time a page is requested, Emacs-W3 retrieves the page from the
|
|
|
1599 network. When requesting a page that is in the cache, Emacs-W3 checks
|
|
|
1600 to see if the page has changed since it was last retrieved from the
|
|
|
1601 remote machine. If it has not changed, the local copy is used, saving
|
|
|
1602 the transmission of the file over the network.
|
|
|
1603
|
|
|
1604 @vindex url-automatic-caching
|
|
|
1605 @cindex Turning on caching
|
|
|
1606 @cindex Cleaning the cache
|
|
|
1607 @cindex Clearing the cache
|
|
|
1608 @cindex Cache cleaning
|
|
|
1609 @cindex Limiting the size of the cache
|
|
|
1610 To turn on disk caching, set the variable @code{url-automatic-caching}
|
|
|
1611 to non-@code{nil}, or choose the 'Caching' menu item (under `Options').
|
|
|
1612 That is all there is to it. Running the @code{clean-cache} shell script
|
|
|
1613 fist is recommended, to allow for future cleaning of the cache. This
|
|
|
1614 shell script will remove all files that have not been accessed since it
|
|
|
1615 was last run. To keep the cache pared down, it is recommended that this
|
|
|
1616 script be run from @i{at} or @i{cron} (see the manual pages for
|
|
|
1617 crontab(5) or at(1) for more information)
|
|
|
1618
|
|
|
1619
|
|
|
1620 @cindex Relying on cache
|
|
|
1621 @cindex Cache only mode
|
|
|
1622 @cindex Standalone mode
|
|
|
1623 @cindex Browsing with no network connection
|
|
|
1624 @cindex Netless browsing
|
|
|
1625 @vindex url-standalone-mode
|
|
|
1626 With a large cache of documents on the local disk, it can be very handy
|
|
|
1627 when traveling, or any other time the network connection is not active
|
|
|
1628 (a laptop with a dial-on-demand PPP connection, etc). Emacs-W3 can rely
|
|
|
1629 solely on its cache, and avoid checking to see if the page has changed
|
|
|
1630 on the remote server. In the case of a dial-on-demand PPP connection,
|
|
|
1631 this will keep the phone line free as long as possible, only bringing up
|
|
|
1632 the PPP connection when asking for a page that is not located in the
|
|
|
1633 cache. This is very useful for demonstrations as well. To turn this
|
|
|
1634 feature on, set the variable @code{url-standalone-mode} to
|
|
|
1635 non-@code{nil}, or choose the `Use Cache Only' menu item (under
|
|
|
1636 `Options')
|
|
|
1637
|
|
|
1638 @cindex Caching options
|
|
|
1639 @cindex Alternate caching method
|
|
|
1640 Emacs-W3 caches files under the temporary directory specified by
|
|
|
1641 @code{url-temporary-directory}, in a user-specific subdirectory
|
|
|
1642 (determined by the @code{user-real-login-name} function). The cache
|
|
20
|
1643 files are stored under their original names, so a @sc{url} like:
|
|
2
|
1644 http://www.aventail.com/foo/bar/baz.html would be stored in a cache file
|
|
|
1645 named: /tmp/wmperry/com/aventail/www/foo/bar/baz.html. Sometimes,
|
|
|
1646 espcially with gopher links, there will be name conflicts, and an error
|
|
|
1647 will be signalled. This cannot be avoided, and still have reasonable
|
|
0
|
1648 performance at startup time (reading in an index file of all the cached
|
|
|
1649 pages can take a long time on slow machines, or even fast machines with
|
|
|
1650 large caches). When running XEmacs 19.12 or later, a different naming
|
|
|
1651 scheme can be used. This avoids name conflicts, but loses the human
|
|
|
1652 readability of the cache file names. The cache files will look like:
|
|
|
1653 /tmp/wmperry/acbd18db4cc2f85cedef654fccc4a4d8, which is certainly
|
|
|
1654 unique, but not very user-friendly. To turn this on, add this to the
|
|
|
1655 @file{.emacs} file:
|
|
|
1656
|
|
|
1657
|
|
|
1658 @example
|
|
|
1659 (add-hook 'w3-load-hooks '(lambda ()
|
|
|
1660 (fset 'url-create-cached-filename
|
|
|
1661 'url-create-cached-filename-using-md5)))
|
|
|
1662 @end example
|
|
|
1663
|
|
|
1664 If other versions of emacs will not be sharing the cache, I highly
|
|
|
1665 recommend this method of creating the cache filename.
|
|
|
1666
|
|
|
1667
|
|
|
1668 @node Interfacing to Mail/News, Debugging HTML, Disk Caching, Advanced Features
|
|
|
1669 @section Interfacing to Mail/News
|
|
|
1670 @cindex Interfacing to Mail/News
|
|
|
1671 @cindex VM
|
|
|
1672 @cindex Using Emacs-W3 with VM
|
|
|
1673 @cindex GNUS
|
|
2
|
1674 @cindex Using Emacs-W3 with Gnus
|
|
0
|
1675 @cindex RMAIL
|
|
|
1676 @cindex Using Emacs-W3 with RMAIL
|
|
20
|
1677 More and more people are including @sc{url}s in their signatures, and within
|
|
0
|
1678 the body of mail messages. It can get quite tedious to type these into
|
|
|
1679 the minibuffer to follow one.
|
|
|
1680
|
|
2
|
1681 @vindex browse-url-browser-function
|
|
|
1682 With the latest versions of VM (the 5.9x series of betas) and Gnus
|
|
20
|
1683 (5.x), @sc{url}s are automatically highlighted, and can be followed with the
|
|
|
1684 mouse or the return key. How the @sc{url}s are viewed is determined by the
|
|
2
|
1685 variable @code{browse-url-browser-function}, and it should be set to the
|
|
|
1686 symbol @code{browse-url-w3}.
|
|
0
|
1687
|
|
20
|
1688 To access @sc{url}s from within RMAIL, the following hook should do the
|
|
0
|
1689 trick.
|
|
|
1690 @example
|
|
|
1691 (add-hook 'rmail-mode-hook
|
|
|
1692 (function
|
|
|
1693 (lambda ()
|
|
|
1694 (define-key rmail-mode-map [mouse-2] 'w3-maybe-follow-link-mouse)
|
|
|
1695 (define-key rmail-mode-map "\r" 'w3-maybe-follow-link))))
|
|
|
1696 @end example
|
|
|
1697
|
|
|
1698 @node Debugging HTML, Native WAIS Support, Interfacing to Mail/News, Advanced Features
|
|
|
1699 @section Debugging HTML
|
|
|
1700 @cindex Debugging
|
|
|
1701 @cindex Invalid HTML
|
|
|
1702 @cindex Bad HTML
|
|
|
1703 @vindex w3-debug-buffer
|
|
|
1704 @vindex w3-debug-html
|
|
|
1705 For those people that are adventurous, or are just as anal as I am about
|
|
20
|
1706 people writing valid @sc{html}, set the variable @code{w3-debug-html} to
|
|
0
|
1707 @code{t} and see what happens.
|
|
|
1708
|
|
|
1709
|
|
20
|
1710 If a Emacs-W3 thinks it has encountered invalid @sc{html}, then a debugging
|
|
0
|
1711 message is displayed.
|
|
|
1712
|
|
|
1713 :: WORK :: Need to list the different values w3-debug-html can have, and
|
|
|
1714 :: WORK :: what they do ::
|
|
|
1715
|
|
|
1716 @node Native WAIS Support, Rating Links, Debugging HTML, Advanced Features
|
|
|
1717 @section Native WAIS Support
|
|
|
1718 This version of Emacs-W3 supports native WAIS querying (earlier
|
|
|
1719 versions required the use of a gateway program). In order to use the
|
|
|
1720 native WAIS support, a working @dfn{waisq} binary is required. I
|
|
|
1721 recommend the distribution from think.com -
|
|
|
1722 ftp://think.com/wais/wais-8-b6.1.tar.Z is a good place to start.
|
|
|
1723
|
|
|
1724 @vindex url-waisq-prog
|
|
|
1725 @vindex url-wais-gateway-server
|
|
|
1726 @vindex url-wais-gateway-port
|
|
|
1727 The variable @code{url-waisq-prog} must point to this executable, and
|
|
|
1728 one of @code{url-wais-gateway-server} or @code{url-wais-gateway-port}
|
|
|
1729 should be @code{nil}.
|
|
|
1730
|
|
20
|
1731 When a WAIS @sc{url} is encountered, a form will be automatically generated
|
|
0
|
1732 and displayed. After typing in the search term, the query will be sent
|
|
|
1733 to the server by running the @code{url-waisq-prog} in a subprocess. The
|
|
20
|
1734 results will be converted into @sc{html} and displayed.
|
|
0
|
1735
|
|
|
1736 @node Rating Links, Gopher Plus Support, Native WAIS Support, Advanced Features
|
|
|
1737 @section Rating Links
|
|
20
|
1738 The @code{w3-link-info-display-function} variable can be used to 'rate' a @sc{url}
|
|
|
1739 when it shows up in an @sc{html} page. If non-@code{nil}, then this should
|
|
0
|
1740 be a list specifying (or a symbol specifying the name) of a function.
|
|
20
|
1741 This function should expect one argument, a fully specified @sc{url}, and
|
|
0
|
1742 should return a string. This string is inserted after the link
|
|
|
1743 text.
|
|
|
1744
|
|
|
1745 If a user has decided that all links served from blort.com are too laden
|
|
|
1746 with images, and wants to be warned that a link points at this host,
|
|
|
1747 they could do something like this:
|
|
|
1748
|
|
|
1749 @example
|
|
|
1750 (defun check-url (url)
|
|
|
1751 (if (string-match "://[^/]blort.com" url)
|
|
|
1752 "[SLOW!]" ""))
|
|
|
1753
|
|
|
1754 (setq w3-link-info-display-function 'check-url)
|
|
|
1755 @end example
|
|
|
1756
|
|
|
1757 So that all links pointing to any site at blort.com shows up as "Some
|
|
|
1758 link[SLOW!]" instead of just "Some link".
|
|
|
1759
|
|
|
1760 @node Gopher Plus Support, Hooks, Rating Links, Advanced Features
|
|
|
1761 @section Gopher+ Support
|
|
|
1762 @cindex Gopher+
|
|
|
1763 The gopher+ support in Emacs-W3 is limited to the conversion of ASK
|
|
20
|
1764 blocks into @sc{html} 3.0 forms, and the usage of the content-length given by
|
|
0
|
1765 the gopher+ server to give a nice status bar on the bottom of the
|
|
|
1766 screen.
|
|
|
1767
|
|
|
1768 This will hopefully be extended to include the Gopher+ method of
|
|
|
1769 content-type negotiation, but this may be a while.
|
|
|
1770
|
|
|
1771 @node Hooks, Other Variables, Gopher Plus Support, Advanced Features
|
|
|
1772 @section Hooks
|
|
|
1773 @cindex Hooks
|
|
|
1774 These are the various hooks that can be used to customize some of
|
|
|
1775 Emacs-W3's behavior. They are arranged in the order in which they would
|
|
|
1776 happen when retrieving a document. All of these are functions (or lists
|
|
|
1777 of functions) that are called consecutively.
|
|
|
1778
|
|
|
1779 @table @code
|
|
|
1780 @vindex w3-load-hooks
|
|
|
1781 @item w3-load-hooks
|
|
20
|
1782 These hooks are run by @code{w3-do-setup} the first time a @sc{url} is
|
|
0
|
1783 fetched. All the w3 variables are initialized before this hook is
|
|
|
1784 run.
|
|
|
1785 @item w3-file-done-hooks
|
|
|
1786 These hooks are run by @code{w3-prepare-buffer} after all parsing on a
|
|
|
1787 document has been done. All @code{url-current-}@var{*} and
|
|
|
1788 @code{w3-current-}@var{*} variables are initialized when this hook is run.
|
|
|
1789 This is run before the buffer is shown, and before any inlined images
|
|
|
1790 are downloaded and converted.
|
|
|
1791 @item w3-file-prepare-hooks
|
|
|
1792 These hooks are run by @code{w3-prepare-buffer} before any parsing is
|
|
20
|
1793 done on the @sc{html} file. The @sc{http}/1.0 headers specified by
|
|
|
1794 @code{w3-show-headers} have been inserted, and the syntax table has been
|
|
|
1795 set to @code{w3-parse-args-syntax-table} by the time this hook is run.
|
|
0
|
1796 @item w3-mode-hooks
|
|
|
1797 These hooks are run after a buffer has been parsed and displayed, but
|
|
|
1798 before any inlined images are downloaded and converted.
|
|
|
1799 @item w3-source-file-hooks
|
|
|
1800 These hooks are run after displaying a document's source
|
|
|
1801 @end table
|
|
|
1802
|
|
|
1803 @node Other Variables, , Hooks, Advanced Features
|
|
|
1804 @section Miscellaneous variables
|
|
|
1805 There are lots of variables that control the real nitty-gritty of Emacs-W3
|
|
|
1806 that the beginning user probably shouldn't mess with. Here they are.
|
|
|
1807
|
|
|
1808 @table @code
|
|
|
1809 @item url-bad-port-list
|
|
|
1810 @vindex url-bad-port-list
|
|
|
1811 List of ports to warn the user about connecting to. Defaults to just
|
|
20
|
1812 the mail and @sc{nntp} ports so a malicious @sc{html} author cannot spoof mail or
|
|
0
|
1813 news to other people.
|
|
|
1814 @item url-confirmation-func
|
|
|
1815 @vindex url-confirmation-func
|
|
|
1816 What function to use for asking yes or no functions. Possible values
|
|
|
1817 are @code{'yes-or-no-p} or @code{'y-or-n-p}, or any function that takes
|
|
|
1818 a single argument (the prompt), and returns @code{t} only if a positive
|
|
|
1819 answer is gotten. Defaults to @code{'yes-or-no-p}.
|
|
|
1820 @item w3-default-action
|
|
|
1821 @vindex w3-default-action
|
|
|
1822 A lisp symbol specifying what action to take for files with extensions
|
|
|
1823 that are not in the @code{mm-mime-extensions} assoc list. This is
|
|
|
1824 useful in case Emacs-W3 ever run across files with weird extensions
|
|
|
1825 (.foo, .README, .READMEFIRST, etc.). In most circumstances, this should
|
|
|
1826 not be required anymore.
|
|
|
1827
|
|
|
1828 Possible values: any lisp symbol. Should be a function that takes no
|
|
|
1829 arguments. The return value does not matter, it is ignored. Some examples
|
|
|
1830 are @code{'w3-prepare-buffer} or @code{'indented-text-mode}.
|
|
|
1831 @ignore
|
|
|
1832 @item w3-icon-directory-list
|
|
|
1833 @vindex w3-icon-directory-list
|
|
|
1834 A list of directorys to look in for the w3 standard icons... must end
|
|
|
1835 in a /! If the directory @code{data-directory}/w3 exists, then this is
|
|
|
1836 automatically added to the default value of
|
|
|
1837 http://cs.indiana.edu/elisp/w3/icons/.
|
|
|
1838 @end ignore
|
|
|
1839 @item w3-keep-old-buffers
|
|
|
1840 @vindex w3-keep-old-buffers
|
|
|
1841 Whether to keep old buffers around when following links. To avoid lots
|
|
|
1842 of buffers in one Emacs session, set this variable to @code{nil}. I
|
|
|
1843 recommend setting it to @code{t}, so that backtracking from one link to
|
|
|
1844 another is faster.
|
|
|
1845
|
|
|
1846 @item url-passwd-entry-func
|
|
|
1847 @vindex url-passwd-entry-func
|
|
|
1848 This is a symbol indicating which function to call to read in a
|
|
|
1849 password. If this variable is @code{nil} at startup, it is initialized
|
|
|
1850 depending on whether @dfn{EFS} or @dfn{ange-ftp} is being used. This
|
|
|
1851 function should accept the prompt string as its first argument, and the
|
|
|
1852 default value as its second argument.
|
|
|
1853
|
|
|
1854 @item w3-reuse-buffers
|
|
|
1855 @vindex w3-reuse-buffers
|
|
|
1856 Determines what happens when @code{w3-fetch} is called on a document
|
|
|
1857 that has already been loaded into another buffer. Possible values are:
|
|
|
1858 @code{nil}, @code{yes}, and @code{no}. @code{nil} will ask the user if
|
|
|
1859 Emacs-W3 should reuse the buffer (this is the default value). A value of
|
|
|
1860 @code{yes} means assume the user wants to always reuse the buffer. A
|
|
|
1861 value of @code{no} means assume the user always wants to re-fetch the
|
|
|
1862 document.
|
|
|
1863 @item w3-show-headers
|
|
|
1864 @vindex w3-show-headers
|
|
20
|
1865 This is a list of @sc{http}/1.0 headers to show at the end of a buffer. All
|
|
0
|
1866 the headers should be in lowercase. They are inserted at the end of the
|
|
|
1867 buffer in a <UL> list. Alternatively, if this is simply @code{t}, then
|
|
20
|
1868 all the @sc{http}/1.0 headers are shown. The default value is
|
|
0
|
1869 @code{nil}.
|
|
|
1870 @item w3-show-status, url-show-status
|
|
|
1871 @vindex url-show-status
|
|
|
1872 @vindex w3-show-status
|
|
|
1873 Whether to show progress messages in the minibuffer.
|
|
|
1874 @code{w3-show-status} controls if messages about the parsing are
|
|
|
1875 displayed, and @code{url-show-status} controls if a running total of the
|
|
|
1876 number of bytes transferred is displayed. These Can cause a large
|
|
|
1877 performance hit if using a remote X display over a slow link, or a
|
|
|
1878 terminal with a slow modem.
|
|
|
1879 @item mm-content-transfer-encodings
|
|
|
1880 @vindex mm-content-transfer-encodings
|
|
|
1881 An assoc list of @var{Content-Transfer-Encodings} or
|
|
|
1882 @var{Content-Encodings} and the appropriate decoding algorithms for each.
|
|
|
1883 If the @code{cdr} of a node is a list, then this specifies the decoder is
|
|
|
1884 an external program, with the program as the first item in the list, and
|
|
|
1885 the rest of the list specifying arguments to be passed on the command line.
|
|
|
1886 If using an external decoder, it must accept its input from @code{stdin}
|
|
|
1887 and send its output to @code{stdout}.
|
|
|
1888
|
|
|
1889 If the @code{cdr} of a node is a symbol whose function definition is
|
|
|
1890 non-@code{nil}, then that encoding can be handled internally. The function
|
|
|
1891 is called with 2 arguments, buffer positions bounding the region to be
|
|
|
1892 decoded. The function should completely replace that region with the
|
|
|
1893 unencoded information.
|
|
|
1894
|
|
|
1895 Currently supported transfer encodings are: base64, x-gzip, 7bit, 8bit,
|
|
|
1896 binary, x-compress, x-hqx, and quoted-printable.
|
|
|
1897 @item url-uncompressor-alist
|
|
|
1898 @vindex url-uncompressor-alist
|
|
|
1899 An assoc list of file extensions and the appropriate uncompression
|
|
|
1900 programs for each. This is used to build the Accept-encoding header for
|
|
20
|
1901 @sc{http}/1.0 requests.
|
|
0
|
1902 @item url-waisq-prog
|
|
|
1903 @vindex url-waisq-prog
|
|
|
1904 Name of the waisq executable on this system. This should be the
|
|
|
1905 @file{waisq} program from think.com's wais8-b5.1 distribution.
|
|
|
1906 @end table
|
|
|
1907
|
|
|
1908 @node More Help, Future Directions, , Top
|
|
|
1909 @chapter More Help
|
|
|
1910 @cindex Relevant Newsgroups
|
|
|
1911 @cindex Newsgroups
|
|
|
1912 @cindex Support
|
|
|
1913 For more help on Emacs-W3, please send me mail
|
|
|
1914 (@i{wmperry@@cs.indiana.edu}). Several discussion lists have also been
|
|
|
1915 created for Emacs-W3. To subscribe, send mail to
|
|
|
1916 @i{majordomo@@indiana.edu}, with the body of the message 'subscribe
|
|
|
1917 @var{listname} @var{<email addres>}'. All other mail should go to
|
|
|
1918 @i{<listname>@@indiana.edu}.
|
|
|
1919
|
|
|
1920
|
|
|
1921 @itemize @bullet
|
|
|
1922 @item
|
|
|
1923 w3-announce -- this list is for anyone interested in Emacs-W3, and
|
|
|
1924 should in general only be used by me. The gnu.emacs.sources newsgroup
|
|
|
1925 and a few other mailing lists are included on this. Please only use
|
|
|
1926 this list for major package releases related to Emacs-W3.
|
|
|
1927 (@i{www-announce@@w3.org} is included on this list).
|
|
|
1928 @item
|
|
|
1929 w3-beta -- this list is for beta testers of Emacs-W3. These brave souls test
|
|
|
1930 out not-quite stable code.
|
|
|
1931 @item
|
|
|
1932 w3-dev -- a list consisting of myself and a few other people who are
|
|
|
1933 interested in the internals of Emacs-W3, and doing active development work.
|
|
|
1934 Pretty dead right now, but I hope it will grow.
|
|
|
1935 @end itemize
|
|
|
1936
|
|
|
1937 For more help on the World Wide Web in general, please refer to the
|
|
|
1938 comp.infosystems.www.* newsgroups. There are also several discussion
|
|
|
1939 lists concerning the Web. Send mail to @i{<listname>-request@@w3.org}
|
|
|
1940 with a subject line of 'subscribe <listname>'. All mail should go to
|
|
|
1941 @i{<listname>@@w3.org}. Administrative mail should go to
|
|
|
1942 @i{www-admin@@w3.org}. The lists are:
|
|
|
1943
|
|
|
1944
|
|
|
1945 @itemize @bullet
|
|
|
1946 @item
|
|
|
1947 www-talk -- for general discussion of the World Wide Web, where its
|
|
|
1948 going, new features, etc. All the major developers are subscribed to
|
|
|
1949 this list.
|
|
|
1950 @item
|
|
|
1951 www-announce -- for announcements concerning the World Wide Web. Server
|
|
|
1952 changes, new servers, new software, etc.
|
|
|
1953 @end itemize
|
|
|
1954
|
|
|
1955 As a last resort, mail me. I'll try to answer as quickly as I can.
|
|
|
1956
|
|
2
|
1957 @node Future Directions, Reporting Bugs, More Help, Top
|
|
0
|
1958 @chapter Future Directions
|
|
|
1959 Changes are constantly being made to the Emacs browser (hopefully all
|
|
|
1960 for the better). This is a list of the things that are being worked on
|
|
|
1961 right now.
|
|
|
1962
|
|
|
1963 :: WORK :: Revamp the todo list
|
|
|
1964
|
|
2
|
1965 @node Reporting Bugs, Installing SSL, Future Directions, Top
|
|
0
|
1966 @appendix Reporting Bugs
|
|
|
1967 @cindex Reporting Bugs
|
|
|
1968 @cindex Bugs
|
|
|
1969 @cindex Contacting the author
|
|
|
1970
|
|
20
|
1971 If any bugs are discovered in Emacs-W3, please report them to the
|
|
|
1972 mailing list @t{w3-beta@@indiana.edu} - this is where the brave souls
|
|
|
1973 who beta test the latest versions of Emacs-W3 reside, and are generally
|
|
|
1974 very responsive to bug reports.
|
|
|
1975
|
|
|
1976 @kindex w
|
|
|
1977 Please make sure to use the bug submission feature of Emacs-W3, so that
|
|
|
1978 all relevant information will be sent along with your bug report. By
|
|
|
1979 default this is bound to the `@key{w}' key when in an Emacs-W3 buffer,
|
|
|
1980 or you can use @key{M-x w3-submit-bug} from anywhere within Emacs.
|
|
|
1981
|
|
|
1982 For problems that are causing emacs to signal and error, please send a
|
|
|
1983 backtrace. You can get a backtrace by @kbd{M-x setvariable RET
|
|
|
1984 debug-on-error RET t RET}, and then reproduce the error.
|
|
0
|
1985
|
|
20
|
1986 If the problem is visual, please capture a copy of the output and mail
|
|
|
1987 it along with the bug report (preferably as a MIME attachment, but
|
|
|
1988 anything will do). You can use the @code{xwd} program under X-windows
|
|
|
1989 for this, or @key{Alt-PrintScreen} under Windows 95/NT. Sorry, but I
|
|
|
1990 don't remember what the magic incarnation is for doing a screen dump
|
|
|
1991 under NeXTstep or OS/2.
|
|
|
1992
|
|
|
1993 If the problem is actually causing Emacs to crash, then you will need to
|
|
|
1994 also mail the maintainers of the various Emacs distributions with the
|
|
|
1995 bug. Please use the @t{gnu.emacs.bug} newgroup for reporting bugs with
|
|
|
1996 GNU Emacs 19, and @t{comp.emacs.xemacs} for reporting bugs with XEmacs
|
|
|
1997 19 or XEmacs 20. I am actively involved with the beta testing of the
|
|
|
1998 latest versions of both branches of Emacs, and if I can reproduce the
|
|
|
1999 problem, I will do my best to see it gets fixed in the next release.
|
|
|
2000
|
|
|
2001 It is also important to always maintain as much context as possible in
|
|
|
2002 your responses. I get so much email from my various Emacs-activities
|
|
|
2003 and work, that I cannot remember everything. If you send a bug report,
|
|
|
2004 and I send you a reply, and you reply with 'no that didn't work', then
|
|
|
2005 odds are I will have no clue what didn't work, much less what that was
|
|
|
2006 trying to fix in the first place. It will be much quicker and less
|
|
|
2007 painful if I don't have to waste a round-trip email exchange saying
|
|
|
2008 'what are you talking about'.
|
|
|
2009
|
|
|
2010 @node Installing SSL, Mailcap Files, Reporting Bugs, Top
|
|
0
|
2011 @appendix Installing SSL
|
|
|
2012 @cindex HTTP/1.0 Authentication
|
|
|
2013 @cindex Secure Sockets Layer
|
|
|
2014 @cindex SSL
|
|
|
2015 @cindex Gag Puke Retch
|
|
|
2016 @cindex Exportability
|
|
|
2017 @cindex Export Restrictions
|
|
|
2018 In order to use SSL in Emacs-W3, an implementation of SSL is necessary.
|
|
|
2019 These are the implementations that I am aware of:
|
|
|
2020
|
|
|
2021 @table @code
|
|
|
2022 @item SSLRef 2.0
|
|
|
2023 Available from Netscape Communications @footnote{http://www.netscape.com/newsref/std/sslref.html}. This requires the
|
|
|
2024 RSARef library, which is not exportable. The RSARef library is
|
|
|
2025 available from ftp://ftp.rsa.com/rsaref/
|
|
|
2026 @item SSLeay 0.4
|
|
|
2027 An implementation by Eric Young (eay@@mincom.oz.au) that is free for
|
|
|
2028 commerial or noncommercial use, and was developed completely outside the
|
|
|
2029 US by a non-US citizen. More information can be found at
|
|
|
2030 ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL/
|
|
|
2031 @end table
|
|
|
2032
|
|
|
2033 @vindex ssl-program-name
|
|
|
2034 Whichever reference implementation is used (I recommend the SSLeay
|
|
|
2035 distribution, just to thumb a nose at the NSA :), there is a program
|
|
|
2036 that can be run in a subprocess that takes a hostname and port number on
|
|
|
2037 the command line, and reads/writes to standard input/output (the
|
|
|
2038 Netscape implementation comes with one of these by default). Set the
|
|
|
2039 variable @code{ssl-program-name} to point to this program.
|
|
|
2040
|
|
|
2041
|
|
|
2042 This should be all the configuration necessary. In the future, I will
|
|
|
2043 be distributing a set of patches to Emacs 19.xx and XEmacs 19.xx to
|
|
|
2044 SSL-enable them, for the sake of speed.
|
|
|
2045
|
|
20
|
2046 @node Mailcap Files, General Index, Installing SSL, Top
|
|
0
|
2047 @appendix Mailcap Files
|
|
|
2048 NCSA Mosaic and almost all other WWW browsers rely on a separate file
|
|
|
2049 for mapping MIME types to external viewing programs. This takes some of
|
|
|
2050 the burden off of browser developers, so each browser does not have to
|
|
|
2051 support all image formats, or postscript, etc. Instead of having the
|
|
|
2052 users of Emacs-W3 duplicate this in lisp, this file can be parsed using
|
|
|
2053 the @code{mm-parse-mailcaps} function. This function is called each
|
|
|
2054 time Emacs-W3 is loaded. It tries to locate mimetype files in several
|
|
|
2055 places. If the environment variable @code{MAILCAPS} is nonempty, then
|
|
|
2056 this is assumed to specify a UNIX-like path of mimetype files (this is a
|
|
|
2057 colon separated string of pathnames). If the @code{MAILCAPS}
|
|
|
2058 environment variable is empty, then Emacs-W3 looks for these
|
|
|
2059 files:
|
|
|
2060
|
|
|
2061 @enumerate
|
|
|
2062 @item
|
|
|
2063 @file{~/.mailcap}
|
|
|
2064 @item
|
|
|
2065 @file{/etc/mailcap}
|
|
|
2066 @item
|
|
|
2067 @file{/usr/etc/mailcap}
|
|
|
2068 @item
|
|
|
2069 @file{/usr/local/etc/mailcap}
|
|
|
2070 @end enumerate
|
|
|
2071
|
|
|
2072 This format of this file is specified in RFC 1343, but a brief synopsis
|
|
|
2073 follows (this is taken verbatim from sections of RFC 1343).
|
|
|
2074
|
|
|
2075 Each mailcap file consists of a set of entries that describe the proper
|
|
|
2076 handling of one media type at the local site. For example, one line
|
|
|
2077 might tell how to display a message in Group III fax format. A mailcap
|
|
|
2078 file consists of a sequence of such individual entries, separated by
|
|
|
2079 newlines (according to the operating system's newline
|
|
|
2080 conventions). Blank lines and lines that start with the "#" character
|
|
|
2081 (ASCII 35) are considered comments, and are ignored. Long entries may
|
|
|
2082 be continued on multiple lines if each non-terminal line ends with a
|
|
|
2083 backslash character ('\', ASCII 92), in which case the multiple lines
|
|
|
2084 are to be treated as a single mailcap entry. Note that for such
|
|
|
2085 "continued" lines, the backslash must be the last character on the line
|
|
|
2086 to be continued.
|
|
|
2087
|
|
|
2088 Each mailcap entry consists of a number of fields, separated by
|
|
|
2089 semi-colons. The first two fields are required, and must occur in the
|
|
|
2090 specified order. The remaining fields are optional, and may appear in
|
|
|
2091 any order.
|
|
|
2092
|
|
|
2093 The first field is the content-type, which indicates the type of data
|
|
|
2094 this mailcap entry describes how to handle. It is to be matched against
|
|
|
2095 the type/subtype specification in the "Content-Type" header field of an
|
|
|
2096 Internet mail message. If the subtype is specified as "*", it is
|
|
|
2097 intended to match all subtypes of the named content-type.
|
|
|
2098
|
|
|
2099 The second field, view-command, is a specification of how the message or
|
|
|
2100 body part can be viewed at the local site. Although the syntax of this
|
|
|
2101 field is fully specified, the semantics of program execution are
|
|
|
2102 necessarily somewhat operating system dependent.
|
|
|
2103
|
|
|
2104 The optional fields, which may be given in any order, are as follows:
|
|
|
2105 @itemize @bullet
|
|
|
2106 @item
|
|
|
2107 The "compose" field may be used to specify a program that can be used to
|
|
|
2108 compose a new body or body part in the given format. Its intended use
|
|
|
2109 is to support mail composing agents that support the composition of
|
|
|
2110 multiple types of mail using external composing agents. As with the
|
|
|
2111 view- command, the semantics of program execution are operating system
|
|
|
2112 dependent. The result of the composing program may be data that is not
|
|
|
2113 yet suitable for mail transport---that is, a Content-Transfer-Encoding
|
|
|
2114 may need to be applied to the data.
|
|
|
2115 @item
|
|
|
2116 The "composetyped" field is similar to the "compose" field, but is to be
|
|
|
2117 used when the composing program needs to specify the Content-type header
|
|
|
2118 field to be applied to the composed data. The "compose" field is
|
|
|
2119 simpler, and is preferred for use with existing (non-mail-oriented)
|
|
|
2120 programs for composing data in a given format. The "composetyped" field
|
|
|
2121 is necessary when the Content-type information must include auxilliary
|
|
|
2122 parameters, and the composition program must then know enough about mail
|
|
|
2123 formats to produce output that includes the mail type
|
|
|
2124 information.
|
|
|
2125 @item
|
|
|
2126 The "edit" field may be used to specify a program that can be used to
|
|
|
2127 edit a body or body part in the given format. In many cases, it may be
|
|
|
2128 identical in content to the "compose" field, and shares the
|
|
|
2129 operating-system dependent semantics for program execution.
|
|
|
2130 @item
|
|
|
2131 The "print" field may be used to specify a program that can be used to
|
|
|
2132 print a message or body part in the given format. As with the
|
|
|
2133 view-command, the semantics of program execution are operating system
|
|
|
2134 dependent.
|
|
|
2135 @item
|
|
|
2136 The "test" field may be used to test some external condition (e.g. the
|
|
|
2137 machine architecture, or the window system in use) to determine whether
|
|
|
2138 or not the mailcap line applies. It specifies a program to be run to
|
|
|
2139 test some condition. The semantics of execution and of the value
|
|
|
2140 returned by the test program are operating system dependent. If the
|
|
|
2141 test fails, a subsequent mailcap entry should be sought. Multiple test
|
|
|
2142 fields are not permitted---since a test can call a program, it can
|
|
|
2143 already be arbitrarily complex.
|
|
|
2144 @item
|
|
|
2145 The "needsterminal" field indicates that the view-command must be run on
|
|
|
2146 an interactive terminal. This is needed to inform window-oriented user
|
|
|
2147 agents that an interactive terminal is needed. (The decision is not
|
|
|
2148 left exclusively to the view-command because in some circumstances it
|
|
|
2149 may not be possible for such programs to tell whether or not they are on
|
|
|
2150 interactive terminals.) The needsterminal command should be assumed to
|
|
|
2151 apply to the compose and edit commands, too, if they exist. Note that
|
|
|
2152 this is NOT a test---it is a requirement for the environment in which
|
|
|
2153 the program will be executed, and should typically cause the creation of
|
|
|
2154 a terminal window when not executed on either a real terminal or a
|
|
|
2155 terminal window.
|
|
|
2156 @item
|
|
|
2157 The "copiousoutput" field indicates that the output from the
|
|
|
2158 view-command will be an extended stream of output, and is to be
|
|
|
2159 interpreted as advice to the UA (User Agent mail- reading program) that
|
|
|
2160 the output should be either paged or made scrollable. Note that it is
|
|
|
2161 probably a mistake if needsterminal and copiousoutput are both
|
|
|
2162 specified.
|
|
|
2163 @item
|
|
|
2164 The "description" field simply provides a textual description,
|
|
|
2165 optionally quoted, that describes the type of data, to be used
|
|
|
2166 optionally by mail readers that wish to describe the data before
|
|
|
2167 offering to display it.
|
|
|
2168 @item
|
|
|
2169 The "x11-bitmap" field names a file, in X11 bitmap (xbm) format, which
|
|
|
2170 points to an appropriate icon to be used to visually denote the presence
|
|
|
2171 of this kind of data.
|
|
|
2172 @item
|
|
|
2173 Any other fields beginning with "x-" may be included for local or
|
|
|
2174 mailer-specific extensions of this format. Implementations should
|
|
|
2175 simply ignore all such unrecognized fields to permit such extensions,
|
|
|
2176 some of which might be standardized in a future version of this
|
|
|
2177 document.
|
|
|
2178 @end itemize
|
|
|
2179
|
|
|
2180 @node General Index, Key Index, Mailcap Files, Top
|
|
|
2181 @appendix General Index
|
|
|
2182 @printindex fn
|
|
|
2183 @node Key Index, , General Index, Top
|
|
|
2184 @appendix Key Index
|
|
|
2185 @printindex ky
|
|
|
2186 @contents
|
|
|
2187 @bye
|
|
20
|
2188
|
|
|
2189 @c @ifinfo
|
|
|
2190 @c Here is some more specific information about what languages and
|
|
|
2191 @c protocols Emacs-W3 supports.
|
|
|
2192 @c @menu
|
|
|
2193 @c * Markup Languages Supported:: Markup languages supported by Emacs-W3
|
|
|
2194 @c * Stylesheets:: Stylesheet languages supported by Emacs-W3
|
|
|
2195 @c * Supported Protocols:: Network protocols supported by Emacs-W3
|
|
|
2196 @c @end menu
|
|
|
2197 @c @end ifinfo
|
|
|
2198 @c @node Markup Languages Supported, Stylesheets, Introduction, Introduction
|
|
|
2199 @c @chapter Supported Markup Languages
|
|
|
2200 @c Several different markup languages, and various extensions to those
|
|
|
2201 @c languages, are supported by Emacs-W3.
|
|
|
2202 @c @ifinfo
|
|
|
2203 @c @center ----------
|
|
|
2204 @c @center HTML 2.0
|
|
|
2205 @c @center ----------
|
|
|
2206 @c @end ifinfo
|
|
|
2207 @c @iftex
|
|
|
2208 @c @section HTML 2.0
|
|
|
2209 @c @end iftex
|
|
|
2210 @c @cindex HTML 2.0
|
|
|
2211
|
|
|
2212 @c :: WORK :: Reference to the HTML 2.0 RFC
|
|
|
2213 @c :: WORK :: Basic explanation of HTML, tag structure, etc.
|
|
|
2214
|
|
|
2215 @c @ifinfo
|
|
|
2216 @c @center ----------
|
|
|
2217 @c @center HTML 3.2
|
|
|
2218 @c @center ----------
|
|
|
2219 @c @end ifinfo
|
|
|
2220 @c @iftex
|
|
|
2221 @c @section HTML 3.2
|
|
|
2222 @c @end iftex
|
|
|
2223 @c @cindex HTML 3.2
|
|
|
2224 @c The HTML 3.2 language is an extension of HTML, with a large degree of
|
|
|
2225 @c backward compatibility with HTML 2.0. This basically documents current
|
|
|
2226 @c practice as of January, 1996.
|
|
|
2227
|
|
|
2228 @c @ifinfo
|
|
|
2229 @c @center ----------
|
|
|
2230 @c @center SGML Features
|
|
|
2231 @c @center ----------
|
|
|
2232 @c @end ifinfo
|
|
|
2233 @c @iftex
|
|
|
2234 @c @section SGML Features
|
|
|
2235 @c @end iftex
|
|
|
2236 @c @cindex SGML Features
|
|
|
2237 @c @cindex Entity Definitions
|
|
|
2238 @c @cindex Marked Sections
|
|
|
2239
|
|
|
2240 @c :: WORK :: Document marked sections, SGML features
|
|
|
2241
|
|
|
2242 @c @ifinfo
|
|
|
2243 @c @center ----------
|
|
|
2244 @c @center Extras
|
|
|
2245 @c @center ----------
|
|
|
2246 @c @end ifinfo
|
|
|
2247 @c @iftex
|
|
|
2248 @c @section Extra Markup
|
|
|
2249 @c @end iftex
|
|
|
2250 @c @cindex Easter Eggs
|
|
|
2251 @c @cindex Fluff
|
|
|
2252 @c @cindex Pomp & Circumstance
|
|
|
2253 @c There are several different markup elements that are not officially part
|
|
|
2254 @c of HTML or HTML 3.2 that Emacs-W3 supports. These are either items that
|
|
|
2255 @c were dropped from HTML 3.@var{x} after I had implemented them, things I
|
|
|
2256 @c find just completely hilarious, or experimental parts of HTML that
|
|
|
2257 @c should not be counted as "official" or long lived.
|
|
|
2258 @c @itemize @bullet
|
|
|
2259 @c @item
|
|
|
2260 @c FLAME support. For truly interesting dynamic documents. This is
|
|
|
2261 @c replaced with a random quote from Mr. Angry (see @kbd{M-x flame} for a
|
|
|
2262 @c sample).
|
|
|
2263 @c @item
|
|
|
2264 @c The top ten tags that did not make it into netscape. These tags were
|
|
|
2265 @c posted to the newsgroup comp.infosystems.www.misc by Laura Lemay
|
|
|
2266 @c (@i{lemay@@netcom.com}). Much thanks to her for the humor.
|
|
|
2267 @c @table @b
|
|
|
2268 @c @item <wired>...</wired>
|
|
|
2269 @c Renders the enclosed text in a suitably ugly font/color combination. If
|
|
|
2270 @c no default has been set up by the user, this is the default font, with
|
|
|
2271 @c red text on a yellow background.
|
|
|
2272 @c @item <roach>...</roach>
|
|
|
2273 @c When selected, the enclosed text runs and hides under the nearest
|
|
|
2274 @c window. OR, giggles a lot and demands nachos, depending on the
|
|
|
2275 @c definition of "roach." (the formal definition, of course, to be
|
|
|
2276 @c determined by the Official Honorary Internet Standards Committee For
|
|
|
2277 @c Moving Really Slowly.)
|
|
|
2278 @c @item <pinhead>
|
|
|
2279 @c Inserts "zippyisms" into the enclosed text. Perfect for those professional
|
|
|
2280 @c documents. This is sure to be a favorite of mine!
|
|
|
2281 @c @item <secret>...</secret>
|
|
|
2282 @c Must use secret spy decoder glasses (available direct from Netscape for
|
|
|
2283 @c a reasonable fee) in order to read the enclosed text. Can also be read
|
|
|
2284 @c by holding the computer in front of a full moon during the autumn
|
|
|
2285 @c solstice.
|
|
|
2286
|
|
|
2287 @c In Emacs-W3, this displays the text using rot13 encoding.
|
|
|
2288 @c @item <hype>
|
|
|
2289 @c Causes Marc Andreesen to magically appear and grant an interview (wanted
|
|
|
2290 @c or not). Please use this tag sparingly.
|
|
|
2291 @c @item <peek>....</peek>
|
|
|
2292 @c @item <poke>...</poke>
|
|
|
2293 @c Need more control over screen layout in HTML? Well, here ya go.
|
|
|
2294 @c n
|
|
|
2295 @c Actually, <peek> could almost be considered useful. The VARIABLE
|
|
|
2296 @c attribute can be used to insert the value of an emacs variable into the
|
|
|
2297 @c current document. Things like 'Welcome to my page, <peek
|
|
|
2298 @c variable=user-mail-address>' can be useful in spreading fear,
|
|
|
2299 @c uncertainty, and doubt among users.
|
|
|
2300 @c @item <yogsothoth>
|
|
|
2301 @c @cindex Gates Bill
|
|
|
2302 @c @cindex Yogsothoth
|
|
|
2303 @c Summons the elder gods to suck away your immortal soul. Or Bill Gates,
|
|
|
2304 @c if the elder gods are busy. Unpredictable (but amusing) results occur
|
|
|
2305 @c when the <YOGSOTHOTH> and <HYPE> tags are used in close proximity.
|
|
|
2306
|
|
|
2307 @c @item <blink>...</blink>
|
|
|
2308 @c Causes the enclosed text to .... ooops that one made it in.
|
|
|
2309 @c @end table
|
|
|
2310 @c @end itemize
|
|
|
2311
|
|
|
2312 @c @node Stylesheets, Supported Protocols, Markup Languages Supported,Introduction
|
|
|
2313 @c @chapter Stylesheets
|
|
|
2314 @c @cindex Stylesheets
|
|
|
2315 @c @cindex Cascading Style Sheets
|
|
|
2316 @c @cindex Aural Cascading Style Sheets
|
|
|
2317 @c @cindex CSS
|
|
|
2318 @c @cindex DSSSL
|
|
|
2319 @c :: WORK :: Document CSS support
|
|
|
2320 @c CSS Information at http://www.w3.org/pub/WWW/TR/REC-CSS1
|
|
|
2321 @c Style guide at http://www.htmlhelp.com/reference/css/
|
|
|
2322 @c :: WORK :: Document ACSS support
|
|
|
2323 @c ACSS Information at http://www.w3.org/pub/WWW/Style/CSS/Speech/NOTE-ACSS
|
|
|
2324 @c :: WORK :: Document DSSSL support
|
|
|
2325
|
|
|
2326 @c @node Supported Protocols, , Stylesheets, Introduction
|
|
|
2327 @c @chapter Supported Protocols
|
|
|
2328 @c @cindex Network Protocols
|
|
|
2329 @c @cindex Protocols Supported
|
|
|
2330 @c @cindex Supported Protocols
|
|
|
2331 @c Emacs-W3 supports the following protocols
|
|
|
2332 @c @table @b
|
|
|
2333 @c @item Usenet News
|
|
|
2334 @c Can either display an entire newsgroup or specific articles by
|
|
|
2335 @c Message-ID: header. Instead of rewriting a newsreader, this integrates
|
|
|
2336 @c with the Gnus newsreader. It requires at least Gnus 5.0, but it is
|
|
|
2337 @c always safest to use the latest version. Gnus supports some very
|
|
|
2338 @c advanced features, including virtual newsgroups, mail and news
|
|
|
2339 @c integration, and reading news from multiple servers. @inforef{Gnus,
|
|
|
2340 @c Top,gnus}, for more info.
|
|
|
2341
|
|
|
2342 @c To be more in line with the other @sc{url} schemes, the hostname and port of
|
|
|
2343 @c an @sc{nntp} server can be specified. @sc{url}s of the form
|
|
|
2344 @c news://hostname:port/messageID work, but might not work in some other
|
|
|
2345 @c browsers.
|
|
|
2346
|
|
|
2347 @c @item @sc{http}
|
|
|
2348 @c Supports the @sc{http}/0.9, @sc{http}/1.0, and parts of the @sc{http}/1.1 protocols.
|
|
|
2349 @c @item Gopher
|
|
|
2350 @c Support for all gopher types, including CSO queries.
|
|
|
2351 @c @item Gopher+
|
|
|
2352 @c Support for Gopher+ retrievals. Support for converting ASK blocks into
|
|
|
2353 @c HTML forms and submitting them back to the server.
|
|
|
2354 @c @item @sc{ftp}
|
|
|
2355 @c @sc{ftp} is handled by either ange-ftp or efs.
|
|
|
2356 @c @inforef{Ange-FTP,Top,ange-ftp}, for more information on Ange-FTP, or
|
|
|
2357 @c @inforef{EFS, Top,efs}, for information on EFS.
|
|
|
2358 @c @item Local files
|
|
|
2359 @c Local files are of course handled, and MIME content-types are derived
|
|
|
2360 @c from the file extensions.
|
|
|
2361 @c @item telnet, tn3270, rlogin
|
|
|
2362 @c Telnet, tn3270, and rogin are handled by running the appropriate program
|
|
|
2363 @c in an emacs buffer, or running an external process.
|
|
|
2364 @c @item mailto
|
|
|
2365 @c Causes a mail message to be started to a specific address. Supports the
|
|
|
2366 @c Netscape @i{extensions} to specify arbitrary headers on the message.
|
|
|
2367 @c @item data
|
|
|
2368 @c A quick and easy way to `inline' small pieces of information that you do
|
|
|
2369 @c not necessarily want to download over the net separately. Can speed up
|
|
|
2370 @c display of small icons, stylesheet information, etc. See the internet
|
|
|
2371 @c draft draft-masinter-url-data-02.txt for more information.
|
|
|
2372 @c @item mailserver
|
|
|
2373 @c A more powerful version of mailto, which allows the author to specify
|
|
|
2374 @c the subject and body text of the mail message. This type of link is
|
|
|
2375 @c never fully executed without user confirmation, because it is possible
|
|
|
2376 @c to insert insulting or threatening (and possibly illegal) data into the
|
|
|
2377 @c message. The mail message is displayed, and the user must confirm the
|
|
|
2378 @c message before it is sent.
|
|
|
2379 @c @item x-exec
|
|
|
2380 @c A @sc{url} can cause a local executable to be run, and its output interpreted
|
|
|
2381 @c as if it had come from an @sc{http} server. This is very useful, but is
|
|
|
2382 @c still an experimental protocol, hence the X- prefix. This @sc{url} protocol
|
|
|
2383 @c is deprecated, but might be useful in the future.
|
|
|
2384 @c @item @sc{nfs}
|
|
|
2385 @c Retrieves information over @sc{nfs}. This requires that your operating
|
|
|
2386 @c system support auto-mounting of @sc{nfs} volumes.
|
|
|
2387 @c @item finger
|
|
|
2388 @c Retrieves information about a user via the 'finger' protocol.
|
|
|
2389 @c @item Info
|
|
|
2390 @c Creates a link to an GNU-style info file. @inforef{Info,Top,info}, for more
|
|
|
2391 @c information on the Info format.
|
|
|
2392 @c @item SSL
|
|
|
2393 @c SSL requires a set of patches to the Emacs C code and SSLRef 2.0, or an
|
|
|
2394 @c external program to run in a subprocess (similar to the @file{tcp.el}
|
|
|
2395 @c package that comes with GNUS. @xref{Installing SSL}
|
|
|
2396 @c @end table
|
|
|
2397
|
