lua-users home
lua-l archive

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


It was thus said that the Great Dirk Laurie once stated:
> 2016-10-05 6:53 GMT+02:00 Sean Conner <sean@conman.org>:
> > It was thus said that the Great Daurnimator once stated:
> >> >
> >> I don't suppose you have some nicer documentation? e.g. with formatting and
> >> internal hyperlinks?
> >> I found your plaintext README quite hard to get through.
> 
> I found it quite easy to read.

  Thanks.

> >   Nope.  I tend towards old school style documentation.
> >
> >   -spc (And for reasons, I positively *despise* most markup languages ... )
> 
> Even "readable as-is" ones like Markdown, Textile and reStructuredText?

  Yes.  I couldn't tell you the difference between Markdown, Textile and
reStructuredText.  Yes, they are based on typical typographical conventions
found in older ASCII documents, but extend that in a vain attempt to cover
HTML in a non-HTML, highly symbolic and context sensitive way (Quick!  What
does ``` in Markdown down?  What about Textile?  What, semantically, does it
even mean?  See what I'm getting at?)

  The other issue I have with Markdown (et al) is that in the majority of
such documents, each paragraph is one exceedingly long line, making it
difficult for *me* to read.  more (or less) (and here, I'm talking about the
Unix commands more and less) will wrap the lines at the edge of the TTY
window, making for some very badly formatted text.  

  And the text editor I use [3], doesn't wrap long lines.  I find such
documents hard to read and thus, don't really bother much with them (I have
to format them myself?  No thank you).  I try to keep my text documents (and
source but I don't go overboard) with less than 80 character lines.

  I won't even get into the politics of Markdown [1].

  If I want a markup langauge, I know where to find HTML.

> Actually, your README (and your typical post on this list, for that matter)
> looks like a language of that class. The only immediately visible ambiguity
> is that your centered headings can be mistaken by an unintelligent reader
> for lines of code.

  I do have some stylistic choices when writing text, but I don't pretend
it's a markup language.

  -spc (And I use mutt, a text console email program ... )

[1]	John Gruber, inventor of Markdown, deliberately left it lacking,
	then claimed complete ownership over it when people were trying to
	create a reference-covers-everything implementation.  His
	underspecified spec is fine *for him* but heaven help you if you
	want to extend it.

	It reminded me of RSS, as Dave Winer, inventor of RSS, refused to
	clarify certain situations [2] and bitched mightily when others
	tried to clean up the spec.

[2]	Basically, if HTML could be embedded as is, HTML-entity coded, or
	stripped out entirely.

[3]	joe