[rfc-i] Embedding stuff (code, etc.) in RFCs

Paul Kyzivat pkyzivat at alum.mit.edu
Fri Jul 12 09:26:26 PDT 2013


The approach you propose depends on explicit syntax in a draft, so that 
file content can be identified and extracted. It is complicated by the 
need to disambiguate it visually, and to deal with formatting issues.

IMO it would be better to extract content from the *markup* document. 
The xml2rfc format already has *some* support for this: the <artwork> 
element has a type attribute. This is already used, by some, to identify 
some content like abnf. And some tools already use this - e.g. to drive 
syntax checkers.

Of course that mechanism is somewhat rudimentary, and could stand some 
beefing up. But I think it would be a better starting point than trying 
to parse file content out of the draft .txt file.

What would help would be a mechanism to apply type-specific formatting 
to artwork content when formatting as an RFC. That would allow the "raw" 
content of the artwork to be in "native" format.

I've been interested in this for a slightly different but related goal: 
I want to extend the abnf syntax to allow reference/importing of ABNF 
from other sources. And I want that to work when the ABNF being 
referenced is embedded in an RFC/draft.


On 7/12/13 11:21 AM, Riccardo Bernardini wrote:
> Dear all,
> recently there was a discussion about the problem of publishing source
> code associated with RFCs. I gave some thought to the problem and
> developed a general and very light-weight format for embedding code in
> an RFC that allows for automatic extraction while maintaining the
> readability of the code. I collected my reflections and my proposal
> (with the respective software embedded, of course!:) in an I-D
>         http://www.ietf.org/internet-drafts/draft-bernardini-embedded-code-00.txt
> The I-D is still a bit rough  and the code is still to be fully
> tested, but before investing some more time I would like to know if
> this can be of some interest.  Of course, suggestions and observations
> (polite ones :-) :-) are welcome.
> Best regards,
> Riccardo
> _______________________________________________
> rfc-interest mailing list
> rfc-interest at rfc-editor.org
> https://www.rfc-editor.org/mailman/listinfo/rfc-interest

More information about the rfc-interest mailing list