From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?utf-8?Q?Harald_J=C3=B6rg?= Newsgroups: gmane.emacs.devel Subject: [ELPA] New package: perl-doc Date: Wed, 27 Jul 2022 16:16:19 +0000 Message-ID: <87a68upm3w.fsf@hajtower> Mime-Version: 1.0 Content-Type: text/plain Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="37677"; mail-complaints-to="usenet@ciao.gmane.io" To: Emacs Developer List Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Wed Jul 27 18:25:58 2022 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1oGjrB-0009dV-Kw for ged-emacs-devel@m.gmane-mx.org; Wed, 27 Jul 2022 18:25:57 +0200 Original-Received: from localhost ([::1]:35204 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oGjrA-0005Pg-Fm for ged-emacs-devel@m.gmane-mx.org; Wed, 27 Jul 2022 12:25:56 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49566) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oGjiM-0006Xe-B9 for emacs-devel@gnu.org; Wed, 27 Jul 2022 12:17:01 -0400 Original-Received: from mout01.posteo.de ([185.67.36.65]:51917) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oGji0-0004kd-5W for emacs-devel@gnu.org; Wed, 27 Jul 2022 12:16:33 -0400 Original-Received: from submission (posteo.de [185.67.36.169]) by mout01.posteo.de (Postfix) with ESMTPS id 74F8D240027 for ; Wed, 27 Jul 2022 18:16:20 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=posteo.de; s=2017; t=1658938580; bh=ssA4rteK37ZqS5OZMk2sOHZ9WJAKkAwJ+Ft2AG18tII=; h=From:To:Subject:Date:From; b=Gsuta1LbUsPNkF/YdwfsYKuvl4KmFpGXQVPZZdPviyNXCwh1xmbhJGGSekaj3dWvk drkDT91925TErHZIraAKUixds7Xt9kWOiNw6RX+7luBLs32Ydvr3vOmX+ryinevM0T Zh2q4Og+WF6wXzlQjN2lRqmrkLHDBEjxdy10kO6kQwMxiNCgvKCwfJkWH6pEdKX7Lm YzXXzPhhnw0s+7+L9LE3m3XfX43wtVV27R0Q3o5xcCTL6R1D5KpNXNm8cpkJuUvI2d G47BesJ+M4cwMHTXcNZmnXsvgIWhN0+9szNOaKhNyVFjwj+UYpHml2xK/C3A8kVnNj UZpNMQIxgw1vg== Original-Received: from customer (localhost [127.0.0.1]) by submission (posteo.de) with ESMTPSA id 4LtJmz6wLDz9rxR for ; Wed, 27 Jul 2022 18:16:19 +0200 (CEST) Received-SPF: pass client-ip=185.67.36.65; envelope-from=haj@posteo.de; helo=mout01.posteo.de X-Spam_score_int: -43 X-Spam_score: -4.4 X-Spam_bar: ---- X-Spam_report: (-4.4 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_MED=-2.3, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01, T_SPF_HELO_TEMPERROR=0.01 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 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-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:292746 Archived-At: Hello developers, This is not yet a new ELPA package, but a proposal to create one. 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). My own observation is that 'man' (and also 'info') seem to be stuck at a fixed page width which is particularly annoying if you want to use *less* than this width for a documentation frame. This is a copy from the file's header: ---------------------------------------------------------------------- Perl documentation is written in a markup format called POD ("Plain Old Documentation") and is usually converted to other formats for human consumption. The documentation used to be available in Emacs for a long time in 'info' or 'man' format. However, Perl does no longer ship 'info' files, and the software available from CPAN never did. 'man' is not available on all platforms and allows only rather restricted formatting, most notably linking between documents does not work. On the other hand, Perl provides a converter from POD to HTML. HTML is well supported by Emacs and is well suited for presentation of structured documents. The user visible benefits over the other formats are: * Works nicely on platforms which do not have man * Unlike with 'man', Hyperlinks between POD documents work and resolve to POD documentation on your system, no web server required. * Makes use of Emacs faces: variable-pitch font for text, fixed-pitch for code, italics for, well, italics * Uses the buffer's full width and can also be used with narrow buffers TODO list * Documentation on Perl variables is yet to be implemented. * The regex mechanism in `perl-doc--process-links` is a hack. The author wrote this before he learned about rx and always meant to rewrite it in rx notation, but well, tuits. ---------------------------------------------------------------------- I would like to distribute the software under either GNU ELPA nor NonGNU ELPA. It works equally well with perl-mode.el and cperl-mode.el, and functional enhancements can be triggered by new Perl features as well as new Emacs features. The current repository is at https://github.com/HaraldJoerg/emacs-perl-doc, This is my first attempt to write a package: I am ready to move it elsewhere, to provide the required metadata, as well as fix format and style error as deemed appropriate by style guides and the Emacs community. Feedback is very welcome! -- Cheers, haj