[rfc-i] xref extensions

After reading this, I guess I am going to post my latest wish list item.

I would like to propose the following addition to the v3 vocabulary.

1) define a new element <anchorSet> to be a child of reference.  The element
is for grouping and has no attributes.
2) define a new element <anchorPoint> to be a child of <anchorSet>.
Multiple elements can occur here.
    It has the following attributes:
	anchorName - the name of the anchor begin exposed in the referenced
document
	partNumber - the partNumber of the anchor being exposed in the
referenced document
	text - what is generated for the "default" format of xref for the
anchor being exposed
    An xml2rfc processor that generates reference.xml output would generate
these as part generated reference item.

3) augment xref by adding a new attribute that allows one to say <xref
target="RFC99" anchorName="foo"/>.  

The above would allow one to use the anchor points defined in one document
in a second document.  This would be especially useful when one is writing
sets of documents that are going to make references back and forth between
them.  Doing so would require that xml2rfc be run twice, the first time to
generate the reference.xml document and then the actual document to be
created (txt, xml, html, ebook).  

Jim

> -----Original Message-----
> From: rfc-interest [mailto:rfc-interest-bounces at rfc-editor.org] On Behalf
Of
> Julian Reschke
> Sent: Thursday, November 06, 2014 2:31 PM
> To: rfc-interest at rfc-editor.org
> Subject: [rfc-i] xref extensions
> 
> Hi,
> 
> below some feedback on
> <http://tools.ietf.org/html/draft-hoffman-xml2rfc-12#section-2.66>.
> 
> First of all, it's great that we have the extensions for referencing
specific
> sections in the target document, using "section", "sectionFormat", and
> "relative".
> 
> Nit: I wish we'd be less verbose here, for instance using "sec", "secfmt",
and
> "rel".
> 
> "sectionFormat" currently supports:
> 
> > 2.66.5. 'sectionFormat' attribute
> >
> >
> >    The format that the section reference will be displayed in.  The
> >    acceptable values are:
> >
> >    o  "of" (default)
> >
> >    o  "comma"
> >
> >    o  "parens"
> >
> >    For example:
> >
> >      See <xref target="RFC6949" section="2.3" sectionFormat="of"/>
> >      for more information.
> >      See <xref target="RFC6949" section="2.4" sectionFormat="comma"/>
> >      for more information.
> >      See <xref target="RFC6949" section="2.5" sectionFormat="parens"/>
> >      for more information.
> >
> >    would generate
> >
> >         See Section 2.3 of [RFC6949] for more information.
> >         See [RFC6949], Section 2.4 for more information.
> >         See [RFC6949] (Section 2.5) for more information.
> 
> 
> In my extension vocabulary
> (<http://greenbytes.de/tech/webdav/rfc2629xslt/rfc2629xslt.html#ext-
> rfc2629.xref>)
> I have some more formats:
> 
> "number": used for references such as "see Sections 1, 2 and 3 of [REF]
> 
> (where "1", "2" and "3" would get hyperlinked to the target sections)
> 
> "sec": used for references such as "See Section 1 of HTTP [RFC7230]"
> 
> (where "Section 1" would be hyperlinked)
> 
> Yes, this adds some complexity, but it is well-defined, is easy to
implement,
> and allows using linking when it wouldn't be possible otherwise.
> 
> I can provide full spec text if desired.
> 
> Best regards, Julian
> _______________________________________________
> rfc-interest mailing list
> rfc-interest at rfc-editor.org
> https://www.rfc-editor.org/mailman/listinfo/rfc-interest