Re: docstrings and elisp reference

[Chad Brown <chadpbrown@me.com>]

[-- Attachment #1: Type: text/plain, Size: 1987 bytes --]


> On 8Jun, 2017, at 08:42, Jean-Christophe Helary <jean.christophe.helary@gmail.com> wrote:
> 
> 
>> On Jun 9, 2017, at 0:11, Eli Zaretskii <eliz@gnu.org> wrote:
>> 
>>> From: Jean-Christophe Helary <jean.christophe.helary@gmail.com>
>>> Date: Thu, 8 Jun 2017 17:12:37 +0900
>>> 
>>>> Could you perhaps talk about what you see as the benefit to “an alternative to the info system, with exactly the same contents”? 
>>> 
>>> An HTML page with the whole API with visual cues.
>> 
>> Can you elaborate on the "visual cues" part?
> 
> I mean a data set that makes full use of CSS selectors and provides visual information about where are the function names, the arguments, the types of arguments, etc. by using something like syntax highlighting and things like this.
> 
> But the contents would be exclusively the docstrings, with 2 way links to the elisp reference. I guess when we develop an extraction process for l10n, it will be possible to implement.

You might be interested in some work that Nic Ferrier did on Info and HTML a while back. There’s a (long) emacs-devel thread on the topic that ranged around a bit. This looks like a reasonable place to start in the archives, on “HTML-Info design"

	https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg01901.html <https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg01901.html>

Two more literal starting points for the discussion, perhaps not quite as helpful, are here:
	
	https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg01672.html <https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg01672.html>
	https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg00347.html <https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg00347.html>

There used to be a good-looking web-based example of Nic’s work, but it seems to be down now; trying to access it gets me errors that suggest a caching server sitting in front of a down or non-existant origin server.

~Chad

[-- Attachment #2: Type: text/html, Size: 3382 bytes --]