Re: NEWS file format

Jean Louis <[email protected]> Fri, 12 Jan 2018 13:51:37 +0300
Newsgroups gmane.lisp.clisp.devel
Message-ID <[email protected]>
On Fri, Jan 12, 2018 at 08:53:35AM +0100, Bruno Haible wrote:
> Hi Sam,
> 
> > markdown is widely supported.
> 
> Markdown is something else: It's a *shorthand for writing* a text file
> with structure, when it is known that the file will *always be postprocessed*
> (through the Markdown processor) before being presented to user.
> Which is not the case here: The NEWS file is being included literally
> in the distribution.
> 
> It would be OK with me to have a NEWS.md (or NEWS.xml) in the repository, with
> a NEWS.html alongside it that is always automatically regenerated upon any
> modification of NEWS.{md,xml}.
> But that's probably overkill for 200 lines of text?
> 
> > At any rate, please do not introduce any new idiosyncratic markup there
> > as you did recently.
> 
> I did not introduce a markup. I introduced a kind of visual representation.
> Any other visual representation that satisfies the principle that section
> titles catch the eyes more easily than subsubsection titles would be OK.

Why not simple keep it in text format. If it is
necessary to be as HTML, it can be easily
converted.

One can also keep it in Org format, which is
similar to outline in Emacs, and gives visually
clear sectioning

* Section 1

Text

** Section 2

Text

And it can be converted on command line by using
Emacs to any other format. 

-- 
Jean Louis

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
_______________________________________________
clisp-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/clisp-devel