From ucfagls at gmail.com  Thu Jun  4 19:35:31 2015
From: ucfagls at gmail.com (Gavin Simpson)
Date: Thu, 4 Jun 2015 11:35:31 -0600
Subject: [Rd] NEWS.md support on CRAN
In-Reply-To: <557087EC.5020100@gmail.com>
References: <4819669E-8260-47B0-96BF-DC2B29E6BE21@me.com>
	<555FD2FE.8050600@gmail.com>
	<21856.13500.513608.759602@fangorn.hornik.net>
	<B98D36A9-901A-4413-88C0-22D7E923612E@me.com>
	<581D2C19-ED47-4D1D-8FC7-C4B4F368E637@gmail.com>
	<21868.18877.410651.592015@fangorn.hornik.net>
	<21869.50739.349239.728644@max.nulle.part>
	<556DCADA.7060109@gmail.com>
	<21870.40730.965705.219861@fangorn.hornik.net>
	<CAOKDuOhy=P8hYktkXJ2dtRexihc5vzsC44TUqn80j+Nz7oAoxg@mail.gmail.com>
	<CAAHES9y-ztcaK8uqbkR8vuYq4P3kmmJh3TS=Pp+81vSU2_22Xw@mail.gmail.com>
	<55708643.8020703@stats.ox.ac.uk> <557087EC.5020100@gmail.com>
Message-ID: <CAAHES9zb76pGAG-1SrUS=Myqix7TPrMr0rMoMn-3r06qCj7=Ng@mail.gmail.com>

On 4 June 2015 at 11:16, Duncan Murdoch <murdoch.duncan at gmail.com> wrote:

> On 04/06/2015 1:09 PM, Prof Brian Ripley wrote:
>
>> On 04/06/2015 17:00, Gavin Simpson wrote:
>> ...
>> > 1. Markdown was designed to be as readable as possible in plain text
>> format
>> > (i.e. the sources, not the rendered file). There's nothing stopping you
>> > reading and parsing a NEWS.md in your head trivially.
>> ...
>>
>> That claim is made frequently, but it is not my experience.  That you
>> can filter out markup in your head does not mean others can -- it is
>> very distracting to some visually impaired people (including when using
>> a text-to-speech reader).
>>
>>  I agree.  I think we shouldn't be displaying raw Markdown, except
> possibly as a temporary measure, while we get the parsing and rendering in
> place.


Just to be clear; I wasn't suggesting that R should be displaying raw
Markdown. What I was getting at was even if your local setup stops you
seeing a rendered version of the file (for whatever reason) reading the
Markdown source is a lot easier than reading a similar file marked up using
Rd. Yet for those with less restrictive setups Markdown maintains many of
the benefits that the Rd markup allows.

I just failed miserably, and insensitively(!), to convey that point.

G


>
>
Duncan Murdoch
>



-- 
Gavin Simpson, PhD

	[[alternative HTML version deleted]]



[Rd] NEWS.md support on CRAN
Gavin Simpson