From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Jean Louis Newsgroups: gmane.emacs.devel Subject: Re: [ELPA] Display package description as Org-exported text or HTML? Date: Mon, 31 May 2021 14:04:57 +0300 Message-ID: References: <27aaa2b3-96a1-d1b1-07dc-d8f0a9ca7900@daniel-mendler.de> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="22227"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.7+183 (3d24855) (2021-05-28) Cc: Stefan Monnier , "emacs-devel@gnu.org" To: Daniel Mendler Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Mon May 31 13:08:49 2021 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 1lnfmp-0005VB-Uk for ged-emacs-devel@m.gmane-mx.org; Mon, 31 May 2021 13:08:47 +0200 Original-Received: from localhost ([::1]:42962 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lnfmo-00089O-4R for ged-emacs-devel@m.gmane-mx.org; Mon, 31 May 2021 07:08:46 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:53272) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnflo-0007Rr-0X for emacs-devel@gnu.org; Mon, 31 May 2021 07:07:44 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:60199) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnflm-0003yN-9N for emacs-devel@gnu.org; Mon, 31 May 2021 07:07:43 -0400 Original-Received: from localhost ([::ffff:197.157.0.35]) (AUTH: PLAIN admin, TLS: TLS1.3,256bits,ECDHE_RSA_AES_256_GCM_SHA384) by stw1.rcdrun.com with ESMTPSA id 00000000000ADF02.0000000060B4C37B.00003F3D; Mon, 31 May 2021 04:07:38 -0700 Mail-Followup-To: Daniel Mendler , "emacs-devel@gnu.org" , Stefan Monnier Content-Disposition: inline In-Reply-To: Received-SPF: pass client-ip=217.170.207.13; envelope-from=bugs@gnu.support; helo=stw1.rcdrun.com X-Spam_score_int: -3 X-Spam_score: -0.4 X-Spam_bar: / X-Spam_report: (-0.4 / 5.0 requ) BAYES_00=-1.9, RCVD_IN_SORBS_WEB=1.5, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 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:270163 Archived-At: * Daniel Mendler [2021-05-31 13:54]: > On 5/31/21 12:29 PM, Jean Louis wrote: > > * Daniel Mendler [2021-05-31 13:10]: > >> Is it possible to display a package description as Org-exported text or > >> even as HTML on the ELPA website? > >> > >> See for example http://elpa.gnu.org/packages/consult.html, which shows a > >> large Org source file as "Full description". > > > > That is not readable. > > ... > > Thus, it is best to provide README.txt in plain text. > > Jean, did you read my question? I am asking how to avoid this problem > you are reiterating. Yes, I have fully understand it and answered that I find plain text most universally readable file. README should be just that in plain text, without any extensions. I don't oppose using README.org but I oppose usin README.org or README.md without plain text README, as those are less accessible, less readable markups and allow too many variations. By the way, the package description for consult says: Consult has been inspired by Counsel. Some of the Consult commands originated in the Counsel package or the Selectrum wiki. See the README for a full list of contributors. [back] but there is no `README' in the ~/.emacs.d/elpa/consult-20210519.1000/ There are other packages that do have README in the directory, maybe you could include it in the package. IMHO, README as such should be user friendly, not written in any lightweight markup language. That does not mean that I oppose generation of HTML or using README.org, I just think that plain text README should be there and readable by any GNU tools on command line, or any editor, not just Emacs, or markdown supported editor. See (info "(elisp) Multi-file Packages") where it says: ,---- | If the content directory contains a file named ‘README’, this file is | used as the long description (overriding any ‘;;; Commentary:’ section). `---- But Markdown and Org mode silently override decades long readable README files. I just wonder why. Org file can look so nice and readable, but yours is not due to a lot of markup, that is why I say there should should be simple readable version. Markdown may look nice and readable but yet people may include any kind of HTML inside and make it very unreadable. For those reasons it would be better to have plain text README, while Markdown, Org, and other markups could be used for other different purposes. -- Jean Take action in Free Software Foundation campaigns: https://www.fsf.org/campaigns Sign an open letter in support of Richard M. Stallman https://stallmansupport.org/