branch master updated: * TODO.HTML: Update to state location where HTML files are sought.

[Gavin D. Smith]

This is an automated email from the git hooks/post-receive script.

gavin pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new ee7cbb91eb * TODO.HTML: Update to state location where HTML files are 
sought.
ee7cbb91eb is described below

commit ee7cbb91ebb95568473f1b00ec60906c86bb0f01
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Sun Mar 20 12:07:15 2022 +0000

    * TODO.HTML: Update to state location where HTML files are
    sought.
---
 ChangeLog           |  5 +++++
 TODO.HTML           | 49 +++++++++++++++++++++++--------------------------
 js/infog/infopath.c |  5 +++--
 3 files changed, 31 insertions(+), 28 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index a860648378..c71b55c540 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,8 @@
+2022-03-20  Gavin Smith  <gavinsmith0123@gmail.com>
+
+       * TODO.HTML: Update to state location where HTML files are
+       sought.
+
 2022-03-20  Gavin Smith  <gavinsmith0123@gmail.com>
 
        * util/texi2dvi (xref_file_p): Remove unused.
diff --git a/TODO.HTML b/TODO.HTML
index c4cef0e3c0..8d119364aa 100644
--- a/TODO.HTML
+++ b/TODO.HTML
@@ -58,7 +58,8 @@ However, this system is only appropriate for online manuals, 
not for
 locally installed manuals.  The reason for this is that it only handles
 one manual at a time and does not handle searching for a manual.
 
-Another system has been developed using the embedded WebKitGTK browser:
+Another system has been developed using the embedded WebKitGTK browser,
+under the js/infog directory in the Texinfo sources.
 
 https://git.savannah.gnu.org/cgit/texinfo.git/log/?h=webkitgtk-info
 
@@ -106,40 +107,32 @@ JavaScript.)
 
 * Location of locally installed HTML files
 
-(This was discussed on a GNU project internal mailing list in October 2020.)
 
-It hasn't been agreed where Texinfo documention in HTML should be installed
-locally.
+The current code under js/infog looks for MANUAL under
+/usr/share/texinfo/html/MANUAL_html and
+/usr/local/share/texinfo/html/MANUAL_html.
+Users or distributions would need to copy/symlink the manuals to this
+location.  The /usr/share/texinfo/html directory is akin to the
+/usr/share/info/dir file in the Info system.
+
+Currently infog only supports "split" installed HTML manuals
+(meaning a collection of smaller HTML files rather than one large HTML file).
 
 The GNU coding standards specify a 'docdir' directory for a package.  For
 example, '/usr/local/share/doc/YOURPKG'.  It would be natural to install
 Texinfo HTML documentation under '/usr/local/share/doc/YOURPKG/html'.
 
-Another issue is whether installed manuals should be "split" or "non-split",
-meaning whether a manual is one large HTML file or a collection of smaller
-HTML files.
-
-* Finding manuals
-
-Users need to be able to find a manual by name.  They should also be
-able to follow cross-references in browser software to other Texinfo
-manuals they have installed.
-
-Manual names are distinct from package names.  For example,
+However, we did not use /usr/local/share/doc because
+manual names are distinct from package names.  For example,
 "emacs" would be the package name for many manuals ("tramp",
 "org", "calc", etc.).  Hence, a user might not find the tramp
 manual under /usr/local/share/doc/tramp/html but somewhere under
 /usr/local/share/doc/emacs.
 
-One suggestion is to have a directory of HTML manuals stored, akin to the
-"dir" file in the Info system.  Browser software could use this directory
-to locate manuals.
+The location of files is needed for users to find a manual by name
+and to follow cross-references between manuals.
 
-Another suggestion was to install all Texinfo HTML manuals together in
-the same directory (e.g. /usr/share/doc/texinfo/html); however, there wasn't
-agreement on where that directory could be.
-
-Debian does have some guidance on where HTML documentation could
+Debian alse has some guidance on where HTML documentation could
 be installed -
 
 https://www.debian.org/doc/debian-policy/ch-docs.html#additional-documentation
@@ -148,7 +141,14 @@ 
https://www.debian.org/doc/debian-policy/ch-docs.html#additional-documentation
 make manual is under /usr/share/doc/make-doc/make.html, while gdb
 is under /usr/share/doc/gdb-doc/html/gdb).
 
+
+%
+
 It was also an issue as to how to get the manual name from a link.
+In recent Texinfo releases, links to other manuals are annotated with the
+"data-manual" attribute.  This solves the problem of getting the manual
+name.
+
 Texinfo manuals are put on the web with a variety of URL formats and
 it is not possible to reliably get a manual name from a URL or even
 to tell if a URL is to a Texinfo manual or to some other webpapge.  It's
@@ -161,9 +161,6 @@ https://gmplib.org/manual/ - "gmp"
 http://lilypond.org/doc/v2.22/Documentation/internals/ - "lilypond-internals"
 https://gcc.gnu.org/onlinedocs/gfortran/ - "gfortran"
 
-In recent Texinfo releases, links to other manuals are annotated with the
-"data-manual" attribute.  This solves the problem of getting the manual
-name.
 
 Prior to this, we mooted the idea of outputting links in HTML documents
 differently if they were to be installed locally rather than put on the web.
diff --git a/js/infog/infopath.c b/js/infog/infopath.c
index d3464f3a90..874842991c 100644
--- a/js/infog/infopath.c
+++ b/js/infog/infopath.c
@@ -12,8 +12,9 @@
 
 void debug (int level, char *fmt, ...);
 
-char *default_path[] = { "/usr/share/doc",
-                         "/usr/local/share/doc",
+/* TODO: Also use the configure-time value of ${datarootdir}. */
+char *default_path[] = { "/usr/share/texinfo/html",
+                         "/usr/local/share/texinfo/html",
                          NULL };
 
 static GArray *dirs;