Display
=======
Emacs/W3 has many variable for you to fiddle with to get the display
just right.
`w3-display-frames'
You can control what Emacs/W3 does with frame by setting
`w3-display-frames'. It can be
`nil'
Emacs/W3 will pretend not to understand frames at all.
`as-nil'
Emacs/W3 will show hyperlinks to frames but will not fetch
them (the same behaviour as lynx).
`ask'
This is similar to `as-nil', but Emacs/W3 will ask if you
want to retrieve the frames.
`t'
Emacs/W3 will dispaly the hyperlinks and fetch the frames.
`w3-bullets'
Emacs/W3 lets *you* decide what characters to use for bullets in
unordered lists by setting `w3-bullets'. It is a association list,
mapping list types to characters. By default it is `((disc . ?*)
(circle . ?o) (square . ?#) (none . ? ))'.
`w3-echo-link'
You can decide what should be displayed when tabbing through links
by setting the `w3-echo-link' variable. It is a list and may
contain the following symbols,
`url'
Display the URL of the target.
`text'
Display the text of the link.
`title'
Display the title attribute of the link.
`name'
Display the name or id attribute of the link.
The default is `(title url text name)'.
`w3-horizontal-rule-char'
Many HTML pages use horizontal lines (rules) to seperate sections
of the page. You can control what character Emacs/W3 will use to
draw these by setting `w3-horizontal-rule-char'. If it is a
character (*not* a string) then Emacs/W3 will replicate that
character across the screen, if it is `nil' then Emacs/W3 will use
a terminal graphics character if possible. It is `nil by default'.
`w3-use-terminal-characters'
When Emacs/W3 draws table and rules, it needs to approximate line
somehow. If `w3-use-terminal-characters' it `non-nil' (the
default) then Emacs/W3 will use terminal graphics characters if
they are available.
`w3-use-terminal-characters-on-tty'
Using terminal graphics characters on ttys will trigger display
bugs in both XEmacs and FSF Emacs, but the display is usually
readable with FSF Emacs. `w3-use-terminal-characters-on-tty'
controls whether to use terminal graphics characters on ttys, it
is `nil' by default.
`w3-use-terminal-glyphs'
Emacs/W3 can use glyphs rather than text properties for terminal
graphics characters. Glyphs do not work with the most recent
versions of XEmacs. This is `t' by default.
`w3-defined-link-types'
`w3-defined-link-types' is a list of names that have special
significance as the values of `REL' or `REV' attributes of <link>
elements. All members should be in lowercase.
`w3-auto-image-alt'
Some people do not feel it's worth their time to add `alt' tags to
their images, but Emacs/W3 can create `alt' tags on the fly for
images that do not have them. To control this you can set
`w3-auto-image-alt' to one of the following:
`nil'
Do not create `alt' tags
string
The string will be run through format with the filename of
the image and so may have a single `%s', for example
`"[IMAGE(%s)]"'
function
The function will be called with the filename of the images
as the argument. This is the default, with
`w3-default-image-alt-func' being the function.
`w3-min-img-size, w3-default-image-alt-func, w3-dummy-img-alt-repl'
`w3-default-image-alt-func' returns `w3-dummy-img-alt-repl' (`*'
by default) if the image's height and width are both less than
`w3-min-img-size' pixels (15 by default) and if the filename
matches the `w3-dummy-img-re' regular expression
(`"\\b\\(boule\\|bullet\\|dot\\|pebble[0-9]*[a-z]?[0-9]*\\|pixel\\)\\b"'
by default). Otherwise, `w3-default-image-alt-func' returns the
filename enclosed in a `[]' pair.
`w3-icon-directory'
Emacs/W3 will look for standard icons in the directory specified by
`w3-icon-directory'. It must end in a slash and is
`http://cs.indiana.edu/elisp/w3/icons/' by default.
`w3-icon-format'
Emacs/W3 will expect the standard icons to be in the format
specified by `w3-icon-format'. This is `gif' by default, but
could be `xpm', `xbm' or any other format for that matter. It is
added as a file extension to the icon name, but the variable's
value must be a symbol. If `nil', then the server decides.
`w3-delay-image-loads'
You can choose whether Emacs/W3 retrieves images with the
document, or delays loading them by setting
`w3-delay-image-loads'. By default this is `t' if you compiled
XEmacs with support for gifs, jpegs, pngs or imagick and `nil'
otherwise.
`w3-image-mappings'
`w3-image-mappings' controls the mapping of MIME types to image
types for the `image' package. Each entry is a cons cell of a
MIME type string and an image-type symbol.
`w3-max-menu-length'
Emacs/W3 will split menus into smaller submenus if they are longer
than `w3-max-menu-length'.
`w3-max-menu-width'
The maximum width of a pulldown menu choice.
`w3-right-margin'
Emacs/W3's right margin is controlled by `w3-right-margin'. This
is subtracted from `(window-width)' for each Emacs/W3 buffer and
used as the fill-column. It is 2 by default.
`w3-maximum-line-length'
The maximum length of a line. If `nil' (the default) then lines
can extend to the window margin.
`w3-modeline-format'
You can specify the modeline to use in `w3-mode' by setting this.
`w3-honor-stylesheets'
If this is non-`nil' (the default) then Emacs/W3 will let a
document specify a CSS stylesheet.
`w3-user-colors-take-precedence'
Emacs/W3 will ignore a document's attempts to define certain
colours if `w3-user-colors-take-precedence' it non-`nil'. The
default is `nil'.
`w3-user-fonts-take-precedence'
Emacs/W3 will ignore attempts by stylesheets or font tags to change
certain fonts if this is non-`nil'.
Asynchronous behaviour
----------------------
`url-be-asynchronous'
If this is non-`nil' then document retrievals over HTTP will be
down in the background.
`url-default-retrieval-proc'
This controls what happens when an asynchronous retrievel
completes. It is `url-default-callback' by default but can be any
function taking one argument. The argument specifies the file
that has been retrieved. If there is no buffer associated with
the file, then `url-default-callback' just puts a message in the
minibuffer saying that the retrieval is complete, otherwise the
action depends on the buffer.
`w3-do-incremental-display'
Emacs/W3 can de incremental display of pages if
`w3-do-incremental-display' is `t'. It is `nil' by default.
`w3-notify'
You might want Emacs/W3 to notify you discreetly when it has
finished preparing a page for your reading pleasure. You can
control Emacs/W3's behaviour in this situation by way of the
`w3-notify' variable. It may take the following values:
`newframe'
Puts the Emacs/W3 page in its own frame.
`bully'
Make the Emacs/W3 page the current buffer and only window.
`semibully'
Make the Emacs/W3 page the current buffer in the same window.
This is the default.
`aggressive'
Make the Emacs/W3 page the current buffer in the other window.
`friendly'
Display the Emacs/W3 page in the other window, but don't make
it the current buffer.
`polite'
Don't display Emacs/W3 page, but print a message when ready
and beep.
`quiet'
The same as `polite', but don't beep.
`meek'
Make no indication that the page is ready, in fact any other
value is equivalent to meek.