From: Glenn Morris Date: Fri, 4 Jan 2013 09:39:40 +0000 (-0800) Subject: * doc/misc/htmlfontify.texi: Miscellaneous fixes and updates. X-Git-Url: http://git.hcoop.net/bpt/emacs.git/commitdiff_plain/b55349fbd859656ee4747f261f90b56d01d4084c * doc/misc/htmlfontify.texi: Miscellaneous fixes and updates. Set copyright to FSF, update license to GFDL 1.3+. --- diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index fe1d81e77e..a7afa9a1cd 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,8 @@ +2013-01-04 Glenn Morris + + * htmlfontify.texi: Miscellaneous fixes and updates. + Set copyright to FSF, update license to GFDL 1.3+. + 2013-01-04 Vivek Dasmohapatra * htmlfontify.texi: New file. diff --git a/doc/misc/htmlfontify.texi b/doc/misc/htmlfontify.texi index 03a849fab2..d690474077 100644 --- a/doc/misc/htmlfontify.texi +++ b/doc/misc/htmlfontify.texi @@ -1,35 +1,33 @@ \input texinfo -@c documentation for htmlfontify -@c written by Vivek Dasmohapatra - -@comment %**start of header (This is for running Texinfo on a region.) - -@setfilename htmlfontify.info +@comment %**start of header +@setfilename ../../info/htmlfontify @settitle Htmlfontify User Manual - -@dircategory Emacs -@direntry -* Htmlfontify: (htmlfontify). A source code -> linked html + css transformer -@end direntry - @exampleindent 2 -@comment %**end of header (This is for running Texinfo on a region.) - -@ifinfo - -This file documents Htmlfontify, a source code -> crosslinked + formatted + -syntax colourised html transformer. - -Copyright (c) 2002,2003 Vivek Dasmohapatra - -Permission is granted to copy, distribute and/or modify this -document under the terms of the GNU Free Documentation Licence, -Version 1.1 or any later version published by the Free Software -Foundation; with no Invariant Sections, no Front-Cover Texts and -no Back-Cover Texts. A copy of the licence is included in the -section entitled "GNU Free Documentation Licence". - -@end ifinfo +@comment %**end of header + +@copying +This manual documents Htmlfontify, a source code -> crosslinked + +formatted + syntax colorised html transformer. + +Copyright @copyright{} 2002, 2003, 2013 Free Software Foundation, Inc. + +@quotation +Permission is granted to copy, distribute and/or modify this document +under the terms of the GNU Free Documentation License, Version 1.3 or +any later version published by the Free Software Foundation; with no +Invariant Sections, with the Front-Cover texts being ``A GNU Manual,'' +and with the Back-Cover Texts as in (a) below. A copy of the license +is included in the section entitled ``GNU Free Documentation License''. + +(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and +modify this GNU manual.'' +@end quotation +@end copying + +@dircategory Emacs misc features +@direntry +* Htmlfontify: (htmlfontify). Convert source code to html. +@end direntry @titlepage @title Htmlfontify User Manual @@ -43,66 +41,64 @@ section entitled "GNU Free Documentation Licence". @vskip 0pt plus 1filll @noindent -Copyright @copyright{} 2002 Vivek Dasmohapatra +@insertcopying +@end titlepage -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation Licence, Version 1.1 or -any later version published by the Free Software Foundation; with no -Invariant Sections, no Front-Cover Texts and no Back-Cover Texts. A -copy of the licence is included in the section entitled "GNU Free -Documentation Licence". +@contents -@end titlepage -@page +@ifnottex +@node Top +@top Htmlfontify -@node Top, Introduction, (dir), (dir) +@insertcopying +@end ifnottex @menu * Introduction:: About Htmlfontify. * Usage & Examples:: How to use Htmlfontify. -* Customisation:: Fine tuning Htmlfontify's behaviour. +* Customisation:: Fine-tuning Htmlfontify's behaviour. * Requirements:: External programs used by Htmlfontify. -* Index:: Index of Contents. -* COPYING:: The GNU Free Documentation Licence. +* GNU Free Documentation License:: The license for this documentation. +* Index:: Index of contents. @end menu -@node Introduction, Usage & Examples, Top, Top +@node Introduction @chapter Introduction @cindex Introduction -Htmlfontify provides a means of converting individual emacs buffers, -source files, or entire source trees to html, preserving formatting -and emacs colourisation / syntax highlighting as much as possible +Htmlfontify provides a means of converting individual Emacs buffers, +source files, or entire source trees to html, preserving formatting +and Emacs colorisation / syntax highlighting as much as possible through careful application of CSS stylesheets and html tags. -It can also turn instances of functions, methods and ( for some -languages ) variables and other constructs and items into links -to their definitions, and create an index file ( or files ) of +It can also turn instances of functions, methods and (for some +languages) variables and other constructs and items into links +to their definitions, and create an index file (or files) of all such symbols, also linked to their points of definition. -Htmlfontify also provides several customisation items, which should -allow it to mesh more-or-less seamlessly with various templating or -publishing systems ( in the event, for instance, that you don't want -to produce the html pages directly ). +Htmlfontify also provides several customisation items, which should +allow it to mesh more-or-less seamlessly with various templating or +publishing systems (in the event, for instance, that you don't want +to produce the html pages directly). -@node Usage & Examples, Customisation, Introduction, Top +@node Usage & Examples @chapter Usage & Examples @cindex Usage & Examples -Htmlfontify can be used both interactively and as part of another -elisp function. If you're running it in emacs21 ( its native land, -it were ), it will also run when attached to a terminal ( ie w/o X ) -or even when in batch mode. +Htmlfontify can be used both interactively and as part of another +elisp function. If you're running it in a modern Emacs, it will also +run when attached to a terminal (i.e., without X) or even when in +batch mode. @menu -* Interactive:: Using htmlfontify interactively. -* Non-interactive:: Using htmlfontify from elisp. +* Interactive:: Using Htmlfontify interactively. +* Non-interactive:: Using Htmlfontify from elisp. * Variables:: Variables (other than customisation entries). -* Data Structures:: Important Data Structures. -* Examples:: Example(s) of htmlfontify in use. +* Data Structures:: Important data structures. +* Examples:: Example(s) of Htmlfontify in use. @end menu -@node Interactive, Non-interactive, , Usage & Examples +@node Interactive @section Interactive @cindex Interactive @cindex functions (interactive) @@ -120,18 +116,18 @@ Htmlfontify provides the following interactive functions: @end lisp Create a new buffer, named for the current buffer + a .html extension, -containing an inline css-stylesheet and formatted css-markup html that -reproduces the look of the current emacs buffer as closely as possible. +containing an inline CSS-stylesheet and formatted CSS-markup html that +reproduces the look of the current Emacs buffer as closely as possible. -``Dangerous'' characters in the existing buffer are turned into html -entities, so you should even be able to do html-within-html fontified -display. +``Dangerous'' characters in the existing buffer are turned into html +entities, so you should even be able to do html-within-html fontified +display. You should, however, note that random control or eight-bit characters such as ^L (\x0c) or ยค (\xa4) won't get mapped yet. -If the @var{srcdir} and @var{file} arguments are set, lookup etags -derived entries in the @ref{hfy-tags-cache} and add html anchors +If the @var{srcdir} and @var{file} arguments are set, lookup etags +derived entries in the @ref{hfy-tags-cache} and add html anchors and hyperlinks as appropriate. @item htmlfontify-run-etags @@ -143,7 +139,7 @@ and hyperlinks as appropriate. (htmlfontify-run-etags @var{srcdir}) @end lisp -Load the etags cache for @var{srcdir}. See @ref{hfy-load-tags-cache}. +Load the etags cache for @var{srcdir}. See @ref{hfy-load-tags-cache}. @item htmlfontify-copy-and-link-dir @findex htmlfontify-copy-and-link-dir @@ -154,8 +150,8 @@ Load the etags cache for @var{srcdir}. See @ref{hfy-load-tags-cache}. (htmlfontify-copy-and-link-dir @var{srcdir} @var{dstdir} &optional @var{f-ext} @var{l-ext}) @end lisp -Trawl @var{srcdir} and write fontified-and-hyperlinked output in -@var{dstdir} @var{f-ext} and @var{l-ext} specify values for +Trawl @var{srcdir} and write fontified-and-hyperlinked output in +@var{dstdir}. @var{f-ext} and @var{l-ext} specify values for @ref{hfy-extn} and @ref{hfy-link-extn}. You may also want to set @ref{hfy-page-header} and @ref{hfy-page-footer}. @@ -169,15 +165,15 @@ You may also want to set @ref{hfy-page-header} and @ref{hfy-page-footer}. (htmlfontify-load-rgb-file &optional @var{file}) @end lisp -Load an X11 style rgb.txt file (search @code{hfy-rgb-load-path} if +Load an X11 style rgb.txt file (search @code{hfy-rgb-load-path} if @var{file} is not specified). Note that this is not necessary if all you want is the standard X11 -(XFree86 4.1.0) colour name -> rgb triplet mapping, htmlfontify has +(XFree86 4.1.0) color name -> rgb triplet mapping. Htmlfontify has a copy built in, for use when it cannot contact an X server. -Loads the variable @code{hfy-rgb-txt-colour-map}, which is used by -@ref{hfy-fallback-colour-values}. +Loads the variable @code{hfy-rgb-txt-color-map}, which is used by +@ref{hfy-fallback-color-values}. @item htmlfontify-unload-rgb-file @findex htmlfontify-unload-rgb-file @@ -188,15 +184,15 @@ Loads the variable @code{hfy-rgb-txt-colour-map}, which is used by (htmlfontify-unload-rgb-file) @end lisp -Unload the currently loaded X11 style rgb.txt file ( if any ). +Unload the currently loaded X11 style rgb.txt file (if any). @end table -@node Non-interactive, Variables, Interactive, Usage & Examples +@node Non-interactive @section Non-interactive @cindex Noninteractive @cindex functions (noninteractive) -In addition to the aforementioned interactive methods, htmlfontify +In addition to the aforementioned interactive methods, Htmlfontify provides the following non-interactive ones: @table @code @@ -212,23 +208,23 @@ provides the following non-interactive ones: @end lisp Take @var{fn}, a font or @code{defface} style font specification, -(as returned by @code{face-attr-construct} or @ref{hfy-face-attr-for-class}) +(as returned by @code{face-attr-construct} or @ref{hfy-face-attr-for-class}) and return a @ref{hfy-style-assoc}. See also: @ref{hfy-face-to-style-i}, @ref{hfy-flatten-style}. -@item hfy-fallback-colour-values -@findex hfy-fallback-colour-values -@anchor{hfy-fallback-colour-values} +@item hfy-fallback-color-values +@findex hfy-fallback-color-values +@anchor{hfy-fallback-color-values} @lisp -(hfy-fallback-colour-values @var{colour-string}) +(hfy-fallback-color-values @var{color-string}) @end lisp -Use a fallback method for obtaining the rgb values for a colour. +Use a fallback method for obtaining the rgb values for a color. If @ref{htmlfontify-load-rgb-file} has been called, it uses the -colour map specified, otherwise it uses htmlfontify's built in map. +color map specified, otherwise it uses Htmlfontify's built in map. @item hfy-combined-face-spec @findex hfy-combined-face-spec @@ -239,8 +235,8 @@ colour map specified, otherwise it uses htmlfontify's built in map. (hfy-combined-face-spec @var{face}) @end lisp -Return a @code{defface} style alist of possible specifications for -@var{face}, with any entries resulting from user customisation +Return a @code{defface} style alist of possible specifications for +@var{face}, with any entries resulting from user customisation (@code{custom-set-faces}) taking precedence. See also: @ref{hfy-default-face-def} @@ -254,8 +250,8 @@ See also: @ref{hfy-default-face-def} (hfy-word-regex @var{string}) @end lisp -Return a regex that matches @var{string} as the first @code{match-string}, -with non word characters on either side (vaguely emulating the perl @code{\b} +Return a regex that matches @var{string} as the first @code{match-string}, +with non word characters on either side (vaguely emulating the perl @code{\b} regex atom). @item hfy-force-fontification @@ -267,16 +263,16 @@ regex atom). (hfy-force-fontification) @end lisp -Emacs' fontification is designed for interactive use. As such, it sometimes -does things like deferring fontification until a section of the buffer is -exposed and rendered, or until emacs is idle for a while. Sometimes, in -non-interactive circumstances, or if it can't see X, it doesn't bother -with some of the harder stuff. While this is all great from the perspective -of a user waiting for emacs to load a 20000 line file and colourise it, -it's a pain from the point of view from non-interactive code. This function -lies, cheats, steals and generally bullies emacs into fontifying a buffer +Emacs's fontification is designed for interactive use. As such, it sometimes +does things like deferring fontification until a section of the buffer is +exposed and rendered, or until Emacs is idle for a while. Sometimes, in +non-interactive circumstances, or if it can't see X, it doesn't bother +with some of the harder stuff. While this is all great from the perspective +of a user waiting for Emacs to load a 20000 line file and colorise it, +it's a pain from the point of view from non-interactive code. This function +lies, cheats, steals and generally bullies Emacs into fontifying a buffer from start to finish, with all the extra frills, whether it thinks it nneds -to or not. Oh yes: it operates on the current buffer. +to or not. Oh yes: it operates on the current buffer. @item hfy-link-style-string @findex hfy-link-style-string @@ -287,8 +283,8 @@ to or not. Oh yes: it operates on the current buffer. (hfy-link-style-string @var{style-string}) @end lisp -Replace the end of a css style declaration @var{style-string} with the contents -of the variable @ref{hfy-src-doc-link-style}, removing text matching the +Replace the end of a CSS style declaration @var{style-string} with the contents +of the variable @ref{hfy-src-doc-link-style}, removing text matching the regex @ref{hfy-src-doc-link-unstyle} first, if necessary. @@ -302,8 +298,8 @@ regex @ref{hfy-src-doc-link-unstyle} first, if necessary. @end lisp Prepare a tags index buffer for @var{srcdir}. -@ref{hfy-tags-cache} must already have an entry for @var{srcdir} for -this to work. @ref{hfy-page-header}, @ref{hfy-page-footer}, +@ref{hfy-tags-cache} must already have an entry for @var{srcdir} for +this to work. @ref{hfy-page-header}, @ref{hfy-page-footer}, @ref{hfy-link-extn} and @ref{hfy-extn} all play a part here. If @var{stub} is set, prepare an (appropriately named) index buffer @@ -331,8 +327,8 @@ Trawl the current buffer, construct and return a @ref{hfy-sheet-assoc}. (hfy-css-name @var{fn}) @end lisp -Strip some of the boring bits from a font-name and return a css style -name. If @var{fn} is a @code{defface} attribute list, either construct +Strip some of the boring bits from a font-name and return a CSS style +name. If @var{fn} is a @code{defface} attribute list, either construct a name for it, store it in the cache, and return it, or just fetch it from the cache if it's already there. @@ -345,7 +341,7 @@ from the cache if it's already there. (hfy-make-directory @var{dir}) @end lisp -Approx equivalent of mkdir -p @var{dir} +Approximate equivalent of @code{mkdir -p @var{dir}}. @item hfy-triplet @findex hfy-triplet @@ -353,14 +349,14 @@ Approx equivalent of mkdir -p @var{dir} @lisp -(hfy-triplet @var{colour}) +(hfy-triplet @var{color}) @end lisp -Takes a colour name (string) and return a CSS rgb(R, G, B) triplet string. -Uses the definition of "white" to map the numbers to the 0-255 range, so -if you've redefined white, (esp if you've redefined it to have a triplet -member lower than that of the colour you are processing, strange things -may happen). +Takes a color name (string) and return a CSS rgb(R, G, B) triplet string. +Uses the definition of ``white'' to map the numbers to the 0-255 range, so +if you've redefined white, (especially if you've redefined it to have +a triplet member lower than that of the color you are processing, +strange things may happen). @item hfy-default-footer @findex hfy-default-footer @@ -383,20 +379,20 @@ Default value for @ref{hfy-page-footer} @end lisp Return a list of files under @var{directory}. -Strips any leading "./" from each filename. +Strips any leading @samp{./} from each filename. -@item hfy-colour-vals -@findex hfy-colour-vals -@anchor{hfy-colour-vals} +@item hfy-color-vals +@findex hfy-color-vals +@anchor{hfy-color-vals} @lisp -(hfy-colour-vals @var{colour}) +(hfy-color-vals @var{color}) @end lisp -Where @var{colour} is a colour name or #XXXXXX style triplet, return a list of -3 (16 bit) rgb values for said colour. If a window system is unavailable, -calls @ref{hfy-fallback-colour-values}. +Where @var{color} is a color name or #XXXXXX style triplet, return a list of +3 (16 bit) rgb values for said color. If a window system is unavailable, +calls @ref{hfy-fallback-color-values}. @item hfy-href-stub @findex hfy-href-stub @@ -407,17 +403,17 @@ calls @ref{hfy-fallback-colour-values}. (hfy-href-stub @var{this-file} @var{def-files} @var{tag}) @end lisp -Return an href stub for a tag href: if @var{def-files} (list of files +Return an href stub for a tag href: if @var{def-files} (list of files containing definitions for the tag in question) contains only one entry, -the href should link straight to that file. Otherwise, the link should +the href should link straight to that file. Otherwise, the link should be to the index file. -We are not yet concerned with the file extensions/tag line number and +We are not yet concerned with the file extensions/tag line number and so on at this point. -If @ref{hfy-split-index} is set, and the href wil be to an index file -rather than a source file, append a .X to @ref{hfy-index-file}, where -X is the uppercased first character of @var{tag}. +If @ref{hfy-split-index} is set, and the href will be to an index file +rather than a source file, append a @samp{.X} to @ref{hfy-index-file}, where +@samp{X} is the uppercased first character of @var{tag}. See also: @ref{hfy-relstub}, @ref{hfy-index-file}. @@ -441,7 +437,7 @@ Returns the line number of the point in the current buffer. (hfy-merge-adjacent-spans @var{face-map}) @end lisp -Where @var{face-map} is a @ref{hfy-facemap-assoc} for the current buffer, +Where @var{face-map} is a @ref{hfy-facemap-assoc} for the current buffer, this function merges adjacent style blocks which are of the same value and are separated by nothing more interesting than whitespace. @@ -462,8 +458,8 @@ Returns a modified copy of @var{face-map} (also a @ref{hfy-facemap-assoc}). (hfy-mark-tag-names @var{srcdir} @var{file}) @end lisp -Mark tags in @var{file} (lookup @var{srcdir} in @ref{hfy-tags-cache}) with the -'hfy-anchor property, with a value of "tag.line-number". +Mark tags in @var{file} (lookup @var{srcdir} in @ref{hfy-tags-cache}) with the +@code{hfy-anchor} property, with a value of @samp{tag.line-number}. @item hfy-weight @findex hfy-weight @@ -474,7 +470,7 @@ Mark tags in @var{file} (lookup @var{srcdir} in @ref{hfy-tags-cache}) with the (hfy-weight @var{weight}) @end lisp -Derive a font-weight css specifier from an emacs weight spec symbol. +Derive a font-weight CSS specifier from an Emacs weight specification symbol. @item hfy-size @findex hfy-size @@ -485,7 +481,7 @@ Derive a font-weight css specifier from an emacs weight spec symbol. (hfy-size @var{height}) @end lisp -Derive a css font-size specifier from an emacs font :height attribute. +Derive a CSS font-size specifier from an Emacs font @code{:height} attribute. Does not cope with the case where height is a function to be applied to the height of the underlying font. @@ -509,7 +505,7 @@ Default value for @ref{hfy-page-header} (hfy-family @var{family}) @end lisp -Derives a css font-family specifier from an emacs :family attribute. +Derives a CSS font-family specifier from an Emacs @code{:family} attribute. @item hfy-mark-tag-hrefs @findex hfy-mark-tag-hrefs @@ -520,13 +516,13 @@ Derives a css font-family specifier from an emacs :family attribute. (hfy-mark-tag-hrefs @var{srcdir} @var{file}) @end lisp -Mark href start points with the 'hfy-link prop (value: href string) +Mark href start points with the @code{hfy-link} property (value: href string). -Mark href end points with the 'hfy-endl prop (value t) +Mark href end points with the @code{hfy-endl} property (value @code{t}). Avoid overlapping links, and mark links in descending length of -tag name in order to prevent subtags from usurping supertags, -(eg "term" for "terminal"). +tag name in order to prevent subtags from usurping supertags; +e.g., ``term'' for ``terminal''). @item hfy-box @findex hfy-box @@ -537,7 +533,7 @@ tag name in order to prevent subtags from usurping supertags, (hfy-box @var{box}) @end lisp -Derive CSS border-* attributes from the emacs :box attribute. +Derive CSS border-* attributes from the Emacs @code{:box} attribute. @item hfy-box-to-style @findex hfy-box-to-style @@ -548,9 +544,9 @@ Derive CSS border-* attributes from the emacs :box attribute. (hfy-box-to-style @var{spec}) @end lisp -Convert a complex :box emacs font attribute set to a list of CSS border-* -attributes. Don't call this directly - it is called by @ref{hfy-box} -when necessary. +Convert a complex @code{:box} Emacs font attribute set to a list of +CSS border-* attributes. Don't call this directly---it is called by +@ref{hfy-box} when necessary. @item hfy-html-enkludge-buffer @findex hfy-html-enkludge-buffer @@ -561,7 +557,7 @@ when necessary. (hfy-html-enkludge-buffer) @end lisp -Mark dangerous ["<>] characters with the 'hfy-quoteme property. +Mark dangerous @samp{["<>]} characters with the @code{hfy-quoteme} property. See also @ref{hfy-html-dekludge-buffer}. @@ -574,8 +570,8 @@ See also @ref{hfy-html-dekludge-buffer}. (hfy-buffer) @end lisp -Generate and return an htmlfontify html output buffer for the current -buffer. May trample an existing buffer. +Generate and return an Htmlfontify html output buffer for the current +buffer. May trample an existing buffer. @item hfy-fontified-p @findex hfy-fontified-p @@ -586,9 +582,9 @@ buffer. May trample an existing buffer. (hfy-fontified-p) @end lisp -@code{font-lock} doesn't like to say a buffer's been fontified when in -batch mode, but we want to know if we should fontify or raw copy, so in -batch mode we check for non-default face properties. Otherwise we test +@code{font-lock} doesn't like to say a buffer's been fontified when in +batch mode, but we want to know if we should fontify or raw copy, so in +batch mode we check for non-default face properties. Otherwise we test @code{font-lock-mode} and @code{font-lock-fontified} for truth. @item hfy-lookup @@ -600,7 +596,7 @@ batch mode we check for non-default face properties. Otherwise we test (hfy-lookup @var{face} @var{style}) @end lisp -Where @var{style} is a @ref{hfy-sheet-assoc} and @var{face} is an emacs face, +Where @var{style} is a @ref{hfy-sheet-assoc} and @var{face} is an Emacs face, return the relevant @var{css} style name. @item hfy-fontify-buffer @@ -612,18 +608,18 @@ return the relevant @var{css} style name. (hfy-fontify-buffer &optional @var{srcdir} @var{file}) @end lisp -Implement the guts of @ref{htmlfontify-buffer} +Implement the guts of @ref{htmlfontify-buffer}. -@item hfy-colour -@findex hfy-colour -@anchor{hfy-colour} +@item hfy-color +@findex hfy-color +@anchor{hfy-color} @lisp -(hfy-colour @var{colour}) +(hfy-color @var{color}) @end lisp -Convert an emacs :foreground property to a CSS colour property. +Convert an Emacs :foreground property to a CSS color property. @item hfy-flatten-style @findex hfy-flatten-style @@ -634,10 +630,10 @@ Convert an emacs :foreground property to a CSS colour property. (hfy-flatten-style @var{style}) @end lisp -Take @var{style} (see @ref{hfy-face-to-style-i}, @ref{hfy-face-to-style}) -and merge any multiple attributes appropriately. Currently only font-size is -merged down to a single occurrence - others may need special handling, but I -haven't encountered them yet. Returns a @ref{hfy-style-assoc}. +Take @var{style} (see @ref{hfy-face-to-style-i}, @ref{hfy-face-to-style}) +and merge any multiple attributes appropriately. Currently only font-size is +merged down to a single occurrence---others may need special handling, but I +haven't encountered them yet. Returns a @ref{hfy-style-assoc}. @item hfy-size-to-int @findex hfy-size-to-int @@ -648,8 +644,9 @@ haven't encountered them yet. Returns a @ref{hfy-style-assoc}. (hfy-size-to-int @var{spec}) @end lisp -Convert @var{spec}, a css font-size specifier, back to an emacs :height attribute -value. Used while merging multiple font-size attributes. +Convert @var{spec}, a CSS font-size specifier, back to an Emacs +@code{:height} attribute value. Used while merging multiple font-size +attributes. @item hfy-sprintf-stylesheet @findex hfy-sprintf-stylesheet @@ -660,8 +657,8 @@ value. Used while merging multiple font-size attributes. (hfy-sprintf-stylesheet @var{css} @var{file}) @end lisp -Generates a header, via @ref{hfy-page-header}, for @var{file}, containing the -stylesheet derived from @var{css}, which is a @ref{hfy-sheet-assoc}. Returns a +Generates a header, via @ref{hfy-page-header}, for @var{file}, containing the +stylesheet derived from @var{css}, which is a @ref{hfy-sheet-assoc}. Returns a string containing the same. @item hfy-relstub @@ -673,8 +670,8 @@ string containing the same. (hfy-relstub @var{file} &optional @var{start}) @end lisp -Return a "../" stub of the appropriate length for the current source -tree depth (as determined from @var{file}). iyswim. +Return a @samp{../} stub of the appropriate length for the current source +tree depth (as determined from @var{file}). @c iyswim. @item hfy-compile-face-map @findex hfy-compile-face-map @@ -708,9 +705,9 @@ Uses @ref{hfy-prepare-index-i} to do this. (hfy-prepare-tag-map @var{srcdir} @var{dstdir}) @end lisp -Prepare the counterpart(s) to the index buffer(s) - a list of buffers with -the same structure, but listing ( and linking to ) instances of tags ( as -opposed to their definitions ). +Prepare the counterpart(s) to the index buffer(s)---a list of buffers with +the same structure, but listing (and linking to) instances of tags (as +opposed to their definitions). See also: @ref{hfy-prepare-index}, @ref{hfy-split-index} @@ -723,7 +720,7 @@ See also: @ref{hfy-prepare-index}, @ref{hfy-split-index} (hfy-subtract-maps @var{srcdir}) @end lisp -Internal function - strips definitions of tags from the instance map. +Internal function---strips definitions of tags from the instance map. See: @ref{hfy-tags-cache} and @ref{hfy-tags-rmap} @item hfy-face-to-style-i @@ -735,12 +732,12 @@ See: @ref{hfy-tags-cache} and @ref{hfy-tags-rmap} (hfy-face-to-style-i @var{fn}) @end lisp -The guts of @ref{hfy-face-to-style}: @var{fn} should be a @code{defface} -font specification, as returned by @code{face-attr-construct} or -@ref{hfy-face-attr-for-class}. Note that this function does not get -font-sizes right if they are based on inherited modifiers (via the -:inherit) attribute, and any other modifiers that are cumulative if they -appear multiple times need to be merged by the user - @ref{hfy-flatten-style} +The guts of @ref{hfy-face-to-style}. @var{fn} should be a @code{defface} +font specification, as returned by @code{face-attr-construct} or +@ref{hfy-face-attr-for-class}. Note that this function does not get +font-sizes right if they are based on inherited modifiers (via the +:inherit) attribute, and any other modifiers that are cumulative if they +appear multiple times need to be merged by the user---@ref{hfy-flatten-style} should do this. @item hfy-face-to-css @@ -752,7 +749,7 @@ should do this. (hfy-face-to-css @var{fn}) @end lisp -Take @var{fn}, a font or @code{defface} specification (cf. +Take @var{fn}, a font or @code{defface} specification (c.f. @code{face-attr-construct}) and return a CSS style specification. See also: @ref{hfy-face-to-style} @@ -766,7 +763,8 @@ See also: @ref{hfy-face-to-style} (hfy-html-quote @var{char-string}) @end lisp -Map a string (usu. 1 char long) to an html safe string (entity) if need be. +Map a string (usually 1 character long) to an html safe string +(entity) if need be. @item hfy-link-style @findex hfy-link-style @@ -777,7 +775,7 @@ Map a string (usu. 1 char long) to an html safe string (entity) if need be. (hfy-link-style @var{style-string}) @end lisp -Convert the CSS style spec @var{style-string} to it's equivalent +Convert the CSS style spec @var{style-string} to its equivalent hyperlink style. See: @ref{hfy-link-style-fun}. @@ -791,7 +789,7 @@ See: @ref{hfy-link-style-fun}. (hfy-p-to-face @var{props}) @end lisp -Given @var{props}, a list of text-properties, return the value of the +Given @var{props}, a list of text-properties, return the value of the face property, or nil. @item hfy-box-to-border-assoc @@ -814,18 +812,18 @@ Helper function for @ref{hfy-box-to-style}. (hfy-face-attr-for-class @var{face} &optional @var{class}) @end lisp -Return the face attributes for @var{face}. If @var{class} is set, it -must be a @code{defface} alist key [see below]. Prior to version 0.18, -the first face specification returned by @ref{hfy-combined-face-spec} -which @emph{didn't} clash with @var{class} was returned. In versions -from 0.18 onwards, each font attribute list is scored, and the -non-conflicting list with the highest score is returned. ( A specification -with a class of @code{t} is considered to match any class you specify: -This matches emacs' behaviour when deciding on which face attributes to +Return the face attributes for @var{face}. If @var{class} is set, it +must be a @code{defface} alist key [see below]. Prior to version 0.18, +the first face specification returned by @ref{hfy-combined-face-spec} +which @emph{didn't} clash with @var{class} was returned. In versions +from 0.18 onwards, each font attribute list is scored, and the +non-conflicting list with the highest score is returned. (A specification +with a class of @code{t} is considered to match any class you specify. +This matches Emacs's behaviour when deciding on which face attributes to use, to the best of my understanding ). -If @var{class} is nil, then you just get get whatever -@code{face-attr-construct} returns, ie the current specification in +If @var{class} is nil, then you just get get whatever +@code{face-attr-construct} returns; i.e., the current specification in effect for @var{face}. See @ref{hfy-display-class} for details of valid values for @var{class}. @@ -839,7 +837,7 @@ See @ref{hfy-display-class} for details of valid values for @var{class}. (hfy-face-at P) @end lisp -Find face in effect at point P. If overlays are to be considered +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 list of face properties instead of a face symbol. @@ -849,10 +847,10 @@ list of face properties instead of a face symbol. @lisp -(hfy-bgcol @var{colour}) +(hfy-bgcol @var{color}) @end lisp -As per @ref{hfy-colour} but for background colours. +As per @ref{hfy-color} but for background colors. @item hfy-kludge-cperl-mode @findex hfy-kludge-cperl-mode @@ -864,7 +862,7 @@ As per @ref{hfy-colour} but for background colours. @end lisp cperl mode does its damndest not to do some of its fontification when not -in a windowing system - we try to trick it... +in a windowing system---we try to trick it@dots{} @item hfy-href @findex hfy-href @@ -893,7 +891,7 @@ Return a relative href to the tag in question, based on (hfy-shell) @end lisp -Returns a best guess at a bourne compatible shell to use: If the current +Returns a best guess at a Bourne compatible shell to use: If the current shell doesn't look promising, fall back to @ref{hfy-shell-file-name}. @item hfy-load-tags-cache @@ -928,7 +926,7 @@ Parse a @var{buffer} containing etags formatted output, loading the (hfy-interq @var{set-a} @var{set-b}) @end lisp -Return the intersection ( using @code{eq} ) of 2 lists. +Return the intersection (using @code{eq}) of 2 lists. @item hfy-text-p @findex hfy-text-p @@ -939,7 +937,7 @@ Return the intersection ( using @code{eq} ) of 2 lists. (hfy-text-p @var{srcdir} @var{file}) @end lisp -Is @var{srcdir}/@var{file} text? Uses @ref{hfy-istext-command} to determine this. +Is @var{srcdir}/@var{file} text? Uses @ref{hfy-istext-command} to determine this. @item hfy-opt @findex hfy-opt @@ -961,8 +959,8 @@ Is @ref{hfy-optimisations} member @var{symbol} set or not? (hfy-dirname @var{file}) @end lisp -Return everything preceding the last "/" from a relative filename, -on the assumption that this will produce a relative directory name. Hardly +Return everything preceding the last @samp{/} from a relative filename, +on the assumption that this will produce a relative directory name. Hardly bombproof, but good enough in the context in which it is being used. @item hfy-html-dekludge-buffer @@ -974,7 +972,7 @@ bombproof, but good enough in the context in which it is being used. (hfy-html-dekludge-buffer) @end lisp -Transform all dangerous characters marked with the 'hfy-quoteme property +Transform all dangerous characters marked with the @code{hfy-quoteme} property using @ref{hfy-html-quote} See also @ref{hfy-html-enkludge-buffer}. @@ -988,9 +986,9 @@ See also @ref{hfy-html-enkludge-buffer}. (hfy-copy-and-fontify-file @var{srcdir} @var{dstdir} @var{file}) @end lisp -open @var{file} in @var{srcdir} - if fontified, write a fontified copy to @var{dstdir} -adding an extension of @ref{hfy-extn}. Fontification is actually done by -@ref{htmlfontify-buffer}. If the buffer is not fontified, just copy it. +Open @var{file} in @var{srcdir}---if fontified, write a fontified copy to @var{dstdir} +adding an extension of @ref{hfy-extn}. Fontification is actually done by +@ref{htmlfontify-buffer}. If the buffer is not fontified, just copy it. @item hfy-decor @findex hfy-decor @@ -1001,7 +999,7 @@ adding an extension of @ref{hfy-extn}. Fontification is actually done by (hfy-decor @var{tag} @var{val}) @end lisp -Derive CSS text-decoration specifiers from various emacs font attributes. +Derive CSS text-decoration specifiers from various Emacs font attributes. @item hfy-slant @findex hfy-slant @@ -1012,9 +1010,9 @@ Derive CSS text-decoration specifiers from various emacs font attributes. (hfy-slant @var{slant}) @end lisp -Derive a font-style css specifier from the emacs :slant attribute - -CSS does not define the reverse-* styles, so just maps those to the -regular specifiers. +Derive a font-style CSS specifier from the Emacs :slant +attribute---CSS does not define the reverse-* styles, so just maps +those to the regular specifiers. @item hfy-tags-for-file @findex hfy-tags-for-file @@ -1025,7 +1023,7 @@ regular specifiers. (hfy-tags-for-file @var{srcdir} @var{file}) @end lisp -List of etags tags that have definitions in this @var{file}. Looks up +List of etags tags that have definitions in this @var{file}. Looks up the tags cache in @ref{hfy-tags-cache} using @var{srcdir} as the key. @item hfy-width @@ -1037,16 +1035,16 @@ the tags cache in @ref{hfy-tags-cache} using @var{srcdir} as the key. (hfy-width @var{width}) @end lisp -Convert an emacs :width attribute to a CSS font-stretch attribute. +Convert an Emacs @code{:width} attribute to a CSS font-stretch attribute. @comment /AUTOGENERATED BLOCK @end table -@node Variables, Data Structures, Non-interactive, Usage & Examples +@node Variables @section Variables @cindex variables -Important variables which are not customisation items: +Important variables that are not customisation items: @table @code @@ -1057,16 +1055,16 @@ Important variables which are not customisation items: This is an alist of the form: @example -(("/src/dir/0" . tag-hash0) ("/src/dir/1" tag-hash1) ...) +(("/src/dir/0" . tag-hash0) ("/src/dir/1" tag-hash1) @dots{} ) @end example Each tag hash entry then contains entries of the form: @example -"tag_string" => (("file/name.ext" line char) ... ) +"tag_string" => (("file/name.ext" line char) @dots{} ) @end example -ie an alist mapping (relative) file paths to line and character offsets. +i.e., an alist mapping (relative) file paths to line and character offsets. See @ref{hfy-load-tags-cache}. @@ -1096,7 +1094,7 @@ tagged items, not the locations of their definitions. @code{hfy-tags-sortl} is an alist of the form: @example -(("/src/dir" . (tag0 tag1 tag2)) ... ) +(("/src/dir" . (tag0 tag1 tag2)) @dots{} ) @end example Where the tags are stored in descending order of length. @@ -1105,7 +1103,7 @@ See: @ref{hfy-load-tags-cache}. @end table -@node Data Structures, Examples, Variables, Usage & Examples +@node Data Structures @section Data Structures @cindex Data Structures @@ -1117,11 +1115,11 @@ Some of the (informal) data structures used in Htmlfontify are detailed here: @cindex hfy-style-assoc @anchor{hfy-style-assoc} -An assoc representing/describing an emacs face. Properties may be repeated, -In which case later properties should be treated as if they were inherited -from a 'parent' font. (For some properties, only the first encountered value +An assoc representing/describing an Emacs face. Properties may be repeated, +in which case later properties should be treated as if they were inherited +from a ``parent'' font. (For some properties, only the first encountered value is of any importance, for others the values might be cumulative, and for -others they might be cumulative in a complex way). +others they might be cumulative in a complex way.) Some examples: @@ -1149,7 +1147,7 @@ Some examples: @cindex hfy-sheet-assoc @anchor{hfy-sheet-assoc} -An assoc with elements of the form (face-name style-name . stlye-string): +An assoc with elements of the form @samp{(face-name style-name . style-string)}. The actual stylesheet for each page is derived from one of these. @lisp @@ -1157,18 +1155,19 @@ The actual stylesheet for each page is derived from one of these. (font-lock-string-face "string" . "@{ color: rgb(64,224,208) @}")) @end lisp -@item hfy-facemap-assoc +@item hfy-facemap-assoc @cindex hfy-facemap-assoc @anchor{hfy-facemap-assoc} -An assoc of (point . @var{face-symbol}) or -(point . @code{defface} attribute list) and (point . 'end) elements, in -descending order of point value (ie from the file's end to its beginning). -The map is in reverse order because inserting a text to embed in the document- the string returned will -be used as the header for the htmlfontified version of the source file. +the @samp{} text to embed in the document---the string +returned will be used as the header for the htmlfontified version of +the source file. See also: @ref{hfy-page-footer} @@ -1338,7 +1338,7 @@ See also: @ref{hfy-page-footer} @vindex hfy-src-doc-link-style @anchor{hfy-src-doc-link-style} -String to add to the '