Giter Site home page Giter Site logo

Comments (6)

ronaldtse avatar ronaldtse commented on June 26, 2024

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

from asciidoctor-rfc.

ronaldtse avatar ronaldtse commented on June 26, 2024

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

from asciidoctor-rfc.

paolobrasolin avatar paolobrasolin commented on June 26, 2024

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.

from asciidoctor-rfc.

ronaldtse avatar ronaldtse commented on June 26, 2024

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}}?

from asciidoctor-rfc.

ronaldtse avatar ronaldtse commented on June 26, 2024

Actually @paolobrasolin we can make this syntax work?

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

from asciidoctor-rfc.

opoudjis avatar opoudjis commented on June 26, 2024

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

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

from asciidoctor-rfc.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.