search

jcgregorio / rst2rfc

Utility to convert ReST markup to XML for xml2rfc
3 stars 3 forks source link

RFE: Allow grouping of references into "normative" and "informative" sections #3

Open GoogleCodeExporter opened 9 years ago

GoogleCodeExporter commented 9 years ago 
Currently (single version to date: Dec 10, 2009), all citations/references 
go into a single, untitled <references> section in the output XML. It'd be 
good if citations/references could be somehow "categorized" as either 
"normative" or "informative", generating the appropriate sections:
   <references title="Normative References">...</references>
   <references title="Informative References">...</references>

Maybe this could be done by introducing new "interpreted text roles" 
instead of using the existing :citation: one, such as:
   :norm-ref:`RFC2616`
   :info-ref:`W3C.REC-html401-19991224`
It'd have the side-effect advantage that no corresponding "dummy" citation 
be present at the end of the document (the ".. [RFC2616]" thingy), with the 
drawback that other, "standards", docutils tools (such as rfc2html.py) 
could no longer be used.

Original issue reported on code.google.com by t.broyer on 30 Dec 2009 at 2:29

GoogleCodeExporter commented 9 years ago 
Another possibility could be introducing a new directive, used this way:

.. references:: Normative References

   .. [RFC2616] Hypertext Transfer Protocol (HTTP)

.. references:: Informative References

   .. [W3C.REC-html401-19991224] HyperText Markup Language (HTML)

Original comment by t.broyer on 31 Dec 2009 at 1:21

GoogleCodeExporter commented 9 years ago

Original comment by joe.gregorio@gmail.com on 12 Jan 2010 at 1:53