unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: "Harald Jörg" <haj@posteo.de>
To: emacs-devel@gnu.org
Cc: Visuwesh <visuweshm@gmail.com>, Eli Zaretskii <eliz@gnu.org>
Subject: Re: [ELPA] New package: perl-doc
Date: Thu, 28 Jul 2022 08:57:39 +0000	[thread overview]
Message-ID: <871qu5r4vw.fsf@hajtower> (raw)
In-Reply-To: <83sfmlail1.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 28 Jul 2022 08:53:46 +0300")

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Visuwesh <visuweshm@gmail.com>
>> Cc: Emacs Developer List <emacs-devel@gnu.org>
>> Date: Thu, 28 Jul 2022 09:47:53 +0530
>> 
>> [புதன் ஜூலை 27, 2022] Harald Jörg wrote:
>> 
>> > the motivation to write this library came from two sources: In a Perl
>> > online meeting an Emacs user noted that the usual function to read Perl
>> > documentation in Emacs, cperl-perldoc, does not work on Platforms which
>> > don't have 'man' (notably, Windows).
>> 
>> What about woman?  It should be reasonably fast for most manpages.
>
> It cannot format many modern man pages because it wasn't extended to
> support the roff directives added in recent years.  Patches to add
> that are welcome.

The troubles start before that: The POD to man converter (pod2man) is
lossy.  It is suited for character terminals or printing, but not so
much for interactive viewing in Emacs.  What I miss most is clickable
links between POD documents.

> P.S. A simple clone of 'man' for Windows is available from ezwinports
> site.

Sure, but the chase doesn't end here!  When I tried yesterday on a
Windows 11 system and Emacs 27.2, <M-x> cperl-perldoc <RET> perlrun
<RET> complained that it can't find sed.

But the actual problem is "read POD documents" rather than "run man".
In my opinion the quality of POD->HTML is better than POD->man.  Here's
a screenshot with a comparison (Linux, Emacs built from git):
https://raw.githubusercontent.com/HaraldJoerg/HaraldJoerg.github.io/main/emacs_perldoc.png

So, as a second step, I consider adding it to cperl-mode.el itself
(protected by an (if (fboundp perl-doc ...)) clause) which can improve
the user's experience if they decide to install the package, or simply
make it work on Windows.

Side note: There's also pod-mode.el at
https://github.com/renormalist/emacs-pod-mode.  This mode is geared
towards _authoring_ POD rather than browsing it.

-- 
Cheers,
haj



  reply	other threads:[~2022-07-28  8:57 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-27 16:16 [ELPA] New package: perl-doc Harald Jörg
2022-07-27 17:32 ` Akib Azmain Turja
2022-07-27 17:59   ` Harald Jörg
2022-07-28  7:24     ` Robert Pluim
2022-07-28  9:22       ` Harald Jörg
2022-07-28  9:39         ` Robert Pluim
2022-07-28 12:17           ` Harald Jörg
2022-07-28 12:34             ` Robert Pluim
2022-07-28 19:34         ` Juri Linkov
2022-07-28 20:58           ` Harald Jörg
2022-07-28 11:19     ` Gregor Zattler
2022-07-30  7:16       ` Akib Azmain Turja
2022-07-28  4:17 ` Visuwesh
2022-07-28  5:53   ` Eli Zaretskii
2022-07-28  8:57     ` Harald Jörg [this message]
2022-08-03 12:16 ` Alexander Adolf

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://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=871qu5r4vw.fsf@hajtower \
    --to=haj@posteo.de \
    --cc=eliz@gnu.org \
    --cc=emacs-devel@gnu.org \
    --cc=visuweshm@gmail.com \
    /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/emacs.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).