search

ietf-tools / bibxml-service

Django-based Web service implementing IETF BibXML APIs
https://bib.ietf.org
BSD 3-Clause "New" or "Revised" License
17 stars 19 forks source link

Can <annotation be used by authors or is it claimed by bibxml? #360

Open cabo opened 1 year ago

cabo commented 1 year ago

Description

Annotations could be content of the referencing document or they could be used by bibxml. Are they?

Code of Conduct

TonyLHansen commented 1 year ago

can you give an example?

cabo commented 1 year ago

As a document author, maybe I want to add an annotation to a referencec such as that the referenced document was superseded by another document, possibly by another SDO (say, was OASIS and is now ISO). But if there are annotations from the bibxml, these might clash. So I was wondering whether bibxml ever emits annotations or I'm free to hand that tool to the document authors.

TonyLHansen commented 1 year ago

AFAIK, none of the bibxml references have ever had annotations within them.

cabo commented 8 months ago

The current code in kramdown-rfc simply appends annotations to any incoming bibxml. The conflict I was envisioning doesn't exist, because one can have zero or more annotations in a reference. Still, it would be nice to document invariants such as "the bibxml service does not output annotation elements" if they exist.