Re: [xml2rfc] XInclude should be used instead of PI include

There's a guide about using XInclude at
https://authors.ietf.org/en/references-in-rfcxml

Also, you need to have `xmlns:xi="http://www.w3.org/2001/XInclude"` in
the `rfc` element.
Example:
```
<rfc
  xmlns:xi="http://www.w3.org/2001/XInclude"
  category="info"
  ...
  version="3">
```

  --Kesara

On Tue, 27 Jun 2023 at 09:37, Robert Sparks <rjsparks@nostrum.com> wrote:
>
> On 6/26/23 4:01 PM, Carsten Bormann wrote:
>
> > On 26. Jun 2023, at 22:55, Randy Bush <randy@psg.com> wrote:
> >> i have a local rsunk repo and am doing
> >>
> >>     <references title="Normative References">
> >>       <?rfc include="reference.RFC.2119.xml"?>
>
> That would look like <xi:include
> href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml"/>
>
> All of Carsten's observation about this hardcoding an external reference
> and that the URLs have been changing a _lot_ recently are correct, as
> you can see from the before-preptool source for one of the most recently
> published RFCs:
>
> rjsparks@undex feat-rfc % curl --no-progress-meter
> https://www.rfc-editor.org/prerelease/rfc9425.notprepped.xml | grep 8174
>      <xref target="RFC8174"/> when, and only when, they appear in all
> capitals,
> <xi:include
> href="https://xml2rfc.ietf.org/public/rfc/bibxml/reference.RFC.8174.xml"/>
>
> (The RPC is shifting to using bib.ietf.org to which xml2rfc.ietf.org
> redirects).
>
> For Internet-Drafts, you'll need to use an href that looks like
>
> https://bib.ietf.org/public/rfc/bibxml-ids/reference.I-D.ietf-rtgwg-segment-routing-ti-lfa.xml
>
> That is, using xi:include comes with the extra burden of knowing the
> names of the bibxml datasets.
>
> There are conversations ongoing about how to avoid these
> author-unfriendly aspects.
>
> RjS
>
> >>       <?rfc include="reference.RFC.2622.xml"?>
> >>       <?rfc include="reference.RFC.2725.xml"?>
> >>
> >> what should i be doing if i want to go to xml heaven?
> > As the warning says, the canonical way is now to use XInclude.
> > XInclude makes you hard-code the full URL to those reference items.
> > This is great if you always want to use the information stored remotely (and if the URLs are stable, which they haven’t been for the last half decade).
> >
> > I don’t know much about XInclude as kramdown-rfc does all the reference handling for you (and can share a cache with xml2rfc, which you can prefill), so I don’t have to remember the details.
> >
> > I’m sure others will speak up…
> >
> > Grüße, Carsten
> >
> > _______________________________________________
> > xml2rfc mailing list
> > xml2rfc@ietf.org
> > https://www.ietf.org/mailman/listinfo/xml2rfc
>
> _______________________________________________
> xml2rfc mailing list
> xml2rfc@ietf.org
> https://www.ietf.org/mailman/listinfo/xml2rfc

-- 
Kesara Rathnayake
Senior Software Development Engineer - IETF Administration LLC
kesara@staff.ietf.org