From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Chad Brown Newsgroups: gmane.emacs.devel Subject: Re: docstrings and elisp reference Date: Thu, 08 Jun 2017 17:25:35 -0700 Message-ID: References: <0BB64F35-233A-471F-B99F-51F96C4E6CCB@gmail.com> <8360g99n07.fsf@gnu.org> <86lgp4q2xa.fsf@stephe-leake.org> <7acc7d4f-23cc-4b6a-b062-ef92805e465b@default> <878tl3rz38.fsf@x230.lts> <0B83D1B3-19D8-4F85-BCD8-357FC6F1C9A7@gmail.com> <8360g68qfo.fsf@gnu.org> <1F24A0CB-E8B7-4A55-B014-FEB60B6561B0@gmail.com> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 (Mac OS X Mail 10.3 \(3273\)) Content-Type: multipart/alternative; boundary="Apple-Mail=_8FC3BCA5-82F1-4508-86B0-10719F790917" X-Trace: blaine.gmane.org 1496973485 14604 195.159.176.226 (9 Jun 2017 01:58:05 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 9 Jun 2017 01:58:05 +0000 (UTC) Cc: emacs-devel To: Jean-Christophe Helary Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Jun 09 03:58:00 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1dJ9BX-0003Wj-Ri for ged-emacs-devel@m.gmane.org; Fri, 09 Jun 2017 03:58:00 +0200 Original-Received: from localhost ([::1]:52102 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dJ9Bd-0001EG-7M for ged-emacs-devel@m.gmane.org; Thu, 08 Jun 2017 21:58:05 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:33577) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1dJ7kI-0003ML-OD for emacs-devel@gnu.org; Thu, 08 Jun 2017 20:25:50 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1dJ7kF-00078Y-IZ for emacs-devel@gnu.org; Thu, 08 Jun 2017 20:25:46 -0400 Original-Received: from mr11p24im-asmtp004.me.com ([17.110.78.110]:30072) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1dJ7kF-00076v-8j for emacs-devel@gnu.org; Thu, 08 Jun 2017 20:25:43 -0400 Original-Received: from process-dkim-sign-daemon.mr11p24im-asmtp004.me.com by mr11p24im-asmtp004.me.com (Oracle Communications Messaging Server 7.0.5.38.0 64bit (built Feb 26 2016)) id <0OR9006007NS2M00@mr11p24im-asmtp004.me.com> for emacs-devel@gnu.org; Fri, 09 Jun 2017 00:25:39 +0000 (GMT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=me.com; s=4d515a; t=1496967939; bh=1PaqTiukYh2aP4nL5KRyn/kpBZKrZcUigY7Ck4ZlJHI=; h=From:Message-id:Content-type:MIME-version:Subject:Date:To; b=nRP6PI/UlYoYyCbBl4kCeqMv5A1luZiDgHhuBvtCay2Ct42pcs1W3fuDnsXjNHr7u BUIQWtZ4WPq9+2WdV+WUSRZ43WiJwRg95s8+fjJI8VJqL8CG9t85Wc0zoLsnv0o89T joHhaXMBKC5cdiMeLpiO2PYLSfgcwfSFhShzinUgWV29iFdZU72Ltno4mIcMb6pZgR ncfsCLuoAC5B4lF40p5GcUbaXFBHqdZnpO349TO5uyCQ2KiO61hmODkRTHUC6JZNd6 ij5Y3SgiWGyUVtqzfoFUaYtR4MtRVPTwnMgxIJSez+3JjwxCDawhkHpApdZg45Qwkn aL9J9ZrcAnO/g== Original-Received: from icloud.com ([127.0.0.1]) by mr11p24im-asmtp004.me.com (Oracle Communications Messaging Server 7.0.5.38.0 64bit (built Feb 26 2016)) with ESMTPSA id <0OR900K5R7UOUQ10@mr11p24im-asmtp004.me.com>; Fri, 09 Jun 2017 00:25:37 +0000 (GMT) X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:,, definitions=2017-06-08_08:,, signatures=0 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 clxscore=1034 suspectscore=0 malwarescore=0 phishscore=0 adultscore=0 bulkscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1701120000 definitions=main-1706090006 In-reply-to: <1F24A0CB-E8B7-4A55-B014-FEB60B6561B0@gmail.com> X-Mailer: Apple Mail (2.3273) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 17.110.78.110 X-Mailman-Approved-At: Thu, 08 Jun 2017 21:57:53 -0400 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:215534 Archived-At: --Apple-Mail=_8FC3BCA5-82F1-4508-86B0-10719F790917 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset=utf-8 > On 8Jun, 2017, at 08:42, Jean-Christophe Helary = wrote: >=20 >=20 >> On Jun 9, 2017, at 0:11, Eli Zaretskii wrote: >>=20 >>> From: Jean-Christophe Helary >>> Date: Thu, 8 Jun 2017 17:12:37 +0900 >>>=20 >>>> Could you perhaps talk about what you see as the benefit to =E2=80=9C= an alternative to the info system, with exactly the same contents=E2=80=9D= ?=20 >>>=20 >>> An HTML page with the whole API with visual cues. >>=20 >> Can you elaborate on the "visual cues" part? >=20 > 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. >=20 > 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=E2=80=99s 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 =E2=80=9CHTML-Info design" = 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: =09 = https://lists.gnu.org/archive/html/emacs-devel/2014-12/msg01672.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=E2=80=99s 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= --Apple-Mail=_8FC3BCA5-82F1-4508-86B0-10719F790917 Content-Transfer-Encoding: quoted-printable Content-Type: text/html; charset=utf-8
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 =E2=80=9Can alternative to the info system, with exactly = the same contents=E2=80=9D?

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=E2=80=99s 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 =E2=80=9CHTML-Info = design"

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/msg00347= .html

There = used to be a good-looking web-based example of Nic=E2=80=99s 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
= --Apple-Mail=_8FC3BCA5-82F1-4508-86B0-10719F790917--