Re: [Rfc-markdown] rfc-editor/to-be-removed

[Carsten Bormann <[e-mail]>]

On 28. Oct 2021, at 03:04, Michael Richardson <[e-mail]> wrote:
> 
> 
> Carsten Bormann <[e-mail]> wrote:
>>> Is there something I should use?
> 
>> RFCXMLv3 has an attribute called removeInRFC.
>> Apart from <note, this can be used in <section.
> 
>> So you can write
> 
>>> {:removeinrfc}
>>> ## Tempus fugit
>>> 
>>> Goes away.
> 
> How long does it extend?
> Until the next ##? Or?
> Would ### things be included?


I think you are asking two questions here, only the first of which really is about markdown.

(1) How does kramdown-rfc create XML sections out of the markdown headings?

This does indeed work exactly as one would think, so if an h3 heading (###) follows a sequence of zero or more paragraphs that follow an h2 heading (##), an h3 section is created that is nested into the h2 section encompassing it.  The h2 section extends to the next h2 (##) or h1 (#) heading or the end of the “middle” or “back” division.

(2) How does the removeInRfc attribute of RFCXMLv3 operate on nested sections?

There is no answer to this in the RFCXMLv3 documentation [1], and it is a bit weird because the default value of removeInRfc is false, so an h3 section without further markup that is nested in an h2 section marked removeInRfc=“true” will seemingly contradict the outer h2 section.  The rendering is no help in interpreting this, as it just includes a paragraph at the start of any section marked removeInRfc=“true”.  AFAIU, the actual removal will happen manually during RPC processing, so we are speculating about how they will interpret the seemingly contradictory instruction.

But it is hard to remove a section without removing its subsections, and logically the h2 section to be removed does include its h3 sections, so I would expect the RPC to remove the entire h2 section, including its contradicting subsections.

Grüße, Carsten

[1]: https://xml2rfc.tools.ietf.org/xml2rfc-doc.html#section-2.50.3