From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Sat, 4 Jun 2022 14:17:58 +0000 Message-ID: References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="31731"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Akib Azmain Turja , emacs-devel@gnu.org To: Tassilo Horn Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jun 04 16:19:11 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 1nxUcR-000844-KU for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 16:19:11 +0200 Original-Received: from localhost ([::1]:60014 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxUcO-0007Kx-QU for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 10:19:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49942) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxUba-0006em-Cg for emacs-devel@gnu.org; Sat, 04 Jun 2022 10:18:18 -0400 Original-Received: from colin.muc.de ([193.149.48.1]:30255 helo=mail.muc.de) by eggs.gnu.org with smtp (Exim 4.90_1) (envelope-from ) id 1nxUbX-000317-Tl for emacs-devel@gnu.org; Sat, 04 Jun 2022 10:18:18 -0400 Original-Received: (qmail 93941 invoked by uid 3782); 4 Jun 2022 14:17:58 -0000 Original-Received: from acm.muc.de (p2e5d52ce.dip0.t-ipconnect.de [46.93.82.206]) (using STARTTLS) by colin.muc.de (tmda-ofmipd) with ESMTP; Sat, 04 Jun 2022 16:17:58 +0200 Original-Received: (qmail 5486 invoked by uid 1000); 4 Jun 2022 14:17:58 -0000 Content-Disposition: inline In-Reply-To: <87czfopmsd.fsf@gnu.org> X-Submission-Agent: TMDA/1.3.x (Ph3nix) X-Primary-Address: acm@muc.de Received-SPF: pass client-ip=193.149.48.1; envelope-from=acm@muc.de; helo=mail.muc.de X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-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:290656 Archived-At: Hello, Tassilo. On Sat, Jun 04, 2022 at 15:32:10 +0200, Tassilo Horn wrote: > Akib Azmain Turja writes: > Hi Akib, > > Packages on ELPA or NonGNU ELPA with README.org show pretty > > description both with describe-package and web browser. But after > > installing a package, describe-package shows the Org source code, > > which contains many useless things (I mean useless for showing in the > > *Help* buffer). > > Isn't it possible to convert README.org to plain text README while > > compiling the package, possibly optionally? Changing package--compile > > function should do the job. > An alternative would be to enable (parts of) org-mode in the *Help* > buffer. I've just tried `M-x describe-package RET corfu RET` which > comes with a README.org and then enabling org-mode in the *Help* buffer. > That looked really nice and didn't seem to cause bad effects except that > the [back] / [forward] buttons stopped working. No, no, no, no! Org mode is a highly complicated, obscure mode which is NOT part of core Emacs, and mustn't become so. What you're proposing is a slippery slope, where ever greater portions of org mode would get pushed into the core, causing ever greater problems for those who do not use org mode. You pointed out one such problem yourself, org mode key bindings will take up key binding space currently used by other modes and by users. Surely the solution has got to be to encourage package authors to write plain text (or .texi) documentation, by pointing out the difficulties the non-standard .org format creates. > Bye, > Tassilo -- Alan Mackenzie (Nuremberg, Germany).