mmarkdown / mmark

Mmark: a powerful markdown processor in Go geared towards the IETF
https://mmark.miek.nl
Other
480 stars 45 forks source link

Support more `rfc` attributes #198

Closed str4d closed 11 months ago

str4d commented 11 months ago

What went wrong?

One of the editorial changes that the RFC Editor made to an ID's XML generated from mmark was to add the following attributes to <rfc>:

symRefs="true"
sortRefs="true"
tocInclude="true"

symRefs and tocInclude both default to true, so it doesn't matter whether they are set or absent in this case. But sortRefs defaults to false, so it isn't possible to replicate the RFC Editor's XML changes in the Markdown source.

It would be useful for mmark to support configuring the full non-deprecated set of rfc attributes, but at a minimum sortRefs would be useful given that the RFC Editor does (with a sample size of 1) use it.

What version of mmark are you using?

2.2.36

miekg commented 11 months ago

sortRefs looks reasonable, can you make a (smaller) PR with just that change?

str4d commented 11 months ago

I've extracted the sortRefs commit from #199 as its own PR: #201.

miekg commented 11 months ago

if an authoritative source tells me this other attrs are important, I'll happily include them, until then: closing

qasimwarraich commented 10 months ago

First of all, I am sorry to bump a closed issue (even though it's only a week old)

I am definitely not an authoritative source 😓, but if you would consider including a title configuration option for symRefs I would happily make a PR :).

miekg commented 10 months ago

Thanks, but it's not so much about what we can do, but what the rfc-editors wants.

These PIs (process instructions) are def. something they want to get rid off

On Fri, 17 Nov 2023, 16:43 qasimwarraich, @.***> wrote:

First of all, I am sorry to bump a closed issue (even though it's only a week old)

I am definitely not an authoritative source 😓, but if you would consider including a title configuration option for symRefs I would happily make a PR :).

— Reply to this email directly, view it on GitHub https://github.com/mmarkdown/mmark/issues/198#issuecomment-1816658055, or unsubscribe https://github.com/notifications/unsubscribe-auth/AACWIW443V4TEMUQBMUTXHLYE6AYXAVCNFSM6AAAAAA6QS2LUGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTQMJWGY2TQMBVGU . You are receiving this because you modified the open/close state.Message ID: @.***>