From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Tassilo Horn Newsgroups: gmane.emacs.devel Subject: Re: Convert README.org to plain text README while installing package Date: Sat, 4 Jun 2022 16:31:35 +0200 (GMT+02:00) Message-ID: References: <87leuca7v7.fsf@disroot.org> <87czfopmsd.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="12374"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Akib Azmain Turja , emacs-devel@gnu.org To: Alan Mackenzie Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat Jun 04 16:32:38 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 1nxUpR-00033a-LC for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 16:32:37 +0200 Original-Received: from localhost ([::1]:35818 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nxUpQ-0002Rl-5u for ged-emacs-devel@m.gmane-mx.org; Sat, 04 Jun 2022 10:32:36 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:51516) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxUoY-0001fY-Q3 for emacs-devel@gnu.org; Sat, 04 Jun 2022 10:31:42 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:51824) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nxUoX-00053U-VW; Sat, 04 Jun 2022 10:31:41 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=MIME-Version:Subject:References:In-Reply-To:To:From: Date; bh=M3FD2q5oZaf2nABg85SXeYACISp6S2k5b8Fdug42QSU=; b=Hv2Wr7Fm4ySUz3UFqbY9 Eh/utrjJRkrD+tTzA+RcRE+QS+hLoudG4GBJNRIkFC5iGu4Jbzf1Wqg9IHGeW4NNBQ/zB1eBG+uTP LdIwW7nlwrnZC58BGy8WtNgjmiMTjjB4D40KJYdbXeA2dCjlj4iYk8THjd6l8xR6HHbQnagbXZc6y r0EA9wG8IBI4J5TogS6u0tfSX0jW+j54INYNcd42tlJlCnsgF54mWmd0SCC2rBXho7t2rqXpgnUtR 6q+ERz5c5kOmJkymvMpcuqXQmTLgSbhutbt+R+dHi8VL/kJ/gF3xNHb423j2CdyoZVW7bMryhs9xq MPdmcxR6UtuBqg==; Original-Received: from auth2-smtp.messagingengine.com ([66.111.4.228]:40145) by fencepost.gnu.org with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1nxUoX-0005g6-OT; Sat, 04 Jun 2022 10:31:41 -0400 Original-Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailauth.nyi.internal (Postfix) with ESMTP id 687B127C005B; Sat, 4 Jun 2022 10:31:41 -0400 (EDT) Original-Received: from mailfrontend1 ([10.202.2.162]) by compute2.internal (MEProxy); Sat, 04 Jun 2022 10:31:41 -0400 X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrleekgdejkecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpeffhffvvefkjghfufggtgfgsehtqhertddttdejnecuhfhrohhmpefvrghsshhi lhhoucfjohhrnhcuoehtshguhhesghhnuhdrohhrgheqnecuggftrfgrthhtvghrnhepgf eiudefgeeludeghfdulefhkeffkefgledvgeevudegkefgfffhkefgudekhfetnecuffho mhgrihhnpehrvggrughmvgdrohhrghdpnhhonhdqshhtrghnuggrrhgurdhorhhgnecuve hluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhrnhdo mhgvshhmthhprghuthhhphgvrhhsohhnrghlihhthidqkeeijeefkeejkeegqdeifeehvd elkedqthhsughhpeepghhnuhdrohhrghesfhgrshhtmhgrihhlrdhfmh X-ME-Proxy: Feedback-ID: ib2b94485:Fastmail Original-Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sat, 4 Jun 2022 10:31:40 -0400 (EDT) In-Reply-To: X-Correlation-ID: 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:290657 Archived-At: Don't panic, Alan! =F0=9F=98=81 The idea would be to only activate the font-lock rules of org (or markdown-= mode, if available) while somehow protecting the package headers and help-m= ode footer section (i.e., the buttons). 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--com= pile >>> 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 whic= h is > NOT part of core Emacs, and mustn't become so.=C2=A0 What you're proposin= g 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