emacs-devel
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [ELPA] Display package description as Org-exported text or HTML?


From: Jean Louis
Subject: Re: [ELPA] Display package description as Org-exported text or HTML?
Date: Mon, 31 May 2021 13:29:21 +0300
User-agent: Mutt/2.0.7+183 (3d24855) (2021-05-28)

* 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 via email to

[Prev in Thread] Current Thread [Next in Thread]