Minimal support for <LINK REL="next"> etc machine-readable navigation links.
[sgt/halibut] / doc / output.but
index df4580e..67827fc 100644 (file)
@@ -769,10 +769,32 @@ visibly in the \i\cw{<ADDRESS>} section at the bottom of each HTML
 file. If it is set to \c{false}, they will only be included as HTML
 comments.
 
+\dt \I{\cw{\\cfg\{html-rellinks\}}}\cw{\\cfg\{html-rellinks\}\{}\e{boolean}\cw{\}}
+
+\dd If this is set to \c{true}, machine-readable relational links will
+be emitted in each HTML file (\I{\cw{<LINK>} tags}\cw{<LINK
+REL="}\e{next}\cw{">} and so on within the \i\cw{<HEAD>} section)
+providing links to related files. The same set of links are provided
+as in the navigation bar (with which this should not be confused).
+
+\lcont{
+
+Some browsers make use of this semantic information, for instance to
+allow easy navigation through related pages, and to prefetch the next
+page. However, many browsers ignore this markup, so it would be unwise
+to rely on it for navigation.
+
+The use and rendering of this information is entirely up to the
+browser; none of the other Halibut options for the navigation bar will
+have any effect.
+
+}
+
 \dt \I{\cw{\\cfg\{html-suppress-navlinks\}}}\cw{\\cfg\{html-suppress-navlinks\}\{}\e{boolean}\cw{\}}
 
-\dd If this is set to \c{true}, the usual \i{navigation links} at the
-top of each HTML file will be suppressed.
+\dd If this is set to \c{true}, the usual \i{navigation links} within
+the \e{body} of each HTML file (near the top of the rendered page) will
+be suppressed.
 
 \dt \I{\cw{\\cfg\{html-suppress-address\}}}\cw{\\cfg\{html-suppress-address\}\{}\e{boolean}\cw{\}}
 
@@ -951,6 +973,8 @@ The \i{default settings} for Halibut's HTML output format are:
 \c \cfg{html-version}{html4}
 \c \cfg{html-template-fragment}{%b}
 \c \cfg{html-versionid}{true}
+\c \cfg{html-include-rellinks}{false}
+\c \cfg{html-suppress-navlinks{false}
 \c \cfg{html-suppress-address}{false}
 \c \cfg{html-author}{}
 \c \cfg{html-description}{}
@@ -1673,14 +1697,15 @@ built into all PDF and most PostScript implementations.  These are:
 
 \b \cw{Courier-BoldOblique}
 
-These fonts can be used without further formality.  To use any other font,
-Halibut needs at least to know its measurements, which are provided in an
-\i{Adobe Font Metrics} (\I{AFM files}AFM) file.  Halibut can also
-\I{embedding fonts}embed
-\i{Type 1 fonts} in its PDF and PostScript output if provided with an
-ASCII-format (\I{PFA files}PFA) font file.  To provide an AFM or PFA file
-to Halibut, simply name it on Halibut's command line.  If both are named,
-the AFM file must come first.
+These fonts can be used without further formality.  To use any other
+font, Halibut needs at least to know its measurements, which are
+provided in an \i{Adobe Font Metrics} (\I{AFM files}AFM) file.
+Halibut can also \I{embedding fonts}embed \i{Type 1 fonts} in its PDF
+and PostScript output if provided with font file in either hexadecimal (\I{PFA
+files}PFA) or IBM PC (\I{PFB files}PFB) format.  To provide
+an AFM, PFA, or PFB file to Halibut, simply name it on Halibut's command
+line.  If a PFA or PFB file is specified, the corresponding AFM file
+must come first.
 
 \ii{Font sizes} are specified in PostScript \i{points} (72 to the inch).