@comment %**start of header
@setfilename ../../info/htmlfontify.info
@settitle Htmlfontify User Manual
+@include docstyle.texi
@exampleindent 2
-@documentencoding UTF-8
@comment %**end of header
@copying
This manual documents Htmlfontify, a source code -> crosslinked +
formatted + syntax colorized html transformer.
-Copyright @copyright{} 2002-2003, 2013-2015 Free Software Foundation,
+Copyright @copyright{} 2002-2003, 2013-2016 Free Software Foundation,
Inc.
@quotation
(hfy-face-at P)
@end lisp
-Find face in effect at point P. If overlays are to be considered
-(see @ref{hfy-optimisations}) then this may return a @code{defface} style
+Find face in effect at point P@. If overlays are to be considered
+(see @ref{hfy-optimizations}) then this may return a @code{defface} style
list of face properties instead of a face symbol.
@item hfy-bgcol
(hfy-opt @var{symbol})
@end lisp
-Is @ref{hfy-optimisations} member @var{symbol} set or not?
+Is @ref{hfy-optimizations} member @var{symbol} set or not?
@item hfy-dirname
@findex hfy-dirname
The actual stylesheet for each page is derived from one of these.
@lisp
-'((default "default" . "@{ background: black; color: white@}")
- (font-lock-string-face "string" . "@{ color: rgb(64,224,208) @}"))
+((default "default" . "@{ background: black; color: white@}")
+ (font-lock-string-face "string" . "@{ color: rgb(64,224,208) @}"))
@end lisp
@item hfy-facemap-assoc
time.
@lisp
-'((64820 . end)
- (64744 . font-lock-comment-face)
- (64736 . end)
- (64722 . font-lock-string-face)
- (64630 . end)
- (64623 . font-lock-string-face)
- (64449 . end)
- ;; Big similar section elided. You get the idea.
- (5459 . end)
- (5431 . (:inherit font-lock-keyword-face :background "7e7e7e"))
- (5431 . end)
- (4285 . font-lock-constant-face)
- (4285 . end)
- (4221 . font-lock-comment-face)
- (4221 . end)
- (4197 . font-lock-constant-face)
- (4197 . end)
- (1 . font-lock-comment-face))
+((64820 . end)
+ (64744 . font-lock-comment-face)
+ (64736 . end)
+ (64722 . font-lock-string-face)
+ (64630 . end)
+ (64623 . font-lock-string-face)
+ (64449 . end)
+ ;; Big similar section elided. You get the idea.
+ (5459 . end)
+ (5431 . (:inherit font-lock-keyword-face :background "7e7e7e"))
+ (5431 . end)
+ (4285 . font-lock-constant-face)
+ (4285 . end)
+ (4221 . font-lock-comment-face)
+ (4221 . end)
+ (4197 . font-lock-constant-face)
+ (4197 . end)
+ (1 . font-lock-comment-face))
@end lisp
@end table
Some valid class specification elements are:
@lisp
- '(class color)
- '(class grayscale)
- '(background dark)
- '(background light)
- '(type x-toolkit)
- '(type tty)
- '(type motif)
- '(type lucid)
+ (class color)
+ (class grayscale)
+ (background dark)
+ (background light)
+ (type x-toolkit)
+ (type tty)
+ (type motif)
+ (type lucid)
@end lisp
Multiple values for a tag may be combined, to indicate that any one or more
-of these values in the specification key constitutes a match, eg:
+of these values in the specification key constitutes a match. For
+example, @code{((class color grayscale) (type tty))} would match any of:
-'((class color grayscale) (type tty)) would match any of:
@lisp
- '((class color))
- '((class grayscale))
- '((class color grayscale)))
- '((class color foo))
- '((type tty))
- '((type tty) (class color))
+ ((class color))
+ ((class grayscale))
+ ((class color grayscale)))
+ ((class color foo))
+ ((type tty))
+ ((type tty) (class color))
@end lisp
-and so on.
@item hfy-page-header
@vindex hfy-page-header
@anchor{hfy-page-header}
Function called with two arguments (the filename relative to the top
-level source directory being etag'd and fontified), and a string containing
+level source directory being etagged and fontified), and a string containing
the @samp{<style>@dots{}</style>} text to embed in the document---the string
returned will be used as the header for the htmlfontified version of
the source file.
@vindex hfy-find-cmd
@anchor{hfy-find-cmd}
-``find'' command used to harvest a list of files to attempt to fontify.
+The ``find'' command used to harvest a list of files to attempt to fontify.
@item hfy-extn
@vindex hfy-extn
Currently this is only required/used when using GNU etags, see
@ref{hfy-etags-cmd-alist} for details.
-@item hfy-optimisations
-@vindex hfy-optimisations
-@anchor{hfy-optimisations}
+@item hfy-optimizations
+@vindex hfy-optimizations
+@anchor{hfy-optimizations}
Optimizations to turn on. So far, the following have been implemented:
a page with different colors than the fontified code.)
@item keep-overlays
-Preserve overlay highlighting (c.f. @code{ediff} or @code{goo-font-lock})
+Preserve overlay highlighting (cf.@: @code{ediff} or @code{goo-font-lock})
as well as basic faces. Can result in extremely verbose highlighting
if there are many overlays (as is the case with @code{goo-font-lock}).