[rfc-i] How to indent artwork with surrounding block

julian.reschke at gmx.de (Julian Reschke) Wed, 17 February 2016 16:28 UTC

From: julian.reschke at gmx.de (Julian Reschke)
Date: Wed, 17 Feb 2016 17:28:55 +0100
Subject: [rfc-i] How to indent artwork with surrounding block
In-Reply-To: <56C49C7F.7050900@alum.mit.edu>
References: <76FD8A33-4FE3-4333-8E7C-BE2E274C1D24@cisco.com> <970A412E-B227-420F-8EE7-611A228D93E1@vpnc.org> <56C3EFA0.9010208@gmail.com> <56C41744.9030405@gmx.de> <56C41D5E.7050403@tzi.org> <56C49C7F.7050900@alum.mit.edu>
Message-ID: <56C49FC7.6030408@gmx.de>

On 2016-02-17 17:14, Paul Kyzivat wrote:
> ...
> ISTM that <CODE BEGINS> and <CODE ENDS> is generally annoying to read
> and only needed if there aren't formatting clues to help distinguish
> code from text. So the formatting of <sourcecode> should largely
> eliminate the need.
> ...

...unless we have cases where we want to embed <sourcecode> that does 
*not* qualify as "code component" in the IPR sense.

I recommend to have a look at the set of published RFCs. The <CODE ...> 
brackets are only used rarely (and, as far as I can tell, even in some 
of these cases might not have been required). Thus they seem to play the 
role of a seldom-used escape, thus IMHO we should do the same in 
vocabulary and rendering code: do nothing by default, and allow an 
attribute to override it.

> If the author has a need to include some form of <CODE BEGINS> and <CODE
> ENDS> into the <sourcecode> then it ought to be formatted as a comment
> in the syntax of the code so that the extracted code will be valid.

Won't work in all formats; example: JSON.

Best regards, Julian