Commit b55349fb authored by Glenn Morris's avatar Glenn Morris
Browse files

* doc/misc/htmlfontify.texi: Miscellaneous fixes and updates.

Set copyright to FSF, update license to GFDL 1.3+.
parent 7fca93e2
2013-01-04 Glenn Morris <rgm@gnu.org>
* htmlfontify.texi: Miscellaneous fixes and updates.
Set copyright to FSF, update license to GFDL 1.3+.
2013-01-04 Vivek Dasmohapatra <vivek@etla.org>
* htmlfontify.texi: New file.
......
\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 <vivek@@etla.org>
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 <vivek@@etla.org>
@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})