[rfc-i] For v3: better naming of the anchor elements for automatically generated references

Julian Reschke julian.reschke at gmx.de
Fri Dec 27 11:13:20 PST 2013


On 2013-12-24 04:49, Paul Hoffman wrote:
> Currently, the only way to use automatically generated references is to use the anchor name that comes with them, such as "[RFC5596]". Some authors want more descriptive anchor names, such as "[IKEv2]". They can only do that if they create their own references, which can be error-prone. Maybe we can allow overriding the "anchor" attribute of an included <reference> element.

+1

Another constraint is that people seem to really like including 
automatically generated references (a bad practice IMHO), so the 
overriding mechanism needs to support out-of-band overrides.

So:

1) Add a label attribute to <reference> that allows picking a more 
descriptive name, and

2) Add a reference-alias element that allows aliasing the reference, 
such as in

   <reference-alias target="RFC2616" label="HTTP"/>

It would probably be good to allow <reference-alias> anywhere below 
<references>, so that it can either be used as a list of synonyms (maybe 
even included), or used as a preamble of the actual reference.

Best regards, Julian


More information about the rfc-interest mailing list