unofficial mirror of guix-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Gavin Smith <gavinsmith0123@gmail.com>
To: "Ludovic Courtès" <ludo@gnu.org>
Cc: guix-devel@gnu.org, Texinfo <bug-texinfo@gnu.org>
Subject: Re: Any interest in using HTML for locally-installed Texinfo documentation?
Date: Tue, 2 Apr 2019 16:02:45 +0100	[thread overview]
Message-ID: <20190402150245.GA30067@darkstar> (raw)
In-Reply-To: <87a7h8u4r4.fsf@gnu.org>

On Tue, Apr 02, 2019 at 11:37:51AM +0200, Ludovic Courtès wrote:
> (For some reason ‘i’ does open the index search box for me, but then
> hitting enter doesn’t produce any effect.  The other navigation commands
> work fine, though.)

It works on Firefox 53, at least.

> Yet I’m not completely sold to the everything in the browser approach,
> and everything in JavaScript.  In an ideal world (for me), we’d rather
> provide a local documentation viewer that renders Texinfo directly.
> TTN’s IXIN experiment was a step in the right direction IMO, but I
> understand this approach is not something that’s happening now.

To my knowledge, no program has ever been produced that does anything 
useful with IXIN.

Using JavaScript within a web browser has big drawbacks due to its 
"sandboxed" nature.  (You can't access environment variables, for 
example.)  However, we'd want to avoid having to re-implement too much 
of the web browser; for example, input file parsing, text layout and font 
rendering.

One thought is that there may be other "layout engines" that could be 
used, such as those in various GUI toolkits.

> When talking about ease of access, we can’t ignore keyword searches.
> How would you do ‘info -k’?

I don't know.  You would have to have some way of finding all the 
installed manuals.  This may be difficult with a standard web browser 
due to security restrictions.

> How would you even simply point your
> browser to a specific manual?

Maybe there could be a command for this within the browser.  There could 
also be a command-line program that would launch the documentation 
browser.

> What about inter-manual cross-references?
> Would we need a mechanism similar to ‘htmlxref.cnf’ but that would
> browse local manuals?

Good question.  The inter-manual links in locally-installed HTML files 
would have to be recognizable.  They could look like

<a href="../texinfo/index.html#Top">Texinfo</a>

instead of

<a href="https://www.gnu.org/software/texinfo/manual/texinfo/html_node/index.html#Top">Texinfo</a>

as there were would no way of resolving the second link to a 
locally-installed file (it is not clear from the URL what the name of 
the manual even is).  It would be quite simple to get texi2any to 
output this instead.  (It can currently be done by passing '-c 
HTMLXREF=empty' where 'empty' is an empty file, but a better interface 
could be devised.)

Then inter-manual links would all work, assuming the installed manuals 
are all subdirectories of the same directory (e.g. 
/usr/share/info/html).

This doesn't address the issue of multiple installed versions of the 
same manual or manuals in different "prefix hierarchies".  I imagine the 
Info browser would interpret the "../" string specially in a link and 
go looking through a search path for the referenced manual.  Again, this 
may be difficult to implement in standard web browsers due to security 
restrictions.

> What would be the recommended solution for Emacs
> and console users?

Info files would carry on as an option.

I'm getting the feeling that we need a web browser, or something like 
it, which can integrate with the operating system a lot more, without
sandboxing or security restrictions.

  reply	other threads:[~2019-04-02 15:02 UTC|newest]

Thread overview: 44+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-01 12:55 Any interest in using HTML for locally-installed Texinfo documentation? Gavin Smith
2019-04-01 14:01 ` sirgazil
2019-04-02  9:37 ` Ludovic Courtès
2019-04-02 15:02   ` Gavin Smith [this message]
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=20190402150245.GA30067@darkstar \
    --to=gavinsmith0123@gmail.com \
    --cc=bug-texinfo@gnu.org \
    --cc=guix-devel@gnu.org \
    --cc=ludo@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).