unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Gavin Smith <gavinsmith0123@gmail.com>
To: guix-devel@gnu.org
Cc: Texinfo <bug-texinfo@gnu.org>
Subject: Any interest in using HTML for locally-installed Texinfo documentation?
Date: Mon, 1 Apr 2019 13:55:55 +0100	[thread overview]
Message-ID: <CAKPWYQ3WWUTG=RcA1RrZ=yb4Shwh5ehzpQAO-32r_WEk7M58eQ@mail.gmail.com> (raw)

Dear Guix developers,

I hope I am not intruding by advertising a project that may be of
interest to you.

Documentation for GNU packages and others is often installed in the
Info format, a plain text format.  Using a plaintext based format for
documentation does not take advantage of bitmapped displays that have
been available for decades.  It does not allow styling of text or
reflowing of text.  Much information is lost in the conversion from
Texinfo to Info and any attempt in, for example, Emacs to re-add this
information is unreliable.

Nonetheless, Info viewers have continued to have advantages over web
browsers.  They are fast, and have features for searching the manual
with index lookup.  They allow the use of keyboard commands.

In attempt to bring some of the benefits of the Info viewers to HTML
documentation in web browsers, in 2017, as part of Google Summer of
Code, Matthieu Lirzin worked on a JavaScript interface that works with
the HTML that texi2any produces.  His work is substantially complete.
A manual with this interface added is at
https://www.gnu.org/software/texinfo/manual/texinfo-html/Overview.html.
All the important keyboard commands that work in the Info viewers are
implemented, including index lookup.

The code he produced is in the js/ subdirectory of the Texinfo git
repository, and also available at
https://alpha.gnu.org/gnu/texinfo/texinfo-js-0.0.90.tar.gz

I believe this work has great potential to increase the ease of
accessing documentation, including documentation locally installed on
a user's own computer.  When a user is using a bitmapped display (e.g.
with X11), this could become the default way that they access
documentation.

I am contacting you because the distribution level may be the best
place to push this forward.  There are two reasons:
* The distribution could take care of installation of HTML
documentation files (at the moment, there is no standard place to
install these, and Automake does not support installing HTML files
generated from Texinfo).
* It could also take responsibility for checking web browser
compatibility.  Even if we don't use the JavaScript interface for
documentation on the GNU website due to browser compatibility
concerns, an OS distribution would have control over which browser was
used to view documentation.

Although I have little knowledge of Guix, it is the natural choice of
operating system distribution to contact about this possibility, as
both Texinfo and Guix are GNU projects.

If there is nobody who wants to take this forward within Guix, then
suggestions would also be welcome on how to otherwise push this
forward.

Best wishes,

Gavin

             reply	other threads:[~2019-04-01 12:55 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-01 12:55 Gavin Smith [this message]
2019-04-01 14:01 ` Any interest in using HTML for locally-installed Texinfo documentation? sirgazil
2019-04-02  9:37 ` Ludovic Courtès
2019-04-02 15:02   ` Gavin Smith
2019-04-02 16:46     ` Per Bothner
2019-04-07 16:28       ` Gavin Smith
2019-04-08 15:12         ` Ludovic Courtès
2019-04-08 15:39           ` Pierre Neidhardt
2019-04-08 23:46           ` Gavin Smith
2019-04-09  6:25             ` Eli Zaretskii
2019-04-13 16:21           ` Gavin Smith
2019-04-14 19:25             ` Pronaip
2019-10-15 19:27             ` Gavin Smith
2019-10-15 20:20               ` P
2019-10-15 20:35                 ` Gavin Smith
2019-10-15 20:40                 ` Per Bothner
2019-10-15 21:00                   ` Gavin Smith
2019-10-15 21:09                     ` Per Bothner
2019-10-15 21:30                       ` Gavin Smith
2019-10-16  1:39               ` Ricardo Wurmus
2019-10-19 20:31               ` Ludovic Courtès
2019-10-22 19:00                 ` Gavin Smith
2019-10-22 20:18                   ` Gavin Smith
2019-11-03 14:04                   ` Ludovic Courtès
2019-11-03 15:37                     ` Gavin Smith
2019-11-06 21:49                       ` Ludovic Courtès
2019-04-03 21:21     ` Ludovic Courtès
2019-04-04 10:33       ` Gavin Smith
2019-04-02 15:31   ` Per Bothner
2019-04-03 21:11     ` Ludovic Courtès
2019-04-03 22:44       ` Per Bothner
2019-04-04 10:23       ` Gavin Smith
2019-04-04 16:02         ` Ludovic Courtès
2019-04-02 20:12   ` Ricardo Wurmus
2019-04-02 20:27     ` Ricardo Wurmus
2019-04-02 22:58       ` sirgazil
2019-04-02 22:10     ` Per Bothner
2019-04-02 23:09       ` sirgazil
2019-04-03  8:43         ` Gavin Smith
2019-04-03 14:23           ` sirgazil
2019-04-03 14:40             ` Per Bothner
2019-04-03 14:49       ` Ricardo Wurmus
2019-04-02 21:02 ` George Clemmer
2019-04-07 11:08   ` Gavin Smith

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://guix.gnu.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CAKPWYQ3WWUTG=RcA1RrZ=yb4Shwh5ehzpQAO-32r_WEk7M58eQ@mail.gmail.com' \
    --to=gavinsmith0123@gmail.com \
    --cc=bug-texinfo@gnu.org \
    --cc=guix-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/guix.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).