unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Jean Louis <bugs@gnu.support>
To: Daniel Mendler <mail@daniel-mendler.de>
Cc: "emacs-devel@gnu.org" <emacs-devel@gnu.org>
Subject: Re: [ELPA] Display package description as Org-exported text or HTML?
Date: Mon, 31 May 2021 13:29:21 +0300	[thread overview]
Message-ID: <YLS6gaOjp5Jg4HM4@protected.localdomain> (raw)
In-Reply-To: <27aaa2b3-96a1-d1b1-07dc-d8f0a9ca7900@daniel-mendler.de>

* Daniel Mendler <mail@daniel-mendler.de> [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/



  reply	other threads:[~2021-05-31 10:29 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-31 10:09 [ELPA] Display package description as Org-exported text or HTML? Daniel Mendler
2021-05-31 10:29 ` Jean Louis [this message]
2021-05-31 10:53   ` Daniel Mendler
2021-05-31 11:04     ` Jean Louis
2021-05-31 12:13     ` Michael Heerdegen
2021-05-31 12:29       ` Jean Louis
2021-05-31 13:19         ` Stefan Monnier
2021-05-31 14:08           ` Michael Heerdegen
2021-05-31 14:59             ` Stefan Monnier
2021-05-31 15:14               ` Michael Heerdegen
2021-05-31 15:36                 ` Stefan Monnier
2021-05-31 17:23                   ` [ELPA PATCH] Add badge generator to elpa-admin.el Daniel Mendler
2021-05-31 18:02                     ` Daniel Mendler
2021-06-04 16:00                       ` Michael Heerdegen
2021-05-31 13:12 ` [ELPA] Display package description as Org-exported text or HTML? Stefan Monnier

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=YLS6gaOjp5Jg4HM4@protected.localdomain \
    --to=bugs@gnu.support \
    --cc=emacs-devel@gnu.org \
    --cc=mail@daniel-mendler.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).