Add an `Up' link to the HTML navigation bar of sufficiently deep documents.

[sgt/halibut] / doc / output.but

diff --git a/doc/output.but b/doc/output.but
index 08d1c6a..98637df 100644 (file)
--- a/doc/output.but
+++ b/doc/output.but
@@ -664,8 +664,10 @@ the index.
 
 \dt \I{\cw{\\cfg\{html-nav-next-text\}}}\cw{\\cfg\{html-nav-next-text\}\{}\e{text}\cw{\}}
 
-\dd The text used for the \q{previous page} and \q{next page} links on
-the navigation bar.
+\dt \I{\cw{\\cfg\{html-nav-up-text\}}}\cw{\\cfg\{html-nav-up-text\}\{}\e{text}\cw{\}}
+
+\dd The text used for the \q{previous page}, \q{next page}, and \q{up}
+links on the navigation bar.
 
 \dt \I{\cw{\\cfg\{html-nav-separator\}}}\cw{\\cfg\{html-nav-separator\}\{}\e{text}\cw{\}}
 
@@ -781,8 +783,9 @@ as in the navigation bar (with which this should not be confused).
 
 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.
+page. (Search engines can also make use of it.) 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
@@ -964,6 +967,7 @@ The \i{default settings} for Halibut's HTML output format are:
 \c \cfg{html-post-versionid}{]}
 \c \cfg{html-nav-prev-text}{Previous}
 \c \cfg{html-nav-next-text}{Next}
+\c \cfg{html-nav-up-text}{Up}
 \c \cfg{html-nav-separator}{ | }
 \c
 \c \cfg{html-output-charset}{ASCII}
@@ -973,7 +977,7 @@ 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-rellinks}{true}
 \c \cfg{html-suppress-navlinks{false}
 \c \cfg{html-suppress-address}{false}
 \c \cfg{html-author}{}