[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[no subject]
From: |
Gavin D. Smith |
Date: |
Wed, 2 Oct 2024 13:48:16 -0400 (EDT) |
branch: master
commit a6bd6d6fffc4bcc6b25d1174680c1ddfc5dd15ca
Author: Patrice Dumas <pertusus@free.fr>
AuthorDate: Wed Oct 2 18:48:08 2024 +0100
* doc/texinfo.texi (HTML Xref Configuration):
Add text explaining necessity of htmlxref.cnf. Mention
possibility of local htmlxref.cnf.
---
ChangeLog | 6 ++++++
doc/texinfo.texi | 13 +++++++++++++
2 files changed, 19 insertions(+)
diff --git a/ChangeLog b/ChangeLog
index 8a22aa1f4b..45077f55fd 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2024-10-02 Patrice Dumas <pertusus@free.fr>
+
+ * doc/texinfo.texi (HTML Xref Configuration):
+ Add text explaining necessity of htmlxref.cnf. Mention
+ possibility of local htmlxref.cnf.
+
2024-10-02 Gavin Smith <gavinsmith0123@gmail.com>
* NEWS: remove items that were in 7.1.1
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 838f63af3d..b9c45aceb0 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -17864,6 +17864,14 @@ web.
@cindex Cross-reference configuration, for HTML
@cindex Configuration, for HTML cross-manual references
+For other manuals published on the World Wide Web to be able to have
+correct cross-references to your manual, the @var{host} and
+@var{dir} parts of the cross-reference need to be known by Texinfo
+converters when they produce HTML for those other manuals.
+Similarly, for your manual in HTML format to have correct
+cross-references to other manuals, @command{texi2any} needs to know
+how to construct the URLs for other manuals.
+
@command{texi2any} reads a file named @file{htmlxref.cnf} to gather
information for cross-references to other manuals in HTML output. It
is looked for in the following directories, based on the
@@ -17922,6 +17930,11 @@ The Texinfo distribution includes a default file which
handles many
GNU manuals; it is installed in @file{@var{datadir}/texinfo/htmlxref.cnf},
one of the last of the above directories.
+You can use a local @file{htmlxref.cnf} to complete or correct the
+default file from the Texinfo distribution. This could be useful to
+correct outdated data, or even to generate cross-references to local
+files for some manuals.
+
The @code{HTMLXREF_MODE} customization variable can be set to modify how the
files are found. For instance, if set to @samp{none}, no external information
is used. @code{HTMLXREF_FILE} sets the file name to something else than