rfc-format / draft-iab-xml2rfc-v3-bis

-bis document for the RFC format xml2rfc v3 draft
6 stars 10 forks source link

Why are 'note's so limited? #33

Open miekg opened 6 years ago

miekg commented 6 years ago

Note's are only allowed in the front section, but they can hardly contain anything, 7991 bills them as unnumbered section, but then limits what can be contained in them. Why?

It makes more sense to say a note is a unnumbered section, with the restriction it can only exist in a front section.

reschke commented 6 years ago

What elements are you missing?

miekg commented 6 years ago

I wanted to render this markdown snippet as a note: https://raw.githubusercontent.com/miekg/learninggo/mmark2/preface.md

Meaning I wanted to have:

and possibly more. I can see (some) value limiting this for RFC creation, but looks arbitrary.

reschke commented 6 years ago

FWIW, you can have \, the same way as in regular sections.

miekg commented 6 years ago

<Note> also doesn't have an anchor attribute; meaning it is one of the few things left you can't reference.

reschke commented 6 years ago

I believe it should allow anchor.

levkowetz commented 6 years ago

On 2018-09-19 07:46, Julian Reschke wrote:

I believe it should allow anchor.

Aren't notes expected to be removed before publication? If so, having links to them would make for more work during publication.

reschke commented 6 years ago

a) Some notes stay in the document. b) That said, I agree that linking from within the document might be a bad idea (maybe cause for a warning). c) However, it might be good if the note could be assigned a meaningful anchor name for linking from other documents.

miekg commented 5 years ago

did we have a discussion on this one on the list?

stpeter commented 3 years ago

We discussed this in the XML change management team and concluded that the note element is fine as-is because it is intended for use only after the abstract in special circumstances (e.g., IESG notes and ISE notes). The original poster likely should have used the aside element instead of the note element. It's possible that improved documentation is needed.