From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Akib Azmain Turja Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Sat, 04 Jun 2022 23:39:09 +0600 Message-ID: <87sfok5nwi.fsf@disroot.org> References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="18337"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Tassilo Horn , Alan Mackenzie Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jun 04 19:41:39 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 1nxXmN-0004d6-9z for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 19:41:39 +0200 Original-Received: from localhost ([::1]:45534 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxXmL-0005s8-SQ for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 13:41:37 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:44138) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxXkE-0004zm-H7 for emacs-devel@gnu.org; Sat, 04 Jun 2022 13:39:28 -0400 Original-Received: from knopi.disroot.org ([178.21.23.139]:38676) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxXkC-0004Ew-CT; Sat, 04 Jun 2022 13:39:25 -0400 Original-Received: from localhost (localhost [127.0.0.1]) by disroot.org (Postfix) with ESMTP id CA4FB438F4; Sat, 4 Jun 2022 19:39:21 +0200 (CEST) X-Virus-Scanned: SPAM Filter at disroot.org Original-Received: from knopi.disroot.org ([127.0.0.1]) by localhost (disroot.org [127.0.0.1]) (amavisd-new, port 10024) with ESMTP id 0RCjpMp2E5oZ; Sat, 4 Jun 2022 19:39:20 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=disroot.org; s=mail; t=1654364360; bh=wiYtns+AsURK90iDl1xXRkERzawE8Gz4ZF8m7kUKu6w=; h=From:To:Cc:Subject:In-Reply-To:References:Date; b=dJ4OZVY6BHDV6u4CZxLH8uzm9Zok3EsQ9Gm4x5ylnHOqoWlV2uqF/yHX39PrObe+A R6U/Pk/R8u3ZUUvD5+mOqu+mzxzZYPr9X8KNH28siipv52QYfKj10FrBVnbePQih9M a8c0MeCj8l0hGDV/n3PCgcyJta4qIQKEMT7ZcSFTP5Z9PmSaF0qTiPTuYXxMdk6fOZ AjeerRvup9UCtZCpGOxunoUU9CgY/Aa8cKOEVK9Tsv5TAWYkrDN5pTxy3zovBePFdc G25ydTilrIBX4WBbMLfSXrp02KY0dYYGUT2/p+Lt/+Hca+VTkZV/Ff3YrUkjwrR5+/ 18RzmKkPlpjEg== In-Reply-To: Received-SPF: pass client-ip=178.21.23.139; envelope-from=akib@disroot.org; helo=knopi.disroot.org X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, 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:290673 Archived-At: --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Tassilo Horn writes: > Don't panic, Alan! =F0=9F=98=81 > > The idea would be to only activate the font-lock rules of org (or markdow= n-mode, if available) while somehow protecting the package headers and help= -mode footer section (i.e., the buttons). But I don't like that idea. I don't think that's a really good idea, since the *Help* buffer is not for only describe-package, its for all purposes. I think converting Org (or Markdown or whatever) to plain text should solve most (if not all) of the problems. Then showing that file shouldn't need any special treatment at all. > > Bye, > Tassilo > > 04.06.2022 16:18:21 Alan Mackenzie : > >> Hello, Tassilo. >>=20 >> On Sat, Jun 04, 2022 at 15:32:10 +0200, Tassilo Horn wrote: >>> Akib Azmain Turja writes: >>=20 >>> Hi Akib, >>=20 >>>> Packages on ELPA or NonGNU ELPA with README.org show pretty >>>> description both with describe-package and web browser.=C2=A0 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). >>=20 >>>> Isn't it possible to convert README.org to plain text README while >>>> compiling the package, possibly optionally?=C2=A0 Changing package--co= mpile >>>> function should do the job. >>=20 >>> An alternative would be to enable (parts of) org-mode in the *Help* >>> buffer.=C2=A0 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. >>=20 >> No, no, no, no!=C2=A0 Org mode is a highly complicated, obscure mode whi= ch is >> NOT part of core Emacs, and mustn't become so.=C2=A0 What you're proposi= ng 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. >>=20 >> 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. >>=20 >> 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. >>=20 >>> Bye, >>> Tassilo >>=20 =2D-=20 Akib Azmain Turja This message is signed by me with my GnuPG key. It's fingerprint is: 7001 8CE5 819F 17A3 BBA6 66AF E74F 0EFA 922A E7F5 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAEBCAAdFiEEyVTKmrtL6kNBe3FRVTX89U2IYWsFAmKbmL0ACgkQVTX89U2I YWvUdw//c122zAiKu78dokhl8auJ85vVeC3peNdL/bjhKLv/Wwwfp5V20GHmSweX C5lNLHrVO4ejAnQ9YLzqocIPeQ34Aw2SkXgCTKxG0JUfCnUtCWScqZav1jZ43jhU 9Ix1GcqU+4jdPZYfxb1JT0oY0rVS0LawReBYoMmK4RWSfWxqoQQ7TXbO0d5OMS1x 8kv8ZIbJe5O2Qxc/KWsTYNpOfuZfSmtBby5r3SJ567738+kSWZwfPqsCvmRUYpOu 3/oVOGNEar+vHLHsY9twCQWGt3bk4V39S8KZZmB1/HI0pO3FaDVolxb4czj35qPG aknaA6IWZHTmFpbGFonI9exMuKNujBuG3kDJ74RbwzEf58ocWA3M+xizVSpFDhpR KZvSLQqFtksfHSTMMCz00VMWVPHbH0JUg25q6WQMfb3EqiFLJ+P5NntZ3c178Wln bEFCGq/qNJeRwz3MNAiYoEQHvw3XBgIt59ne8Pid647qeFt+UnhyzBaXXtt+eX7z J9p/r6tVyBxZDOQfsAwNvwLJRzWUGOM/+uKwcjUvQnY4LwcEsuLCz07fmM27iBEc ok6KUgvHoQQUcemPu0BAYFPnYCvE6XPGbviiszns0jcxsX01jAgYUbrJv0aFCnxR MO3ULwDWPvLREWCp7AKU7tXaRUyromNJEgnO2nH4WIShpZ8+088= =bL4F -----END PGP SIGNATURE----- --=-=-=--