all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: "Etienne Prud’homme" <e.e.f.prudhomme@gmail.com>
Cc: stephen_leake@stephe-leake.org, drew.adams@oracle.com,
	emacs-devel@gnu.org
Subject: Re: docstrings and elisp reference
Date: Thu, 08 Jun 2017 18:18:51 +0300	[thread overview]
Message-ID: <834lvq8q3o.fsf@gnu.org> (raw)
In-Reply-To: <878tl3rz38.fsf@x230.lts> (message from Etienne Prud’homme on Wed, 07 Jun 2017 22:29:47 -0400)

> From: Etienne Prud’homme <e.e.f.prudhomme@gmail.com>
> Date: Wed, 07 Jun 2017 22:29:47 -0400
> Cc: Stephen Leake <stephen_leake@stephe-leake.org>,
> 	emacs-devel <emacs-devel@gnu.org>
> 
> However, I also think Jean-Christophe makes a good point about
> documentation generation.  Not with duplication, but semantic support.
> While documentation support is awesome in Emacs with GNU libraries, it’s
> not always so with third-party documentation tools.  I’m thinking about
> Zeal (and to a very limited extent Dash that is not free).

Are there any other similar free tools?  Zeal seems a one-man project,
that is not developed too actively.  What's more, at least the docs it
has for Bash and ELisp are exactly the respective Texinfo manuals,
with the same text and the same node structure.  What is the advantage
of using a different browser for the exact same text?

> Those tools are highly effective for semantic indexation for newcomers
> since they offer a simple interface for hundred FLOSS libraries.  GNU
> projects are almost nonexistent.

Most of the docs offered with Zeal are about languages and other
similar systems, so docs of GNU packages among them is more like the
odd one out than the rule.  And given the contents, which is exactly
the Info manual, I don't see why bother.  Am I missing something?

And I don't think I understand what you mean by "semantic indexation".
Can you explain that using as example the ELisp manual available for
Zeal?

> I’ve been trying in the past to port GNU projects documentation and I
> finally gave up.  I find Texinfo to be very limited when it comes to
> semantic support.  It’s really hard to extract meaningful definitions
> from texi files.

This should be discussed on the Texinfo list, not here.  The current
Texinfo translator is highly customizable, so it could be that it can
be adapted to these needs much better.  And the fact that the 2 GNU
manuals there are obviously translations of Texinfo seems to
contradict what you say here.



  parent reply	other threads:[~2017-06-08 15:18 UTC|newest]

Thread overview: 72+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-06-05 21:26 docstrings and elisp reference Jean-Christophe Helary
2017-06-06  0:09 ` Tino Calancha
2017-06-06  5:10   ` Jean-Christophe Helary
2017-06-06 15:03     ` Eli Zaretskii
2017-06-06 20:25       ` Stephen Leake
2017-06-06 20:36         ` Drew Adams
2017-06-08  2:29           ` Etienne Prud’homme
2017-06-08  3:48             ` Jean-Christophe Helary
2017-06-08  5:39               ` Chad Brown
2017-06-08  8:12                 ` Jean-Christophe Helary
2017-06-08 15:11                   ` Eli Zaretskii
2017-06-08 15:42                     ` Jean-Christophe Helary
2017-06-09  0:25                       ` Chad Brown
2017-06-08 18:29               ` Etienne Prud’homme
2017-06-09  4:10               ` Richard Stallman
2017-06-08 15:18             ` Eli Zaretskii [this message]
2017-06-08 18:10               ` Etienne Prud’homme
2017-06-08 19:14                 ` Eli Zaretskii
2017-06-08 20:07                   ` Drew Adams
2017-06-08 20:22                   ` Etienne Prud’homme
2017-06-08 22:44                     ` Jean-Christophe Helary
2017-06-09  4:10             ` Richard Stallman
2017-06-09  5:20               ` Etienne Prud’homme
2017-06-09  7:08                 ` Eli Zaretskii
2017-06-09  8:27                   ` Yuri Khan
2017-06-09  9:38                     ` Eli Zaretskii
2017-06-09 12:21                       ` Eli Zaretskii
2017-06-09 12:32                         ` Yuri Khan
2017-06-09 13:46                           ` Eli Zaretskii
2017-06-09 19:24                             ` Etienne Prud’homme
2017-06-10  1:06                               ` Jean-Christophe Helary
2017-06-10 11:36                                 ` Nikolay Kudryavtsev
2017-06-10 14:26                                   ` Drew Adams
2017-06-10  3:19                 ` Richard Stallman
2017-06-10  7:31                   ` Eli Zaretskii
2017-06-11  2:43                     ` Richard Stallman
2017-06-11  2:44                     ` Richard Stallman
2017-06-11 15:18                       ` Stefan Monnier
2017-06-12  2:52                         ` Richard Stallman
2017-06-12  3:27                           ` Stefan Monnier
2017-06-13  3:25                             ` Richard Stallman
2017-06-10  8:22                   ` Yuri Khan
2017-06-10  3:19                 ` Richard Stallman
2017-06-06 20:45         ` Joost Kremers
2017-06-07 13:03           ` Stefan Monnier
2017-06-07 13:23             ` Yuri Khan
2017-06-07 13:31               ` Stefan Monnier
2017-06-07 14:18             ` Drew Adams
2017-06-07 15:43             ` Eli Zaretskii
2017-06-06 20:47         ` Dmitry Gutov
2017-06-06 21:21           ` Drew Adams
2017-06-06 21:50             ` Dmitry Gutov
2017-06-07  5:28               ` Eli Zaretskii
2017-06-17 12:46                 ` Dmitry Gutov
2017-06-17 13:04                   ` Alan Mackenzie
2017-06-17 13:55                     ` Dmitry Gutov
2017-06-17 20:14                       ` Alan Mackenzie
2017-06-18  2:32                         ` Eli Zaretskii
2017-06-18 19:52                           ` Richard Stallman
2017-06-17 22:13                     ` Richard Stallman
2017-06-20 18:05                     ` John Wiegley
2017-06-17 14:10                   ` Eli Zaretskii
2017-06-17 15:13                     ` Stefan Monnier
2017-06-17 18:59                     ` Paul Eggert
2017-06-17 14:52                   ` Drew Adams
2017-06-19 18:31                     ` Thien-Thi Nguyen
2017-06-07 14:05               ` Drew Adams
2017-06-07 14:27                 ` Drew Adams
2017-06-08  1:27           ` Richard Stallman
2017-06-06 22:42 ` Richard Stallman
2017-06-06 22:49   ` Dmitry Gutov
2017-06-07  5:20     ` Eli Zaretskii

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

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

  git send-email \
    --in-reply-to=834lvq8q3o.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=drew.adams@oracle.com \
    --cc=e.e.f.prudhomme@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=stephen_leake@stephe-leake.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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.