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 13:29:21 +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: 7bit Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="10813"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Mutt/2.0.7+183 (3d24855) (2021-05-28) Cc: "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 12:33:38 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 1lnfEo-0002dy-9d for ged-emacs-devel@m.gmane-mx.org; Mon, 31 May 2021 12:33:38 +0200 Original-Received: from localhost ([::1]:34008 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lnfEn-00006d-Cm for ged-emacs-devel@m.gmane-mx.org; Mon, 31 May 2021 06:33:37 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:46564) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnfDv-0007qO-C7 for emacs-devel@gnu.org; Mon, 31 May 2021 06:32:43 -0400 Original-Received: from stw1.rcdrun.com ([217.170.207.13]:51263) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lnfDt-0006JK-IF for emacs-devel@gnu.org; Mon, 31 May 2021 06:32: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 00000000000AE2D6.0000000060B4BB46.00003C01; Mon, 31 May 2021 03:32:37 -0700 Mail-Followup-To: Daniel Mendler , "emacs-devel@gnu.org" Content-Disposition: inline In-Reply-To: <27aaa2b3-96a1-d1b1-07dc-d8f0a9ca7900@daniel-mendler.de> 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:270161 Archived-At: * 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. You could export it into text and provide in the package as readable text such as README.txt together with README.org There are many lightweight markup languages like Org, Markdown, Asciidoc, txt2tags, reStructuredText, and they are all there usually with the purpose to get transformed in some other type of a document. Expecting that remote party will be able to read, understand the lightweight markup language, or even that remote servers should start supporting such is not reliable for expectation that communication should arrive to user. Don't expect README.txt to be readable only by Emacs or special software, it is better to provide README.txt as plain text. People read files with less, cat and other editors, there are file managers that will open files with any editor, not necesarily Emacs, some file managers will send text to browser. Thus, it is best to provide README.txt in plain text. -- 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/