Skip to content
This repository has been archived by the owner on Dec 23, 2019. It is now read-only.

Support automatic citations to RFCs / I-Ds like MMark #9

Closed
ronaldtse opened this issue Sep 27, 2017 · 6 comments
Closed

Support automatic citations to RFCs / I-Ds like MMark #9

ronaldtse opened this issue Sep 27, 2017 · 6 comments

Comments

@ronaldtse
Copy link
Contributor

ronaldtse commented Sep 27, 2017

We should support automatic citations like MMark.

https://github.com/miekg/mmark/wiki/Syntax#citations

  • [@RFC1234] => points to RFC 1234
  • [@I-D.blah#06] => points to draft-blah-06
  • [@I-D.hello] => points to draft-hello-xx where xx is the latest version.
@ronaldtse
Copy link
Contributor Author

@paolobrasolin should this be done in asciidoctor-bibliography? Or an "addon" to it?

@ronaldtse
Copy link
Contributor Author

And output in this format https://tools.ietf.org/html/rfc7749#section-2.30

@paolobrasolin
Copy link
Member

We can definitely support the syntax of asciidoctor-bibliography; matchers and data structures are already in place, so it should be relatively straightforward to output in RFC.

@ronaldtse
Copy link
Contributor Author

Looks like we should support this syntax and output:

cite:[@RFC1234]

  • citation reference => <xref target="RFC1234"/>
  • add in <references>: <?rfc include="https://xml2rfc.tools.ietf.org/public/rfc/bibxml/reference.RFC.1234.xml"?>

cite:[@I-D.xxx-yyy-zzz]

  • citation reference => <xref target="I-D.xxx-yyy-zzz"/>
  • add in <references>: <?rfc include="https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.xxx-yyy-zzz.xml"?>

cite:[@I-D.xxx-yyy-zzz#11]

  • citation reference => <xref target="I-D.xxx-yyy-zzz-11"/>
  • add in <references>: <?rfc include="https://xml2rfc.tools.ietf.org/public/rfc/bibxml3/reference.I-D.xxx-yyy-zzz-11.xml"?>

Then xml2rfc will automatically fetch these references.

@paolobrasolin maybe we can also provide a shorter syntax for cite:[], such as MMark's [@RFC1234] or Kramdown's {{@RFC1234}}?

@ronaldtse
Copy link
Contributor Author

Actually @paolobrasolin we can make this syntax work?

  • <<?RFC1234>> (informative)
  • <<!RFC1234>> (normative)
  • <<-RFC1234>> (suppress in references)

@opoudjis
Copy link
Contributor

opoudjis commented Nov 23, 2017

Implemented with cite:norm[] and cite:info[]

I'm closing because I'm assuming the more succinct syntax is not feasible.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants